ads

GET /v1/ads/history-imports/{import_id}

One history import — its progress, its evidence and the starting values it seeded.

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the ads.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/ads/history-imports/{import_id} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.view (za-159, docs/1006 §80).

Parameters

NameTypeRequiredWhat it is
import_id (path)stringYes—

Response

NameTypeRequiredWhat it is
idstringYes—
connection_idstringYes—
source_connection_idobjectYes—
revenue_sourcestring<first_party, csv, none>Yes—
window_startstringYes—
window_endstringYes—
currencystringYes—
thresholdsAdsHistoryThresholdsYesHistory-import thresholds (za-159, docs/1006 §80); the Recommended defaults when returned as recommended.
months_readintegerYes—
months_totalintegerYes—
statusstring<queued, reading, done, failed>Yes—
errorstringYesWhy a failed import stopped, e.g. sourceNotYours, notInGoodStanding, sourceNeedsReconnect.
evidenceobjectYes—
seedsAdsHistorySeed[]Yes—
created_atstringYes—
finished_atobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 429