Endpoint Playground

Try the TikTok Top Ads Time Analysis API

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).

What a live request returned

14 Oct 2026: 18 data.analysis; 2 fields had a value in every checked item.

Observed request: GET /tiktok/top-ads/analysis?material_id=7635103915176640520
Fields with a value in every checked item: second, value

Sample value profiles: second: 0 to 17, median 8; value: 0 to 1, median 0.09.

Request: GET /tiktok/top-ads/analysis
Cost: 8 credits/request
Auth: apiKey
Checks passed, 7 days to 14 Oct 2026: 100%, median 1.60 s
Monitored request: GET /tiktok/top-ads/analysis?material_id=7635103915176640520

TikTok Top Ads Time Analysis API documentation TikTok platform page Pricing

Prefilled cURL

curl "https://api.crawlora.net/api/v1/tiktok/top-ads/analysis?material_id=sample-material-id&metric=retain_ctr&period_type=7" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters

Parameter	Type	Required	Prefilled value	Description
material_id	string	Yes	sample-material-id	Top Ads material id
metric	string	No	retain_ctr	Interactive time analysis metric
period_type	integer	No	7	Percentile lookback period in days

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "code": 0,
    "msg": "OK",
    "data": {
      "metric": "retain_cvr",
      "metric_label": "CVR",
      "percentile_metric": "time_attr_conversion_rate_percentile",
      "period_type": 7,
      "analysis": [
        {
          "second": 0,
          "value": 0.12
        }
      ],
      "duration": 30,
      "highlight": [
        3,
        8,
        15
      ],
      "percentile": 0.81
    }
  }
}

More TikTok endpoints

List TikTok explore categories Retrieve TikTok video comments Retrieve TikTok Creative Center trending hashtags Retrieve TikTok Creative Center trending videos Retrieve the TikTok explore feed for a category Retrieve TikTok hashtag details Retrieve TikTok hashtag posts Retrieve TikTok popular-trend country and industry metadata Retrieve TikTok video details Retrieve posts from a TikTok profile Retrieve a TikTok profile Search TikTok videos All 25 TikTok endpoints

The sample response, schema and code snippets below work without an account. Sending a live request needs an API key.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey8 credits/requestpopulartrend.topAdsAnalysisResponseDocTikTok

GET /tiktok/top-ads/analysis

Retrieve TikTok Top Ads interactive time analysis

Response behavior

- The chart points come from TikTok's public `/top_ads/keyframe` endpoint. - The `percentile` value comes from TikTok's public `/top_ads/percentile` endpoint and uses the matching percentile metric for the requested tab. - Nonzero TikTok upstream response codes are returned as upstream errors. - Complete enum values for `metric` and `period_type` are listed in `docs/tiktok-top-ads-enums.md`.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

material_id

requiredstring

Top Ads material id

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "code": 0,
    "msg": "OK",
    "data": {
      "metric": "retain_cvr",
      "metric_label": "CVR",
      "percentile_metric": "time_attr_conversion_rate_percentile",
      "period_type": 7,
      "analysis": [
        {
          "second": 0,
          "value": 0.12
        }
      ],
      "duration": 30,
      "highlight": [
        3,
        8,
        15
      ],
      "percentile": 0.81
    }
  }
}

Endpoint Playground

Try the TikTok Top Ads Time Analysis API

What a live request returned

14 Oct 2026: 18 data.analysis; 2 fields had a value in every checked item.

Observed request: GET /tiktok/top-ads/analysis?material_id=7635103915176640520
Fields with a value in every checked item: second, value

Sample value profiles: second: 0 to 17, median 8; value: 0 to 1, median 0.09.

Request: GET /tiktok/top-ads/analysis
Cost: 8 credits/request
Auth: apiKey
Checks passed, 7 days to 14 Oct 2026: 100%, median 1.60 s
Monitored request: GET /tiktok/top-ads/analysis?material_id=7635103915176640520

TikTok Top Ads Time Analysis API documentation TikTok platform page Pricing

Prefilled cURL

curl "https://api.crawlora.net/api/v1/tiktok/top-ads/analysis?material_id=sample-material-id&metric=retain_ctr&period_type=7" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters

Parameter	Type	Required	Prefilled value	Description
material_id	string	Yes	sample-material-id	Top Ads material id
metric	string	No	retain_ctr	Interactive time analysis metric
period_type	integer	No	7	Percentile lookback period in days

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "code": 0,
    "msg": "OK",
    "data": {
      "metric": "retain_cvr",
      "metric_label": "CVR",
      "percentile_metric": "time_attr_conversion_rate_percentile",
      "period_type": 7,
      "analysis": [
        {
          "second": 0,
          "value": 0.12
        }
      ],
      "duration": 30,
      "highlight": [
        3,
        8,
        15
      ],
      "percentile": 0.81
    }
  }
}

More TikTok endpoints

The sample response, schema and code snippets below work without an account. Sending a live request needs an API key.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey8 credits/requestpopulartrend.topAdsAnalysisResponseDocTikTok

GET /tiktok/top-ads/analysis

Retrieve TikTok Top Ads interactive time analysis

Response behavior

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Required query parameters

material_id

requiredstring

Top Ads material id

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "code": 0,
    "msg": "OK",
    "data": {
      "metric": "retain_cvr",
      "metric_label": "CVR",
      "percentile_metric": "time_attr_conversion_rate_percentile",
      "period_type": 7,
      "analysis": [
        {
          "second": 0,
          "value": 0.12
        }
      ],
      "duration": 30,
      "highlight": [
        3,
        8,
        15
      ],
      "percentile": 0.81
    }
  }
}