TikTok AdsTikTok AdsAdvertising

Your TikTok ads' spend, impressions, clicks, conversions

tiktok-ads.query

Get spend, impressions, clicks and conversions for your TikTok ads

Price
freeAl precio del proveedor
Success rate
—Aún no hay datos de tasa de éxitoAún no hay datos de tasa de éxito
Latency p50
——
Last verified
—Not verified yet
GEThttps://toolswitch.dev/v1/tools/tiktok-ads.queryPreview
Try onlinePróximamenteProvider docs ↗
  • Uses platform quota
  • Synchronous response
  • Reads public data

Parámetros

spend is a decimal STRING in the advertiser's currency (not micros). Dimensions and metrics are validated as a pair: asking for a metric the chosen data_level does not support fails the whole request with code 40002 instead of dropping the column. Attribution follows the ad account's window, so today's conversions keep changing for days

ParámetroTipoObligatorioDescripciónEjemplo
Parámetros de consulta
pageenteroOpcional1
metricsmatrizOpcionalJSON array; defaults to a thin set, so always name them["spend","impressions","clicks","ctr","cpc","conversion","cost_per_conversion"]
end_datecadenaOpcionalYYYY-MM-DD; the window is capped (about 30 days for most report types)2026-07-28
filteringmatrizOpcionalJSON array of filter objects, e.g. [{"field_name":"campaign_ids","filter_type":"IN","filter_value":"[\"123\"]"}]
page_sizeenteroOpcionalmax 1000, default 200100
data_levelcadenaObligatorioAUCTION_ADVERTISER | AUCTION_CAMPAIGN | AUCTION_ADGROUP | AUCTION_AD — must match the id dimension you ask forAUCTION_CAMPAIGN
dimensionsmatrizObligatorioJSON array in the query string. One id dimension plus optionally stat_time_day for a daily series: ["campaign_id","stat_time_day"]["campaign_id","stat_time_day"]
order_typecadenaOpcionalASC | DESCDESC
start_datecadenaOpcionalYYYY-MM-DD, in the advertiser's timezone; required unless query_lifetime is true2026-06-28
order_fieldcadenaOpcionalspend
report_typecadenaObligatorioBASIC (performance) | AUDIENCE (demographic breakdowns) | PLAYABLE_MATERIAL | CATALOG | BCBASIC
advertiser_idcadenaObligatorio7000000000000000000
query_lifetimebooleanoOpcionaltrue returns all-time totals and forbids start_date/end_datefalse
  • Parámetros de consulta
  • pageenteroOpcional

    Ejemplo: 1

  • metricsmatrizOpcional

    JSON array; defaults to a thin set, so always name them

    Ejemplo: ["spend","impressions","clicks","ctr","cpc","conversion","cost_per_conversion"]

  • end_datecadenaOpcional

    YYYY-MM-DD; the window is capped (about 30 days for most report types)

    Ejemplo: 2026-07-28

  • filteringmatrizOpcional

    JSON array of filter objects, e.g. [{"field_name":"campaign_ids","filter_type":"IN","filter_value":"[\"123\"]"}]

  • page_sizeenteroOpcional

    max 1000, default 200

    Ejemplo: 100

  • data_levelcadenaObligatorio

    AUCTION_ADVERTISER | AUCTION_CAMPAIGN | AUCTION_ADGROUP | AUCTION_AD — must match the id dimension you ask for

    Ejemplo: AUCTION_CAMPAIGN

  • dimensionsmatrizObligatorio

    JSON array in the query string. One id dimension plus optionally stat_time_day for a daily series: ["campaign_id","stat_time_day"]

    Ejemplo: ["campaign_id","stat_time_day"]

  • order_typecadenaOpcional

    ASC | DESC

    Ejemplo: DESC

  • start_datecadenaOpcional

    YYYY-MM-DD, in the advertiser's timezone; required unless query_lifetime is true

    Ejemplo: 2026-06-28

  • order_fieldcadenaOpcional

    Ejemplo: spend

  • report_typecadenaObligatorio

    BASIC (performance) | AUDIENCE (demographic breakdowns) | PLAYABLE_MATERIAL | CATALOG | BC

    Ejemplo: BASIC

  • advertiser_idcadenaObligatorio

    Ejemplo: 7000000000000000000

  • query_lifetimebooleanoOpcional

    true returns all-time totals and forbids start_date/end_date

    Ejemplo: false

Ejemplos de código

Sustituye $TOOLSWITCH_KEY por la clave que creaste en la consola.

Preview
curl -X GET 'https://toolswitch.dev/v1/tools/tiktok-ads.query' \
  -H "X-Toolswitch-Key: $TOOLSWITCH_KEY"

La API de la pasarela está en versión preliminar; su URL y autenticación pueden cambiar. Los parámetros del ejemplo son datos de muestra. Las llamadas se facturan a free, incluida la tarifa de servicio.