Facebook Ads
Plataformas
GET
Retorna dados de plataformas do Facebook Ads com métricas de desempenho segmentadas por plataforma de publicação e posição do anúncio.
Este endpoint fornece insights em nível de plataforma, incluindo o desempenho no Facebook, Instagram, Messenger e Audience Network.
Dimensões disponíveis:
- ID do conjunto de anúncios (adset), ID do anúncio, plataforma de publicação, posição na plataforma, objetivo
- Métricas: impressões, alcance, cliques, investimento,
full_view_reach - Período (
date_start,date_stop)
Limitações:
- Máximo de 5000 registros por página
- Suporta filtro por data via
dateStartedateEnd(formato ISO 8601) - Suporta ordenação via
orderByeorderDirection(ASC/DESC)
Filtros:
organizationId(obrigatório)userId(opcional)integrationName(opcional)dateStart(opcional)dateEnd(opcional)
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringIdentificador da organização (obrigatório)
userId?stringIdentificador do usuário (opcional)
integrationName?stringIdentificador do nome da integração (opcional)
dateStart?stringData inicial para filtragem (opcional, formato ISO 8601)
Formato
datedateEnd?stringData final para filtragem (opcional, formato ISO 8601)
Formato
datepage?integerNúmero da página para paginação (opcional)
Padrão
1limit?integerNúmero de itens por página (opcional, máx. 5000)
Intervalo
value <= 5000Padrão
500orderBy?stringCampo de ordenação (opcional)
orderDirection?stringDireção da ordenação (opcional)
Valor em
"ASC""DESC"Resposta de sucesso
application/json- response
data?array<>meta?curl -X GET "https://example.com/v1/facebook/ads/platform?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, "full_view_reach": 0, "date_start": "2019-08-24", "date_stop": "2019-08-24", "publisher_platform": "string", "platform_position": "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 }}