Batch job status and results (paginated)

GET/v1/batch/{job_id}

Finished jobs and their results are kept for 30 days.

Example request

Shell

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_idrequired

path · string

–

cursor

string

–

limit

integer

Items per page

default 20

Response

data.created_atrequired

datetime

–

data.credits_billedrequired

integer

–

data.donerequired

integer

–

data.failedrequired

integer

–

data.finished_atrequired

datetime

–

data.job_idrequired

string

–

data.kindrequired

string

–

data.paramsrequired

object

–

data.started_atrequired

datetime

–

data.statusrequired

string

One of queued, running, done, failed

data.totalrequired

integer

–

data.webhook_urlrequired

string

–

itemsrequired

object[]

–

ads

object[]

–

advertiser

object

–

countries

string[]

ISO 3166-1 alpha-2

creatives

object[]

–

derived

object

–

eu_data

object

–

extra

map of object

Platform-specific fields

first_seen_by_us

datetime

–

first_shown

datetime

–

formats

string[]

–

id

string

Stable ID: <platform>:<platform_ad_id>

impressions_range

object

–

last_seen_by_us

datetime

–

last_shown

datetime

–

library_url

string

–

placements

string[]

–

platform

string

One of meta, google, tiktok, linkedin, pinterest, x

platform_ad_id

string

–

political

boolean

Political or issue ad. Meta only; null where the platform doesn't label it

raw_ref

string

Pointer to the archived raw upstream record

spend_range

object

–

status

string

One of active, inactive, unknown

advertisers

object[]

–

active_ads

integer

As reported by the platform if available, else counted by us

avatar_url

string

–

country

string

–

domain

string

–

extra

map of object

–

first_seen_by_us

datetime

–

id

string

–

last_seen_by_us

datetime

–

name

string

–

platform

string

–

platform_advertiser_id

string

–

profile_url

string

–

total_ads_known

integer

Ads in our history

verified

boolean

–

error

string

–

input

string

–

status

string

One of queued, running, done, failed

next_cursorrequired

string

–