Facebook Ads

Criativos de anúncios

GET
/v1/facebook/ads/creatives

Retorna dados de criativos do Facebook Ads agrupados por anúncio, com informações abrangentes sobre o criativo e sua associação ao anúncio.

Este endpoint fornece insights em nível de criativo com as associações aos anúncios, incluindo recursos de filtragem por atributos do criativo.

Dimensões disponíveis:

  • ID do criativo, nome, tipo de objeto, status, tipo de otimização, ID do anúncio, data de criação do anúncio
  • Mídia: URL do permalink do Instagram, URL da miniatura, título, ID do vídeo, URL da imagem
  • Configuração: tags de URL, formatos de anúncio (JSON), link do site, tipos de call to action (JSON), texto do título
  • Segmentação: faixa etária (mín./máx.), plataformas de publicação (JSON)
  • Posições: configurações de Facebook, Instagram, Messenger e Audience Network
  • Adicionais: ID da página, ID do usuário do Instagram, especificações de story, reasons to shop, shops bundle

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)
  • creativeId (opcional, aceita um único ID ou uma lista separada por vírgulas)
  • creativeName (opcional)
  • objectType (opcional)
  • optimizationType (opcional)
  • videoId (opcional)
  • adId (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"
creativeId?|array<string>

Filtra por identificador do criativo. Aceita um único ID (creativeId=123), uma lista separada por vírgulas (creativeId=123,456) ou parâmetros repetidos (creativeId=123&creativeId=456). Múltiplos IDs são comparados com uma cláusula SQL IN.

creativeName?string

Filtra por nome do criativo

objectType?string

Filtra por tipo de objeto

optimizationType?string

Filtra por tipo de otimização

videoId?string

Filtra por identificador do vídeo

adId?string

Filtra por identificador do anúncio

Corpo da resposta

Resposta de sucesso

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/facebook/ads/creatives?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31&creativeId=123%2C456"
{  "data": [    {      "creative_id": "string",      "creative_name": "string",      "object_type": "string",      "status": "string",      "ad_id": "string",      "ad_created_time": "2019-08-24T14:15:22Z",      "instagram_permalink_url": "string",      "thumbnail_url": "string",      "title": "string",      "video_id": "string",      "image_url": "string",      "url_tags": "string",      "optimization_type": "string",      "ad_formats": {},      "website_link": "string",      "call_to_action_types": {},      "title_text": "string",      "age_max": 0,      "age_min": 0,      "publisher_platforms": {},      "facebook_positions": {},      "instagram_positions": {},      "messenger_positions": {},      "audience_network_positions": {},      "reasons_to_shop": true,      "shops_bundle": true,      "page_id": "string",      "instagram_user_id": "string",      "story_spec_link": "string",      "story_spec_link_name": "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  }}