Get TikTok Ads Library report | TikTok Ads Library API

Returns regional distribution and daily publication counts of ads between start_time and end_time. region, advertiser_id, and query narrow the scope; lang sets the label language.

1 credit / requestBilled only on success

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Query Parameters

region?string

Use all for a global report, or a two-letter region code returned by /regions.

Default"all"

start_time*string

Inclusive start of the requested date range as a Unix timestamp in seconds.

Length1 <= length

end_time*string

End of the requested date range as a Unix timestamp in seconds. Must be greater than or equal to start_time.

Length1 <= length

lang?string

Locale used for translated region and display labels. Defaults to en-GB.

Default"en-GB"

Value in

"bg-BG"
"cs-CZ"
"da-DK"
"de-DE"
"el-GR"
"en-GB"
"en-US"
"es-ES"
"et-EE"
"fi-FI"
"fr-FR"
"hr-HR"
"hu-HU"
"it-IT"
"lt-LT"
"lv-LV"
"nb-NO"
"nl-NL"
"pl-PL"
"pt-PT"
"ro-RO"
"sk-SK"
"sl-SI"
"sv-SE"

advertiser_id?string

Advertiser id from the /suggestions response. Send it with query (the advertiser name) to scope the report to one advertiser.

Lengthlength <= 100

query?string

Advertiser name that goes with advertiser_id, as returned by /suggestions.

Lengthlength <= 200

curl -X GET "https://example.com/v1/tiktok-ads/reports?start_time=1782287985&end_time=1784879985" \  -H "x-api-key: YOUR_API_KEY"

{  "data": {    "property1": null,    "property2": null  }}