TikTok
TikTok Top Ads

Retrieve TikTok Top Ads interactive time analysis

Returns the detail-page interactive time analysis chart and percentile for a Top Ads material. Metric values are retain_ctr (CTR), retain_cvr (CVR), click_cnt (Clicks), convert_cnt (Conversion), and play_retain_cnt (Remain).

get/tiktok/top-ads/analysis

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/tiktok/top-ads/analysis
  • Auth: API key in header x-api-key

Query parameters

material_idstring required

Top Ads material id

metric'retain_ctr' | 'retain_cvr' | 'click_cnt' | 'convert_cnt' | 'play_retain_cnt'

Interactive time analysis metric

period_type7 | 30 | 180

Percentile lookback period in days

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.