V4MOS.AI API
GuiasReferência da APIapp.v4mos.ai
Facebook Ads

Dados demográficos

GET
/v1/facebook/ads/demographic

Retorna dados demográficos do Facebook Ads com métricas de desempenho detalhadas, segmentadas por idade e gênero.

Este endpoint fornece insights demográficos, incluindo métricas de engajamento e conversão detalhadas por atributos demográficos.

Dimensões disponíveis:

  • ID do conjunto de anúncios (adset), ID do anúncio, idade, gênero, objetivo
  • Métricas: impressões, alcance, cliques, investimento, conversões, valor das conversões, todas as conversões, valor de todas as conversões
  • Métricas de engajamento: post_engagement, page_engagement, video_view, post_reaction
  • Métricas de conversão: 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
  • Métricas de leads: lead, fb_pixel_lead, leadgen_grouped, onsite_conversion_lead_grouped
  • Período (date_start, date_stop)

Limitações:

  • Máximo de 5000 registros por página
  • Suporta filtro por data via dateStart e dateEnd (formato ISO 8601)
  • Suporta ordenação via orderBy e orderDirection (ASC/DESC)

Filtros:

  • organizationId (obrigatório)
  • userId (opcional)
  • integrationName (opcional)
  • dateStart (opcional)
  • dateEnd (opcional)

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

userId?string

Identificador do usuário (opcional)

integrationName?string

Identificador do nome da integração (opcional)

dateStart?string

Data inicial para filtragem (opcional, formato ISO 8601)

Formatodate
dateEnd?string

Data final para filtragem (opcional, formato ISO 8601)

Formatodate
page?integer

Número da página para paginação (opcional)

Padrão1
limit?integer

Número de itens por página (opcional, máx. 5000)

Intervalovalue <= 5000
Padrão500
orderBy?string

Campo de ordenação (opcional)

orderDirection?string

Direção da ordenação (opcional)

Valor em"ASC""DESC"

Corpo da resposta

Resposta de sucesso

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  }}

Ações GET

Página anterior

Plataformas GET

Próxima página