Ads · Ad Campaigns

Get campaign tree

Fetches a campaign tree.

GEThttps://api.pozy.ai/v1/ads/tree

Facebook and Instagram, Google Workspace, TikTok, LinkedIn, Pinterest and X and 1 moregetAdTree

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
`page`	integer	Default `1`At least 1
`limit`	integer	Default `20`1 to 100
`source`	string	One of `pozy`, `all`Default `all`
`platform`	string	One of `facebook`, `instagram`, `tiktok`, `linkedin`, `pinterest`, `google`, `twitter`, `openai`, `reddit`
`status`	string
`adAccountId`	string
`pageId`	string
`accountId`	string
`profileId`	string
`campaignId`	string
`updatedSince`	string (date-time)
`search`	string	Up to 500 characters
`fromDate`	string (date)
`toDate`	string (date)
`hasDelivery`	boolean
`minSpend`	number	At least 0
`sort`	string	One of `newest`, `oldest`, `spend_desc`, `spend_asc`Default `newest`
`timeIncrement`	integer	One of `1`
`dailyLevel`	string	One of `campaign`, `adset`, `ad`Default `campaign`
`compare`	string	One of `previous`

Example

curl -X GET "https://api.pozy.ai/v1/ads/tree?limit=20" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/ads/tree?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/tree",
    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 object
31 child fields
- platformCampaignIdstring
- platformstring
  One of facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai, reddit.
- campaignNamestring
- createdTimestring (date-time)
  Can be null.
- statusobject
- reviewStatusstring
- platformCampaignStatusstring
  Can be null.
- campaignIssuesInfoarray of object
  Can be null.
- adCountinteger
- adSetCountinteger
- budgetobject
  Can be null.
  2 child fields
  amountnumber
  typestring
  One of daily, lifetime.
- campaignBudgetobject
  Can be null.
  2 child fields
  amountnumber
  typestring
  One of daily, lifetime.
- budgetLevelstring
  One of campaign, adset. Can be null.
- isBudgetScheduleEnabledboolean
  Default false.
- currencystring
  Can be null.
- metricsobject
  38 child fields
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
- previousMetricsobject
  38 child fields
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
- platformAdAccountIdstring
- platformAdAccountNamestring
  Can be null.
- accountIdstring
- profileIdstring
- isSmartPlusboolean
- advertisingChannelTypestring
  Can be null.
- platformObjectivestring
  Can be null.
- optimizationGoalstring or array of string
- bidStrategystring
- bidAmountnumber
  Can be null.
- roasAverageFloornumber
  Can be null.
- promotedObjectobject
  Can be null.
  3 child fields
  custom_event_typestring
  pixel_idstring
  page_idstring
