Developer docsPartner API

Get lead source

Returns one source row and its campaign breakdown for the selected range.

Bearer API key · Scope: analytics.read

Endpoint

GET/api/v1/lead-sources/{source_id}

Path parameters1 parameter

source_idrequired
string
URL-encoded `key` returned by `/api/v1/lead-sources`.

Query parameters3 parameters

from
string:date-time
Inclusive ISO datetime lower bound. Defaults to 30 days before `to` or now.
to
string:date-time
Exclusive ISO datetime upper bound. Defaults to the current server time.
timezone
string
IANA timezone used for analytics bounds and spend proration.

Responses

200Lead source detail.

application/json

LeadSourceDetailResponse

400Request payload, query, or required header is invalid.

application/json

401Missing, malformed, revoked, deleted, or unknown API key.

Headers

WWW-AuthenticateDocumented response header

application/json

403API key lacks the required scope or the workspace is not active.

application/json

404Resource not found in the key-bound workspace.

application/json

429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

X-RateLimit-LimitMaximum requests allowed in the current window.
X-RateLimit-RemainingRequests remaining in the current window.
X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
Retry-AfterSeconds until the caller should retry.

application/json

500Internal authentication or server error.

application/json

Try it out