Facebook Ads

Configuração de campanhas

GET
/v1/facebook/ads/campaigns-config

Retorna dados de configuração de campanhas do Facebook Ads, incluindo ajustes da campanha, objetivo, configurações de orçamento e metadados em nível de campanha.

Este endpoint fornece informações detalhadas de configuração das campanhas.

Dimensões disponíveis:

  • ID da configuração, nome, objetivo
  • Status: status efetivo, data de criação, tipo de compra
  • Orçamento: orçamento diário, orçamento total (lifetime)

Limitações:

  • Máximo de 5000 registros por página
  • Suporta filtro por data via dateStart (formato ISO 8601)
  • Suporta ordenação via orderBy e orderDirection (ASC/DESC)

Filtros:

  • organizationId (obrigatório)
  • userId (opcional)
  • integrationName (opcional)
  • dateStart (opcional)

Nota: Este endpoint retorna dados de configuração e pode não suportar filtro por dateEnd.

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
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/campaigns-config?organizationId=organization_123&dateStart=2024-01-01"
{  "data": [    {      "id": "string",      "name": "string",      "objective": "string",      "effective_status": "string",      "created_time": "2019-08-24T14:15:22Z",      "buying_type": "string",      "daily_budget": 0,      "lifetime_budget": 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  }}