- adSetsarray of object
  24 child fields
  platformAdSetIdstring
  adSetNamestring
  statusobject
  createdTimestring (date-time)
  Can be null.
  adCountinteger
  isSmartPlusboolean
  budgetobject
  Can be null.
  5 child fields
  amountnumber
  typestring
  One of daily, lifetime.
  dailynumber
  lifetimenumber
  pacingstring
  adSetBudgetobject
  Can be null.
  5 child fields
  amountnumber
  typestring
  One of daily, lifetime.
  dailynumber
  lifetimenumber
  pacingstring
  metricsobject
  38 child fields
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
  previousMetricsobject
  38 child fields
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
  optimizationGoalstring
  Can be null.
  bidStrategystring
  bidAmountnumber
  Can be null.
  roasAverageFloornumber
  Can be null.
  costTypestring
  Can be null.
  servingStatusesarray of string
  learningStatusstring
  One of LEARNING, SUCCESS, FAIL. Can be null.
  promotedObjectobject
  Can be null.
  3 child fields
  custom_event_typestring
  pixel_idstring
  page_idstring
  destinationTypestring
  Can be null.
  attributionSpecarray of object
  Can be null.
  regionalRegulatedCategoriesarray of string
  Can be null.
  regionalRegulationIdentitiesmap of string
  Can be null.
  adsarray of object
  36 child fields
  _idstring
  namestring
  platformstring
  One of facebook, instagram, tiktok, linkedin, pinterest, google, twitter, openai, reddit.
  profileIdstring
  statusobject
  configuredStatusstring
  Can be null.
  reviewStatusobject
  adTypestring
  One of boost, standalone.
  creativeTypestring
  One of carousel, video, document, image. Can be null.
  goalstring
  One of engagement, traffic, awareness, video_views, lead_generation, lead_conversion, conversions, app_promotion, catalog_sales, page_likes, page_visits, job_applicants.
  isExternalboolean
  syncedboolean
  budgetobject
  Can be null.
  5 child fields
  amountnumber
  typestring
  One of daily, lifetime.
  dailynumber
  lifetimenumber
  pacingstring
  metricsobject
  One of:
  Ad Metrics (38 fields)
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
  platformAdIdstring
  platformAdAccountIdstring
  platformCampaignIdstring
  platformAdSetIdstring
  campaignNamestring
  adSetNamestring
  platformObjectivestring
  Can be null.
  optimizationGoalstring
  Can be null.
  costTypestring
  Can be null.
  servingStatusesarray of string
  platformAdAccountNamestring
  Can be null.
  platformCreatedAtstring (date-time)
  Can be null.
  bidStrategystring
  bidAmountnumber
  Can be null.
  roasAverageFloornumber
  Can be null.
  promotedObjectobject
  Can be null.
  5 child fields
  custom_event_typestring
  pixel_idstring
  page_idstring
  application_idstring
  product_set_idstring
  creativeobject
  Can be null.
  43 child fields
  assetGroupobject
  8 child fields
  namestring
  1 to 128 characters.
  finalUrlstring (URL)required
  Matches ^https?://.
  headlinesarray of stringrequired
  At least 3 items. Up to 15 items. Each item: 1 to 30 characters.
  longHeadlinestringrequired
  1 to 90 characters.
  descriptionsarray of stringrequired
  At least 2 items. Up to 5 items. Each item: 1 to 90 characters.
  businessNamestringrequired
  1 to 25 characters.
  imagesobjectrequired
  3 child fields
  landscapearray of string (URL)required
  At least 1 item. Up to 20 items. Each item: matches ^https?://.
  squarearray of string (URL)required
  At least 1 item. Up to 20 items. Each item: matches ^https?://.
  logoarray of string (URL)required
  At least 1 item. Up to 5 items. Each item: matches ^https?://.
  youtubeVideoIdstring
  Matches ^[A-Za-z0-9_-]{11}$.
  assetGroupResourceNamestring
  headlinesarray of string or object
  Up to 15 items.
  One of:
  string
  Google Rsa Headline (2 fields)
  textstringrequired
  1 to 30 characters.
  pinnedFieldstring
  One of HEADLINE_1, HEADLINE_2, HEADLINE_3.
  descriptionsarray of string or object
  Up to 4 items.
  One of:
  string
  Google Rsa Description (2 fields)
  textstringrequired
  1 to 90 characters.
  pinnedFieldstring
  One of DESCRIPTION_1, DESCRIPTION_2.
  headlinestring
  bodiesarray of string
  descriptionstring
  callToActionstring
  leadGenFormIdstring
  imageHashstring
  urlTagsstring
  Can be null.
  finalUrlsarray of string (URL)
  At least 1 item.
  thumbnailUrlstring
  Can be null.
  imageUrlstring
  assetResourceNamestring
  assetsobject
  2 child fields
  marketingImagesarray of object
  1 child field
  resourceNamestring
  squareMarketingImagesarray of object
  1 child field
  resourceNamestring
  videoIdstring
  Can be null.
  videoUrlstring
  Can be null.
  creativeIdstring
  Can be null.
  creativeFeaturesmap of string
  catalogobject
  3 child fields
  productSetIdstring
  formatstring
  One of single_image, carousel_images_multi_items, carousel_images_single_item, carousel_slideshows.
  formatTransformationSpecarray of object
  2 child fields
  formatstring
  data_sourcearray of string
  objectTypestring
  objectStoryIdstring
  Can be null.
  effectiveObjectStoryIdstring
  Can be null.
  pageIdstring
  Can be null.
  effectiveInstagramMediaIdstring
  Can be null.
  instagramUserIdstring
  Can be null.
  instagramPermalinkUrlstring
  Can be null.
  mediaUrlsarray of string
  carouselCardsarray of object
  7 child fields
  imageUrlstring
  imageHashstring
  headlinestring
  descriptionstring
  linkUrlstring
  callToActionstring
  videoIdstring
  isServingboolean
  Can be null.
  adFormatstring
  Can be null.
  servingHoldReasonsarray of string
  bodystring
  googleHeadlinestring
  googleDescriptionstring
  youtubeVideoIdsarray of string
  linkUrlstring
  whatsappPhoneNumberstring
  instagramVideoFallbackobject
  4 child fields
  kindstringrequired
  One of instagram_video_reuploaded, instagram_video_rehosted_copy.
  linkedToOriginalPostbooleanrequired
  videoIdstringrequired
  platformErrorobjectrequired
  4 child fields
  codeinteger
  subcodeinteger
  messagestringrequired
  fbtraceIdstring
  pinterestImageUrlstring
  pinterestTitlestring
  pinterestDescriptionstring
  targetingobject
  scheduleobject
  Can be null.
  2 child fields
  startDatestring (date-time)
  endDatestring (date-time)
  rejectionReasonstring
  createdAtstring (date-time)
  updatedAtstring (date-time)
  dailyarray of object
  39 child fields
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
  datestring (date)
