V4MOS.AI API
GuidesAPI Referenceapp.v4mos.ai
Facebook Ads

Demographics

GET
/v1/facebook/ads/demographic

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
  • Lead metrics: lead, fb_pixel_lead, leadgen_grouped, onsite_conversion_lead_grouped
  • 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:

  • organizationId (required)
  • userId (optional)
  • integrationName (optional)
  • dateStart (optional)
  • dateEnd (optional)

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

userId?string

User identifier (optional)

integrationName?string

Integration name identifier (optional)

dateStart?string

Start date for filtering (optional, ISO 8601 format)

Formatdate
dateEnd?string

End date for filtering (optional, ISO 8601 format)

Formatdate
page?integer

Page number for pagination (optional)

Default1
limit?integer

Number of items per page (optional, max 5000)

Rangevalue <= 5000
Default500
orderBy?string

Field to order by (optional)

orderDirection?string

Order direction (optional)

Value in"ASC""DESC"

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/facebook/ads/demographic?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"
{  "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,      "lead": 0,      "fb_pixel_lead": 0,      "leadgen_grouped": 0,      "onsite_conversion_lead_grouped": 0,      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}

Actions GET

Previous Page

Platforms GET

Next Page