Facebook Ads

Ações

GET
/v1/facebook/ads/actions

Retorna dados de ações do Facebook Ads com métricas detalhadas de conversão e engajamento.

Este endpoint fornece insights em nível de ação, incluindo eventos de conversão, ações de engajamento e seus valores associados, segmentados por tipo de ação.

Dimensões disponíveis:

  • ID da campanha, ID do conjunto de anúncios (adset), ID do anúncio
  • Tipo de ação, contagem, valor da ação
  • Data de início

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)

Nota: Os tipos de ação incluem conversões, engajamentos, cliques e outros eventos específicos do Facebook.

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/actions?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"
{  "data": [    {      "campaign_id": "string",      "ad_id": "string",      "adset_id": "string",      "action_type": "string",      "count": 0,      "action_value": 0,      "date_start": "2019-08-24",      "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  }}