- dailyarray of object
  39 child fields
  spendnumber
  impressionsinteger
  reachinteger
  clicksinteger
  ctrnumber
  cpcnumber
  cpmnumber
  engagementinteger
  conversionsnumber
  allConversionsnumber
  costPerConversionnumber
  actionsmap of integer
  actionValuesmap of number
  purchaseValuenumber
  roasnumber
  costPerActionmap of number
  outboundClicksinteger
  outboundClicksCtrnumber
  inlineLinkClicksinteger
  inlineLinkClickCtrnumber
  uniqueClicksinteger
  uniqueCtrnumber
  videoPlayActionsinteger
  video30SecWatchedActionsinteger
  videoThruplayWatchedActionsinteger
  videoP25WatchedActionsinteger
  videoP50WatchedActionsinteger
  videoP75WatchedActionsinteger
  videoP95WatchedActionsinteger
  videoP100WatchedActionsinteger
  video2SecWatchedActionsinteger
  video6SecWatchedActionsinteger
  video6SecFocusedViewsinteger
  videoAvgTimeWatchedActionsnumber
  costPerThruplaynumber
  funnelobject
  13 child fields
  landingPageViewsinteger
  contentViewsinteger
  searchesinteger
  wishlistAddsinteger
  cartAddsinteger
  checkoutsInitiatedinteger
  paymentInfoAddsinteger
  purchasesinteger
  leadsinteger
  registrationsCompletedinteger
  appInstallsinteger
  messagingConversationsStartedinteger
  messagingFirstRepliesinteger
  engagementBreakdownobject
  9 child fields
  postEngagementinteger
  pageEngagementinteger
  reactionsinteger
  commentsinteger
  sharesinteger
  savesinteger
  pageLikesinteger
  videoViewsinteger
  linkClicksinteger
  lastSyncedAtstring (date-time)
  datestring (date)
paginationobject
- pageinteger
- limitinteger
- totalinteger
- pagesinteger
syncedAtstring (date-time)
Can be null.
previousRangeobject
- fromDatestring (date)
- toDatestring (date)
backfillPendingboolean

200 response

