Visão geral

A API TikTok Ads da V4MOS.AI entrega os registros brutos sincronizados das contas TikTok Ads conectadas à sua organização: contas de anúncio, campanhas, grupos de anúncios, anúncios e os relatórios diários de desempenho. As linhas vêm como foram sincronizadas, com os nomes de coluna do data warehouse (snake_case), prontas para levar ao seu BI. Todos os endpoints usam o prefixo /v1/tiktok-ads e seguem a mesma autenticação, paginação e formato de resposta.

Primeiros passosCopiar link da seção

URL base: https://data.v4mos.ai. Toda chamada exige suas credenciais de API e o organizationId — veja Autenticação.

1. Conecte a integração TikTok Ads em app.v4mos.ai (Contas conectadas) e aguarde a primeira sincronização.
2. Chame qualquer endpoint abaixo com o seu organizationId, por exemplo GET /v1/tiktok-ads/ad-accounts?organizationId=….
3. Toda linha traz integration_id e integration_name: a conta conectada de onde ela veio. Para ler uma conta só, passe esse valor em integrationId.

Endpoints disponíveisCopiar link da seção

• getContas de anúncio/v1/tiktok-ads/ad-accountsUma linha por conta de anunciante: empresa, moeda, fuso horário, status e saldo.
• getCampanhas/v1/tiktok-ads/campaignsUma linha por campanha: objetivo, orçamento, lances e status.
• getGrupos de anúncios/v1/tiktok-ads/ad-groupsUma linha por grupo de anúncios: meta de otimização, evento de cobrança, lance, orçamento, posicionamentos e programação.
• getAnúncios/v1/tiktok-ads/adsUma linha por anúncio: formato, tipo de criativo, página de destino, chamada para ação e status.
• getRelatório diário de campanhas/v1/tiktok-ads/campaigns-daily-reportUma linha por campanha por dia: investimento, impressões, cliques, conversões, resultados e visualizações de vídeo.
• getRelatório diário de grupos de anúncios/v1/tiktok-ads/ad-groups-daily-reportUma linha por grupo de anúncios por dia: investimento, impressões, cliques, conversões, resultados e visualizações de vídeo.
• getRelatório diário de anúncios/v1/tiktok-ads/ads-daily-reportUma linha por anúncio por dia: investimento, impressões, cliques, conversões, resultados e visualizações de vídeo.
• getRelatório diário de eventos do site por anúncio/v1/tiktok-ads/ads-page-events-daily-reportUma linha por anúncio por dia com os eventos do site medidos pelo pixel do TikTok: pagamentos, cadastros, visualizações de produto,…

RecursosCopiar link da seção

Paginação e filtrosCopiar link da seção

• page (padrão 1) e limit (padrão 500, máximo 5000). meta.hasNextPage diz se existe outra página; as linhas vêm sempre na mesma ordem, então avance as páginas até ele ser false.
• dateFrom / dateTo (YYYY-MM-DD, inclusivos) filtram pela coluna de data indicada na tabela acima. Recursos sem coluna de data recusam esses parâmetros.
• integrationId mantém só as linhas de uma conta conectada.
• As respostas ficam em cache por 30 minutos e os dados são sincronizados uma vez por dia — veja Sincronização de dados.

Formato da respostaCopiar link da seção

{
  "data": [{ "...": "um objeto por linha, com as colunas listadas em cada endpoint" }],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Valores monetários e contadores grandes (campos format: decimal e format: int64 no schema de cada endpoint) chegam como texto, por exemplo "125.50", para não perder precisão. Converta para um tipo decimal do seu lado.