TikTok Ads

Relatório diário de eventos do site por anúncio

GET
/v1/tiktok-ads/ads-page-events-daily-report

Uma linha por anúncio por dia com os eventos do site medidos pelo pixel do TikTok: pagamentos, cadastros, visualizações de produto, adições ao carrinho, checkouts iniciados e adições à lista de desejos, com os valores.

dateFrom e dateTo filtram por stat_time_day (dias inclusivos, YYYY-MM-DD). As linhas são ordenadas por stat_time_day, ad_id, integration_id, inserted_at e paginadas com page/limit; meta.hasNextPage diz se existe outra página. As respostas ficam em cache por 30 minutos.

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Organização dona das contas conectadas.

Formatouuid
integrationId?string

Uma conta conectada desta integração (o integration_id das linhas). Omita para ler todas as contas da organização.

Tamanholength <= 255
dateFrom?string

Primeiro dia (inclusivo) de stat_time_day, YYYY-MM-DD.

Formatodate
dateTo?string

Último dia (inclusivo) de stat_time_day, YYYY-MM-DD. Não pode ser anterior a dateFrom.

Formatodate
page?integer

Número da página, a partir de 1.

Intervalo1 <= value <= 1000000
Padrão1
limit?integer

Linhas por página (máximo 5000).

Intervalo1 <= value <= 5000
Padrão500

Corpo da resposta

Uma página de linhas

application/json
  1. response
data*array<>
meta*
curl -X GET "https://example.com/v1/tiktok-ads/ads-page-events-daily-report?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b&dateFrom=2026-10-01&dateTo=2026-10-31"
{  "data": [    {      "organization_id": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",      "integration_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",      "user_id": "123456",      "document_id": "123456",      "integration_name": "example",      "ad_id": "123456",      "stat_time_day": "2026-10-01",      "complete_payment": "1250",      "total_complete_payment_rate": "125.50",      "user_registration": "1250",      "total_user_registration_value": "125.50",      "product_details_page_browse": "1250",      "total_product_details_page_browse_value": "125.50",      "web_event_add_to_cart": "1250",      "total_web_event_add_to_cart_value": "125.50",      "initiate_checkout": "1250",      "total_initiate_checkout_value": "125.50",      "on_web_add_to_wishlist": "1250",      "total_on_web_add_to_wishlist_value": "125.50",      "inserted_at": "2026-10-01T12:00:00.000Z"    }  ],  "meta": {    "page": 1,    "limit": 500,    "hasNextPage": false,    "hasPreviousPage": false  }}