Skip to main content
GET
Campaign clicks and visitors over time

Authorizations

X-API-Key
string
header
required

Your API key, for example dlk_live_.... Create one in the dashboard under Settings → API Keys. Keys are shown once at creation and stored only as a hash, so they cannot be recovered.

Query Parameters

name
string
required

The resource identifier.

date_from
string

Start of the window, YYYY-MM-DD. Clamped to your plan's retention floor.

date_to
string

End of the window, YYYY-MM-DD.

granularity
string

Bucket size: minute, hour, day, month or year. Inferred from the window when omitted.

browsers
string

Filter to events from these browsers, comma-separated.

devices
string

Filter to events from these device types (for example mobile, desktop, tablet), comma-separated. Requires a device/tech plan.

countries
string

Filter to events from these countries, comma-separated.

regions
string

Filter to events from these regions or states, comma-separated. Requires an advanced-geo plan.

cities
string

Filter to events from these cities, comma-separated. Requires an advanced-geo plan.

destination_urls
string

Filter to clicks whose destination URL matches any of these, comma-separated.

Filter to these shortlinks by full short URL, comma-separated.

Filter to these shortlinks by back-half (the slug after the domain), comma-separated.

domains
string

Filter to events served from these link domains or hosts, comma-separated.

operating_systems
string

Filter to events from these operating systems, comma-separated. Requires a device/tech plan.

referrers
string

Filter to events from these referrer sources or hosts, comma-separated.

referrer_urls
string

Filter to events from these full referrer URLs, comma-separated.

utm_ids
string

Filter to events tagged with these utm_id values, comma-separated. Requires a UTM plan.

utm_terms
string

Filter to events tagged with these utm_term values, comma-separated. Requires a UTM plan.

utm_mediums
string

Filter to events tagged with these utm_medium values, comma-separated. Requires a UTM plan.

utm_sources
string

Filter to events tagged with these utm_source values, comma-separated. Requires a UTM plan.

utm_contents
string

Filter to events tagged with these utm_content values, comma-separated. Requires a UTM plan.

utm_campaigns
string

Filter to events tagged with these utm_campaign values, comma-separated. Requires a UTM plan.

timezone
string

IANA timezone name used to bucket results, for example Asia/Kolkata. Defaults to UTC.

Response

Success.

data
object

The endpoint's payload.