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

Regiões

GET
/v1/facebook/ads/region

Retorna dados de regiões do Facebook Ads com métricas de desempenho segmentadas por localização geográfica.

Este endpoint fornece insights baseados em localização, incluindo dados de desempenho por país e região.

Dimensões disponíveis:

  • ID do conjunto de anúncios (adset), ID do anúncio, região, país, objetivo
  • Métricas: impressões, alcance, cliques, investimento
  • Métricas de leads: lead, leadgen_grouped, onsite_conversion_lead_grouped (fb_pixel_lead não está disponível: a Meta não retorna ações fora da Meta com a segmentação por região)
  • 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/region?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",      "region": "string",      "country": "string",      "lead": 0,      "leadgen_grouped": 0,      "onsite_conversion_lead_grouped": 0,      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}

Plataformas GET

Página anterior

Criativos GET

Próxima página