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

Anúncios

GET
/v1/facebook/ads/ad

Retorna métricas detalhadas de desempenho em nível de anúncio do Facebook, com indicadores avançados de qualidade e ranking.

Este endpoint fornece insights granulares em nível de anúncio, incluindo rankings de qualidade, métricas de engajamento e indicadores de desempenho detalhados.

Dimensões disponíveis:

  • ID do anúncio, ID do conjunto de anúncios (adset), nome do anúncio
  • Métricas: impressões, alcance, frequência, cliques, CTR, cliques em links inline, investimento, CPC, CPM, ROAS de compras no site
  • Rankings de qualidade: quality_ranking, engagement_rate_ranking, conversion_rate_ranking
  • Dados de ações (JSON)
  • 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/ad?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"
{  "data": [    {      "ad_id": "string",      "adset_id": "string",      "ad_name": "string",      "impressions": 0,      "reach": 0,      "frequency": 0,      "clicks": 0,      "ctr": 0,      "inline_link_clicks": 0,      "inline_link_click_ctr": 0,      "spend": 0,      "cpc": 0,      "cpm": 0,      "quality_ranking": "string",      "engagement_rate_ranking": "string",      "conversion_rate_ranking": "string",      "website_purchase_roas": 0,      "date_start": "2019-08-24",      "date_stop": "2019-08-24",      "actions": "string",      "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  }}

Anúncios GET

Página anterior

Ações GET

Próxima página