Ads · Ad Insights

Submit async insights report

Submits an async insights report. Works with Meta Ads.

POSThttps://api.pozy.ai/v1/ads/insights/reports
Facebook and InstagramcreateAdInsightsReport

Guides: Meta Ads, Ads reporting

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • accountIdstringrequired
  • objectIdstringrequired
  • levelstring

    One of ad, adset, campaign, account.

  • fieldsstring
  • breakdownsstring
  • actionBreakdownsstring
  • actionAttributionWindowsarray of string
  • actionReportTimestring
  • useUnifiedAttributionSettingboolean
  • filteringarray of object
    • fieldstringrequired
    • operatorstringrequired
    • valueany
  • datePresetstring
  • fromDatestring (date)
  • toDatestring (date)
  • timeIncrementinteger or string

Example

curl -X POST "https://api.pozy.ai/v1/ads/insights/reports" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "objectId": "6cd1b53a19a7e157d2d46b68"
}'

Response

202 on success

  • reportRunIdstring
  • statusstring
202 response
{
  "reportRunId": "6e2f00f0f0d4fc8864437ccf",
  "status": "active"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Ad Insights