{
  "campaigns": [
    {
      "platformCampaignId": "68f1e8569b986839e821d8ba",
      "platform": "facebook",
      "campaignName": "Acme",
      "createdTime": "2026-10-02T09:00:00.000Z",
      "status": {},
      "reviewStatus": "in_review",
      "platformCampaignStatus": "instagram",
      "campaignIssuesInfo": [
        {}
      ],
      "adCount": 42,
      "adSetCount": 42,
      "budget": {
        "amount": 12.5,
        "type": "daily"
      },
      "campaignBudget": {
        "amount": 12.5,
        "type": "daily"
      },
      "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"
      },
      "previousMetrics": {
        "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"
      },
      "adSets": [
        {
          "platformAdSetId": "6749c05fd96acf71ce38cbc7",
          "adSetName": "Acme",
          "status": {},
          "createdTime": "2026-10-02T09:00:00.000Z",
          "adCount": 42,
          "isSmartPlus": true,
          "budget": {
            "amount": 12.5,
            "type": "daily",
            "daily": 12.5,
            "lifetime": 12.5,
            "pacing": "string"
          },
          "adSetBudget": {
            "amount": 12.5,
            "type": "daily",
            "daily": 12.5,
            "lifetime": 12.5,
            "pacing": "string"
          },
          "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"
          },
          "previousMetrics": {
            "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"
          },
          "optimizationGoal": "string",
          "bidStrategy": "LOWEST_COST_WITHOUT_CAP",
          "bidAmount": 12.5,
          "roasAverageFloor": 12.5,
          "costType": "string",
          "servingStatuses": [
            "active"
          ],
          "learningStatus": "LEARNING",
          "promotedObject": {
            "custom_event_type": "string",
            "pixel_id": "61ea7ce64c184295e2220bf7",
            "page_id": "60cae484a825fef31dae565c"
          },
          "destinationType": "string",
          "attributionSpec": [
            {
              "eventType": "CLICK_THROUGH",
              "windowDays": 1
            }
          ],
          "regionalRegulatedCategories": [
            "string"
          ],
          "regionalRegulationIdentities": {
            "key": "string"
          },
          "ads": [
            {
              "_id": "635d87e261ae344ef27fd1df",
              "name": "Acme",
              "platform": "facebook",
              "profileId": "6a0b6573846efc28aaa9a3ff",
              "status": {},
              "configuredStatus": "active",
              "reviewStatus": {},
              "adType": "boost",
              "creativeType": "carousel",
              "goal": "engagement",
              "isExternal": true,
              "synced": true,
              "budget": {
                "amount": 12.5,
                "type": "daily",
                "daily": 12.5,
                "lifetime": 12.5,
                "pacing": "string"
              },
              "metrics": {},
              "platformAdId": "64149c3e561c1c5ac800f87a",
              "platformAdAccountId": "673c621a82c88059710de3fd",
              "platformCampaignId": "68f1e8569b986839e821d8ba",
              "platformAdSetId": "6749c05fd96acf71ce38cbc7",
              "campaignName": "Acme",
              "adSetName": "Acme",
              "platformObjective": "instagram",
              "optimizationGoal": "string",
              "costType": "string",
              "servingStatuses": [
                "active"
              ],
              "platformAdAccountName": "instagram",
              "platformCreatedAt": "2026-10-02T09:00:00.000Z",
              "bidStrategy": "LOWEST_COST_WITHOUT_CAP",
              "bidAmount": 12.5,
              "roasAverageFloor": 12.5,
              "promotedObject": {
                "custom_event_type": "string",
                "pixel_id": "61ea7ce64c184295e2220bf7",
                "page_id": "60cae484a825fef31dae565c",
                "application_id": "6a49643c60aa0c1725a69ce7",
                "product_set_id": "6a424f3abe2064286a5e3a4b"
              },
              "creative": {
                "assetGroup": {},
                "assetGroupResourceName": "Acme",
                "headlines": [],
                "descriptions": [],
                "headline": "Launch day",
                "bodies": [],
                "description": "A short description",
                "callToAction": "string",
                "leadGenFormId": "66d3effa66e41a45e5deee45",
                "imageHash": "string",
                "urlTags": "https://pozy.ai/media/example-1.jpg",
                "finalUrls": [],
                "thumbnailUrl": "https://pozy.ai/media/example-1.jpg",
                "imageUrl": "https://pozy.ai/media/example-1.jpg",
                "assetResourceName": "Acme",
                "assets": {},
                "videoId": "65fd297a0da74ab358dd11e9",
                "videoUrl": "https://pozy.ai/media/example-1.jpg",
                "creativeId": "68c59681516c848d73eebe49",
                "creativeFeatures": {},
                "catalog": {},
                "objectType": "string",
                "objectStoryId": "64c3ae81d059271ce0c220b5",
                "effectiveObjectStoryId": "67c37b0ffda71894bd7eea2c",
                "pageId": "675e1e95e076854531b4d051",
                "effectiveInstagramMediaId": "612675e5315fb71660656b0b",
                "instagramUserId": "665a608ca13236ff56e25aae",
                "instagramPermalinkUrl": "https://pozy.ai/media/example-1.jpg",
                "mediaUrls": [],
                "carouselCards": [],
                "isServing": true,
                "adFormat": "string",
                "servingHoldReasons": [],
                "body": "string",
                "googleHeadline": "string",
                "googleDescription": "string",
                "youtubeVideoIds": [],
                "linkUrl": "https://pozy.ai/media/example-1.jpg",
                "whatsappPhoneNumber": "+14155550123",
                "instagramVideoFallback": {},
                "pinterestImageUrl": "https://pozy.ai/media/example-1.jpg",
                "pinterestTitle": "string",
                "pinterestDescription": "string"
              },
              "targeting": {},
              "schedule": {
                "startDate": "2026-10-02T09:00:00.000Z",
                "endDate": "2026-10-02T09:00:00.000Z"
              },
              "rejectionReason": "string",
              "createdAt": "2026-10-02T09:00:00.000Z",
              "updatedAt": "2026-10-02T09:00:00.000Z"
            }
          ],
          "daily": [
            {
              "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": {},
              "actionValues": {},
              "purchaseValue": 12.5,
              "roas": 12.5,
              "costPerAction": {},
              "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": {},
              "engagementBreakdown": {},
              "lastSyncedAt": "2026-10-02T09:00:00.000Z",
              "date": "2026-10-02T09:00:00.000Z"
            }
          ]
        }
      ],
      "daily": [
        {
          "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",
          "date": "2026-10-02T09:00:00.000Z"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 42,
    "pages": 1
  },
  "syncedAt": "2026-10-02T09:00:00.000Z",
  "previousRange": {
    "fromDate": "2026-10-01",
    "toDate": "2026-10-01"
  },
  "backfillPending": true
}

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.

More in Ad Campaigns

GETList ads GETList Google Ads recommendations POSTApply Google Ads recommendations POSTDismiss Google Ads recommendations GETList portfolio bid strategies POSTCreate portfolio bid strategy PATCHUpdate portfolio bid strategy GETList shared budgets POSTCreate a shared budget GETList Search keywords POSTAdd Search ad-group keywords PATCHPause or enable a Search keyword DELRemove a Search keyword GETList campaigns POSTCreate a standalone campaign PUTPause or resume a campaign GETRead a campaign's ad schedule (dayparting)PUTReplace a campaign's ad schedule (dayparting)GETRead a campaign's current bidding GETGet live campaign details PUTUpdate a campaign DELDelete a campaign GETList campaign-level negative keywords PUTReplace campaign-level negative keywords POSTPause or resume many campaigns POSTDuplicate a campaign GETRead a Google campaign's device, location, excluded location, and language targeting PUTEdit a Google campaign's device, location, excluded location, or language targeting GETList ad sets POSTCreate a standalone ad group POSTDuplicate an ad set POSTDuplicate an ad GETGet live ad-set details PUTUpdate an ad set DELDelete an ad set GETRead a Reddit ad group's targeting and schedule PUTPause or resume a single ad set GETGet daily account metrics GETGet ad details PUTUpdate ad DELCancel an ad PUTPause or resume a single ad GETList campaign assets POSTAttach campaign assets PUTUpdate campaign assets DELRemove campaign assets GETList ad-group assets POSTAttach ad-group assets PUTUpdate ad-group assets DELRemove ad-group assets GETRead the platform's review verdict for an ad GETReview status of each creative in a TikTok Smart+ ad GETList ads that need attention POSTDismiss an ads alert GETReview status of every TikTok Smart+ ad of an advertiser GETList campaign negative lists PUTReplace campaign negative lists POSTBoost post as ad GETList Performance Max asset groups POSTCreate a Performance Max asset group GETGet a Performance Max asset group PATCHUpdate a Performance Max asset group DELRemove a Performance Max asset group POSTLink or unlink asset group assets PUTReplace an asset group's listing-group tree POSTCreate standalone ad GETGet campaign conversion goals PATCHUpdate campaign conversion goals