ads
List ads
Returns a paginated list of ads with cached metrics. Use `source=all` to include externally-synced ads from platform ad managers.
AuthorizationBearer <token>
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
page?integer
Page number (1-based)
Default
1Range
1 <= valuelimit?integer
Default
50Range
1 <= value <= 500source?string
zernio = Zernio-created only, all = include external ads
Default
"zernio"Value in
"zernio" | "all"status?string
Value in
"active" | "paused" | "pending_review" | "rejected" | "completed" | "cancelled" | "error"platform?string
Value in
"facebook" | "instagram" | "tiktok" | "linkedin" | "pinterest" | "google" | "twitter"accountId?string
Social account ID
profileId?string
Profile ID
campaignId?string
Platform campaign ID (filter ads within a campaign)
Response Body
application/json
application/json
curl -X GET "https://zernio.com/api/v1/ads"{
"ads": [
{
"_id": "string",
"name": "string",
"platform": "facebook",
"status": "active",
"adType": "boost",
"goal": "engagement",
"isExternal": true,
"budget": {
"amount": 0,
"type": "daily"
},
"metrics": {
"spend": 0,
"impressions": 0,
"reach": 0,
"clicks": 0,
"ctr": 0,
"cpc": 0,
"cpm": 0,
"engagement": 0,
"lastSyncedAt": "2019-08-24T14:15:22Z"
},
"platformAdId": "string",
"platformAdAccountId": "string",
"platformCampaignId": "string",
"platformAdSetId": "string",
"campaignName": "string",
"adSetName": "string",
"creative": {},
"targeting": {},
"schedule": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"rejectionReason": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"page": 0,
"limit": 0,
"total": 0,
"pages": 0
}
}{
"error": "Unauthorized"
}Empty