Facebook Ads
Campanhas
GET
Retorna dados de campanhas do Facebook Ads com métricas de desempenho abrangentes.
Este endpoint fornece insights em nível de campanha, incluindo status, objetivo, orçamento, alcance, frequência e principais indicadores de desempenho.
Dimensões disponíveis:
- ID da campanha, nome, objetivo, ID da conta, status
- Métricas: impressões, alcance, frequência, cliques, CTR, cliques em links inline, investimento, CPC, CPM, ROAS de compras no site
- 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
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/campaigns?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"{ "data": [ { "campaign_id": "string", "campaign_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, "actions": "string", "objective": "string", "website_purchase_roas": 0, "account_id": "string", "date_start": "2019-08-24", "date_stop": "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 }}