Demographics

Retrieve Facebook Ads demographics data with detailed performance metrics segmented by age and gender.

This endpoint provides demographic insights including engagement and conversion metrics broken down by demographic attributes.

Dimensions Available:

Adset ID, ad ID, age, gender, objective

Metrics: impressions, reach, clicks, spend, conversions, conversions value, all conversions, all conversions value

Engagement metrics: post_engagement, page_engagement, video_view, post_reaction

Conversion metrics: omni_add_to_cart, omni_initiated_checkout, onsite_web_app_view_content, landing_page_view, view_content, purchase, add_to_cart, add_payment_info, initiate_checkout, link_click, search

Date range (date_start, date_stop)

Limitations:

Maximum 5000 records per page

Supports date filtering via dateStart and dateEnd (ISO 8601 format)

Supports sorting via orderBy and orderDirection (ASC/DESC)

Filters:

workspaceId (required)

organizationId (optional)

userId (optional)

integrationName (optional)

dateStart (optional)

dateEnd (optional)

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

curl --location --request GET 'https://api.data.v4.marketing/v1/facebook/ads/demographic?workspaceId=workspace_123&organizationId&userId&integrationName&dateStart=2024-01-01&dateEnd=2024-12-31&page&limit&orderBy&orderDirection' \ --header 'x-client-id: <api-key>' \ --header 'x-client-secret: <api-key>'

{ "data": [ { "adset_id": "string", "ad_id": "string", "clicks": 0, "reach": 0, "impressions": 0, "objective": "string", "spend": 0, "date_start": "2019-08-24", "date_stop": "2019-08-24", "age": "string", "gender": "string", "post_engagement": 0, "page_engagement": 0, "video_view": 0, "post_reaction": 0, "omni_add_to_cart": 0, "omni_initiated_checkout": 0, "onsite_web_app_view_content": 0, "landing_page_view": 0, "onsite_web_app_add_to_cart": 0, "view_content": 0, "onsite_web_purchase": 0, "onsite_web_app_purchase": 0, "purchase": 0, "onsite_web_add_to_cart": 0, "fb_pixel_add_payment_info": 0, "post": 0, "onsite_web_view_content": 0, "add_to_cart": 0, "add_payment_info": 0, "search": 0, "fb_pixel_search": 0, "omni_view_content": 0, "fb_pixel_view_content": 0, "fb_pixel_add_to_cart": 0, "fb_pixel_initiate_checkout": 0, "fb_pixel_purchase": 0, "initiate_checkout": 0, "link_click": 0, "omni_purchase": 0, "omni_search": 0, "workspace_id": "string", "organization_id": "string", "user_id": "string", "document_id": "string", "integration_name": "string", "inserted_at": "2019-08-24T14:15:22.123Z" } ], "meta": { "page": 0, "limit": 0, "hasNextPage": true, "hasPreviousPage": true } }

Requisição

Respostas