TikTok Shop Video Detail

12 credits/call
ae_tiktok_shop_video_detail

Retrieve detailed TikTok Shop performance information for a specific video, including views, engagement, sales, revenue, advertising metrics, and associated creator details. Select the country, reporting period, currency, and response language. TikTok Shop data is provided by Kalodata.

VideoSocial
12 credits/call

Pricing

12 credits/call
ConditionCharge
Each call12 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
regionenum (US | BR | MX | ID | JP | MY | PH | SG | TH | VN | GB | ES | DE | FR | IT | PL | NL | BE | CZ | AT | GR | PT | HU | IE)YesTikTok Shop country whose data to query. Choose one of the listed supported country codes.—
currencyenum (CNY | USD | IDR | VND | THB | MYR | JPY | PHP | GBP | SGD | MXN | EUR | BRL | PLN | CZK | HUF)YesCurrency used for revenue and price fields. Choose one of the listed supported currency codes.—
languageenum (zh-CN | en-US | id-ID | th-TH | vi-VN | es-ES | ja-JP | pt-BR | ko-KR | fr-FR | de-DE | pl-PL | nl-NL | cs-CZ | el-GR | hu-HU | pt-PT | it-IT)YesLanguage for text fields in the response. Choose one of the listed supported language codes.—
video_idstringYesID of the TikTok Shop video to query.—
date_rangestringYesReporting period for the video metrics. This operation accepts lastDay, last7Day, last30Day, last60Day, last90Day, last180Day, or last365Day; a date range in yyyy-MM-dd~yyyy-MM-dd form; or a calendar month in yyyy-MM form.—
need_extrabooleanNoWhether to request additional information that the provider may make available. This flag can be omitted; the actual additional fields depend on data availability.—

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_tiktok_shop_video_detail' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "currency": "IDR",
    "date_range": "last30Day",
    "language": "zh-CN",
    "need_extra": true,
    "region": "ID",
    "video_id": "7703541665390234900"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "cached": null,
  "code": null,
  "data": {
    "ad": 1,
    "ad_cpa": 81734.86042516344,
    "ad_view_ratio": 6.593197917074339,
    "ads_period": 6,
    "ads_roas": 4.02,
    "ads_views": 8149404
  },
  "message": null,
  "success": true
}

This example shows part of the response. Copied content is valid JSON.