Ads · Ad Campaigns
Returns campaigns, one page at a time.
https://api.pozy.ai/v1/ads/campaignsGuide: Meta Ads
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
includeEmpty | boolean | |
page | integer | Default 1At least 1 |
limit | integer | Default 201 to 100 |
source | string | One of pozy, allDefault all |
platform | string | One of facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai, reddit |
status | string | |
adAccountId | string | |
campaignId | string | |
pageId | string | |
accountId | string | |
profileId | string | |
fromDate | string (date) | |
toDate | string (date) | |
hasDelivery | boolean | |
minSpend | number | At least 0 |
live | boolean | Default false |
Example
curl -X GET "https://api.pozy.ai/v1/ads/campaigns?limit=20" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/ads/campaigns?limit=20", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/ads/campaigns",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 20,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
campaignsarray of object31 child fields
platformCampaignIdstringplatformstringOne of
facebook,instagram,tiktok,linkedin,pinterest,google,twitter,openai,reddit.campaignNamestringstatusobjectreviewStatusstringplatformCampaignStatusstringCan be null.
statusReadAtstring (date-time)Can be null.
nativeSettingsobjectconfigReadAtstring (date-time)Can be null.
campaignIssuesInfoarray of objectCan be null.
adCountintegerbudgetobjectOne of:
Ad Campaign Budget (6 fields)
amountnumberrequiredtypestringrequiredOne of
daily,lifetime.amountMicrosstringMatches
^\d+$.explicitlySharedbooleanCan be null.
resourceNamestringCan be null.
deliveryMethodstringCan be null.
campaignBudgetobjectOne of:
Ad Campaign Budget (6 fields)
amountnumberrequiredtypestringrequiredOne of
daily,lifetime.amountMicrosstringMatches
^\d+$.explicitlySharedbooleanCan be null.
resourceNamestringCan be null.
deliveryMethodstringCan be null.
budgetLevelstringOne of
campaign,adset. Can be null.isBudgetScheduleEnabledbooleanDefault
false.currencystringCan be null.
metricsobject38 child fields
spendnumberimpressionsintegerreachintegerclicksintegerctrnumbercpcnumbercpmnumberengagementintegerconversionsnumberallConversionsnumbercostPerConversionnumberactionsmap of integeractionValuesmap of numberpurchaseValuenumberroasnumbercostPerActionmap of numberoutboundClicksintegeroutboundClicksCtrnumberinlineLinkClicksintegerinlineLinkClickCtrnumberuniqueClicksintegeruniqueCtrnumbervideoPlayActionsintegervideo30SecWatchedActionsintegervideoThruplayWatchedActionsintegervideoP25WatchedActionsintegervideoP50WatchedActionsintegervideoP75WatchedActionsintegervideoP95WatchedActionsintegervideoP100WatchedActionsintegervideo2SecWatchedActionsintegervideo6SecWatchedActionsintegervideo6SecFocusedViewsintegervideoAvgTimeWatchedActionsnumbercostPerThruplaynumberfunnelobject13 child fields
landingPageViewsintegercontentViewsintegersearchesintegerwishlistAddsintegercartAddsintegercheckoutsInitiatedintegerpaymentInfoAddsintegerpurchasesintegerleadsintegerregistrationsCompletedintegerappInstallsintegermessagingConversationsStartedintegermessagingFirstRepliesinteger
engagementBreakdownobject9 child fields
postEngagementintegerpageEngagementintegerreactionsintegercommentsintegersharesintegersavesintegerpageLikesintegervideoViewsintegerlinkClicksinteger
lastSyncedAtstring (date-time)
platformAdAccountIdstringplatformAdAccountNamestringCan be null.
accountIdstringprofileIdstringisSmartPlusbooleanadvertisingChannelTypestringCan be null.
platformObjectivestringCan be null.
optimizationGoalstring or array of stringbidStrategystringbidAmountnumberCan be null.
roasAverageFloornumberCan be null.
promotedObjectobjectCan be null.
3 child fields
custom_event_typestringpixel_idstringpage_idstring
earliestAdstring (date-time)latestAdstring (date-time)
paginationobjectpageintegerlimitintegertotalintegerpagesinteger
{
"campaigns": [
{
"platformCampaignId": "68f1e8569b986839e821d8ba",
"platform": "facebook",
"campaignName": "Acme",
"status": {},
"reviewStatus": "in_review",
"platformCampaignStatus": "instagram",
"statusReadAt": "2026-10-02T09:00:00.000Z",
"nativeSettings": {},
"configReadAt": "2026-10-02T09:00:00.000Z",
"campaignIssuesInfo": [
{}
],
"adCount": 42,
"budget": {
"amount": 12.5,
"type": "daily",
"amountMicros": "string",
"explicitlyShared": true,
"resourceName": "Acme",
"deliveryMethod": "string"
},
"campaignBudget": {
"amount": 12.5,
"type": "daily",
"amountMicros": "string",
"explicitlyShared": true,
"resourceName": "Acme",
"deliveryMethod": "string"
},
"budgetLevel": "campaign",
"isBudgetScheduleEnabled": false,
"currency": "USD",
"metrics": {
"spend": 12.5,
"impressions": 1,
"reach": 1,
"clicks": 1,
"ctr": 12.5,
"cpc": 12.5,
"cpm": 12.5,
"engagement": 1,
"conversions": 12.5,
"allConversions": 12.5,
"costPerConversion": 12.5,
"actions": {
"key": 1
},
"actionValues": {
"key": 12.5
},
"purchaseValue": 12.5,
"roas": 12.5,
"costPerAction": {
"key": 12.5
},
"outboundClicks": 1,
"outboundClicksCtr": 12.5,
"inlineLinkClicks": 1,
"inlineLinkClickCtr": 12.5,
"uniqueClicks": 1,
"uniqueCtr": 12.5,
"videoPlayActions": 1,
"video30SecWatchedActions": 1,
"videoThruplayWatchedActions": 1,
"videoP25WatchedActions": 1,
"videoP50WatchedActions": 1,
"videoP75WatchedActions": 1,
"videoP95WatchedActions": 1,
"videoP100WatchedActions": 1,
"video2SecWatchedActions": 1,
"video6SecWatchedActions": 1,
"video6SecFocusedViews": 1,
"videoAvgTimeWatchedActions": 12.5,
"costPerThruplay": 12.5,
"funnel": {
"landingPageViews": 1,
"contentViews": 1,
"searches": 1,
"wishlistAdds": 1,
"cartAdds": 1,
"checkoutsInitiated": 1,
"paymentInfoAdds": 1,
"purchases": 1,
"leads": 1,
"registrationsCompleted": 1,
"appInstalls": 1,
"messagingConversationsStarted": 1,
"messagingFirstReplies": 1
},
"engagementBreakdown": {
"postEngagement": 1,
"pageEngagement": 1,
"reactions": 1,
"comments": 1,
"shares": 1,
"saves": 1,
"pageLikes": 1,
"videoViews": 1,
"linkClicks": 1
},
"lastSyncedAt": "2026-10-02T09:00:00.000Z"
},
"platformAdAccountId": "673c621a82c88059710de3fd",
"platformAdAccountName": "instagram",
"accountId": "696e0b682d0a31188e7a2ba9",
"profileId": "6a0b6573846efc28aaa9a3ff",
"isSmartPlus": true,
"advertisingChannelType": "string",
"platformObjective": "instagram",
"optimizationGoal": "string",
"bidStrategy": "LOWEST_COST_WITHOUT_CAP",
"bidAmount": 12.5,
"roasAverageFloor": 12.5,
"promotedObject": {
"custom_event_type": "string",
"pixel_id": "61ea7ce64c184295e2220bf7",
"page_id": "60cae484a825fef31dae565c"
},
"earliestAd": "2026-10-02T09:00:00.000Z",
"latestAd": "2026-10-02T09:00:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 1,
"total": 42,
"pages": 1
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.