Finished jobs and their results are kept for 30 days.
API reference · Batch jobs
Batch job status and results (paginated)
/v1/batch/{job_id}Try it with your accountOpens in your dashboard, filled in; you see the cost before it runs.
Example request
curl "https://api.adlibapi.com/v1/batch/0b7c6a8e-1f2d-4c3b-9a8e-5d6f7a8b9c0d" \
-H "X-API-Key: $ADLIB_API_KEY"Send your key in the X-API-Key header. Try it in the explorer.
Parameters
job_idrequiredcursorlimitItems per page
default 20
Response
data.created_atrequireddata.credits_billedrequireddata.donerequireddata.failedrequireddata.finished_atrequireddata.job_idrequireddata.kindrequireddata.paramsrequireddata.started_atrequireddata.statusrequiredOne of queued, running, done, failed
data.totalrequireddata.webhook_urlrequireditemsrequiredadsadvertisercountriesISO 3166-1 alpha-2
creativesderivedeu_dataextraPlatform-specific fields
first_seen_by_usfirst_shownformatsidStable ID: <platform>:<platform_ad_id>
impressions_rangelast_seen_by_uslast_shownlibrary_urlplacementsplatformOne of meta, google, tiktok, linkedin, pinterest, x, snapchat, apple, amazon, microsoft
platform_ad_idpoliticalPolitical or issue ad. Meta only; null where the platform doesn't label it
raw_refPointer to the archived raw upstream record
removed_from_library_atWhen the platform's library stopped showing this ad (taken down, deleted by the advertiser or past the library's retention). We keep it; null while the library still has it
spend_rangestatusOne of active, inactive, unknown
advertisersactive_adsAs reported by the platform if available, else counted by us
avatar_urlcountrydomainextrafirst_seen_by_usidlast_seen_by_usnameplatformplatform_advertiser_idprofile_urltotal_ads_knownAds in our history
verifiederrorinputstatusOne of queued, running, done, failed
next_cursorrequired