V4MOS.AI API
GuiasReferência da APIapp.v4mos.ai
Facebook Ads

Criativos

GET
/v1/facebook/creatives

Retorna dados de criativos do Facebook Ads, incluindo configurações de criativos, ativos de mídia e metadados em nível de criativo.

Este endpoint fornece insights em nível de criativo, incluindo tipo de objeto, status, URLs de mídia e especificações do criativo.

Dimensões disponíveis:

  • ID do criativo, nome, tipo de objeto, status, 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, tipo de otimização, 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

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)

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/creatives?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"
{  "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": "string",      "shops_bundle": "string",      "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  }}

Regiões GET

Página anterior

Configuração de conjuntos de anúncios GET

Próxima página