Ads · Tracking Tags

Get aggregated event stats

Fetches aggregated event stats.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/tracking-tags/{tagId}/stats
Facebook and Instagram, TikTok, Google Workspace, X, openai and LinkedIn and 1 moregetTrackingTagStats

Guides: ChatGPT Ads, Pixels and tracking tags

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

Path parameters

NameTypeNotes
accountIdrequiredstring
tagIdrequiredstring

Query parameters

NameTypeNotes
adAccountIdstring
aggregationstringOne of event, host, url, url_by_rule, pixel_fire, device_type, device_os, browser_type, had_pii, custom_data_field, match_keys, event_source, event_detection_method, event_processing_results, event_total_counts, event_value_countDefault event
startTimeinteger
endTimeinteger

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/tracking-tags/697ae8efd24020381023ee99/stats" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • platformstring

    One of metaads, tiktokads, googleads, xads, openaiads, linkedinads, pinterestads, whopads.

  • statsobject
    • aggregationstring
    • startTimeinteger
    • endTimeinteger
    • rowsarray of object
200 response
{
  "platform": "metaads",
  "stats": {
    "aggregation": "string",
    "startTime": 1,
    "endTime": 1,
    "rows": [
      {}
    ]
  }
}

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 scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Tracking Tags