Skip to main content
GET
Download a campaign analytics report

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

campaign_id
string
required

The campaign's id (name). Identifies, or filters to, a single campaign.

date_from
string
required

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

date_to
string
required

End of the window, YYYY-MM-DD.

granularity
string

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

metric
string

Which dimension to break results down by, for example country or referrer.

timezone
string

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

Response

Success.

data
object

The endpoint's payload.