@tikomni/skills 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.skill-package-allowlist.txt +4 -0
- package/LICENSE +21 -0
- package/README.md +167 -0
- package/README.zh-CN.md +167 -0
- package/bin/tikomni-skills.js +127 -0
- package/env.example +160 -0
- package/lib/installer.js +176 -0
- package/package.json +44 -0
- package/skills/creator-analysis/SKILL.md +71 -0
- package/skills/creator-analysis/agents/openai.yaml +4 -0
- package/skills/creator-analysis/env.example +36 -0
- package/skills/creator-analysis/references/api-capability-index.md +92 -0
- package/skills/creator-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/creator-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/creator-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/creator-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/creator-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/creator-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/creator-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/creator-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/creator-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/creator-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/creator-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/creator-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/creator-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/creator-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/creator-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/creator-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/creator-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/creator-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/creator-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/creator-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/creator-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/creator-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/creator-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/creator-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/creator-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/creator-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/creator-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/creator-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/creator-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/creator-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/creator-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/creator-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/creator-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/creator-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/creator-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/creator-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/creator-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/creator-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/creator-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/creator-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/creator-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/creator-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/creator-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/creator-analysis/references/api-tags/health-check.md +40 -0
- package/skills/creator-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/creator-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/creator-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/creator-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/creator-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/creator-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/creator-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/creator-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/creator-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/creator-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/creator-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/creator-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/creator-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/creator-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/creator-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/creator-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/creator-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/creator-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/creator-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/creator-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/creator-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/creator-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/creator-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/creator-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/creator-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/creator-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/creator-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/creator-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/creator-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/creator-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/creator-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/creator-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/creator-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/creator-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/creator-analysis/references/asr-orchestration.md +33 -0
- package/skills/creator-analysis/references/config-templates/defaults.yaml +60 -0
- package/skills/creator-analysis/references/contracts/creator-card-fields.md +23 -0
- package/skills/creator-analysis/references/contracts/work-card-fields.md +32 -0
- package/skills/creator-analysis/references/platform-guides/douyin.md +49 -0
- package/skills/creator-analysis/references/platform-guides/generic.md +46 -0
- package/skills/creator-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/creator-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis-v2.md +46 -0
- package/skills/creator-analysis/references/prompt-contracts/author-analysis.md +49 -0
- package/skills/creator-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/creator-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/creator-analysis/references/prompt-contracts/sampled-work-batch-explanations.md +30 -0
- package/skills/creator-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/creator-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/creator-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/creator-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/creator-analysis/references/schemas/author-analysis-input-v1.schema.json +325 -0
- package/skills/creator-analysis/references/schemas/author-analysis-v2.schema.json +158 -0
- package/skills/creator-analysis/references/schemas/sampled-work-batch-explanations.schema.json +41 -0
- package/skills/creator-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/creator-analysis/references/workflow.md +18 -0
- package/skills/creator-analysis/scripts/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/adapters/platform_adapters.py +299 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/author_analysis_v2_support.py +1122 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/prompt_first_analyzers.py +260 -0
- package/skills/creator-analysis/scripts/author_home/analyzers/sampled_work_batch_explainer.py +260 -0
- package/skills/creator-analysis/scripts/author_home/asr/__init__.py +5 -0
- package/skills/creator-analysis/scripts/author_home/asr/home_asr.py +961 -0
- package/skills/creator-analysis/scripts/author_home/builders/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/builders/home_builders.py +149 -0
- package/skills/creator-analysis/scripts/author_home/collectors/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/collectors/homepage_collectors.py +636 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/__init__.py +0 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/run_author_analysis.py +491 -0
- package/skills/creator-analysis/scripts/author_home/orchestrator/work_analysis_artifacts.py +553 -0
- package/skills/creator-analysis/scripts/author_home/schema.py +417 -0
- package/skills/creator-analysis/scripts/core/__init__.py +0 -0
- package/skills/creator-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/creator-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/creator-analysis/scripts/core/config_loader.py +418 -0
- package/skills/creator-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/creator-analysis/scripts/core/progress_report.py +111 -0
- package/skills/creator-analysis/scripts/core/storage_router.py +253 -0
- package/skills/creator-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/creator-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/creator-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/creator-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/creator-analysis/scripts/platform/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/creator-analysis/scripts/platform/douyin/run_douyin_single_video.py +1208 -0
- package/skills/creator-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/creator-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2128 -0
- package/skills/creator-analysis/scripts/writers/__init__.py +0 -0
- package/skills/creator-analysis/scripts/writers/write_author_homepage_samples.py +106 -0
- package/skills/creator-analysis/scripts/writers/write_benchmark_card.py +1402 -0
- package/skills/meta-capability/SKILL.md +69 -0
- package/skills/meta-capability/agents/openai.yaml +4 -0
- package/skills/meta-capability/env.example +42 -0
- package/skills/meta-capability/references/api-capability-index.md +92 -0
- package/skills/meta-capability/references/api-contracts/asr-api.md +130 -0
- package/skills/meta-capability/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/meta-capability/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/meta-capability/references/api-contracts/demo-api.md +717 -0
- package/skills/meta-capability/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/meta-capability/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/meta-capability/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/meta-capability/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/meta-capability/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/meta-capability/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/meta-capability/references/api-contracts/health-check.md +69 -0
- package/skills/meta-capability/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/meta-capability/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/meta-capability/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/meta-capability/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/meta-capability/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/meta-capability/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/meta-capability/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/meta-capability/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/meta-capability/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/meta-capability/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/meta-capability/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/meta-capability/references/api-contracts/sora2-api.md +2266 -0
- package/skills/meta-capability/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/meta-capability/references/api-contracts/threads-web-api.md +897 -0
- package/skills/meta-capability/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/meta-capability/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/meta-capability/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/meta-capability/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/meta-capability/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/meta-capability/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/meta-capability/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/meta-capability/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/meta-capability/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/meta-capability/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/meta-capability/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/meta-capability/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/meta-capability/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/meta-capability/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/meta-capability/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/meta-capability/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/meta-capability/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/meta-capability/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/meta-capability/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/meta-capability/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/meta-capability/references/api-tags/asr-api.md +100 -0
- package/skills/meta-capability/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/meta-capability/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/meta-capability/references/api-tags/demo-api.md +365 -0
- package/skills/meta-capability/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/meta-capability/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/meta-capability/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/meta-capability/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/meta-capability/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/meta-capability/references/api-tags/health-check.md +40 -0
- package/skills/meta-capability/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/meta-capability/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/meta-capability/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/meta-capability/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/meta-capability/references/api-tags/ios-shortcut.md +45 -0
- package/skills/meta-capability/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/meta-capability/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/meta-capability/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/meta-capability/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/meta-capability/references/api-tags/media-ingest-api.md +112 -0
- package/skills/meta-capability/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/meta-capability/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/meta-capability/references/api-tags/sora2-api.md +737 -0
- package/skills/meta-capability/references/api-tags/temp-mail-api.md +136 -0
- package/skills/meta-capability/references/api-tags/threads-web-api.md +472 -0
- package/skills/meta-capability/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/meta-capability/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/meta-capability/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/meta-capability/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/meta-capability/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/meta-capability/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/meta-capability/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/meta-capability/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/meta-capability/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/meta-capability/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/meta-capability/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/meta-capability/references/api-tags/twitter-web-api.md +562 -0
- package/skills/meta-capability/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/meta-capability/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/meta-capability/references/api-tags/weibo-app-api.md +851 -0
- package/skills/meta-capability/references/api-tags/weibo-web-api.md +470 -0
- package/skills/meta-capability/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/meta-capability/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/meta-capability/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/meta-capability/references/api-tags/youtube-web-api.md +934 -0
- package/skills/meta-capability/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/meta-capability/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/meta-capability/references/config-templates/defaults.yaml +18 -0
- package/skills/meta-capability/references/dispatch.md +27 -0
- package/skills/meta-capability/references/execution-guidelines.md +25 -0
- package/skills/meta-capability/references/implemented-route-map.md +177 -0
- package/skills/meta-capability/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/meta-capability/scripts/__init__.py +1 -0
- package/skills/meta-capability/scripts/call_route.py +141 -0
- package/skills/meta-capability/scripts/core/__init__.py +1 -0
- package/skills/meta-capability/scripts/core/bootstrap_env.py +32 -0
- package/skills/meta-capability/scripts/core/config_loader.py +204 -0
- package/skills/meta-capability/scripts/core/tikomni_common.py +443 -0
- package/skills/meta-capability/scripts/test_auth.py +98 -0
- package/skills/single-work-analysis/SKILL.md +62 -0
- package/skills/single-work-analysis/agents/openai.yaml +4 -0
- package/skills/single-work-analysis/env.example +36 -0
- package/skills/single-work-analysis/references/api-capability-index.md +92 -0
- package/skills/single-work-analysis/references/api-contracts/asr-api.md +130 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-app-api.md +776 -0
- package/skills/single-work-analysis/references/api-contracts/bilibili-web-api.md +2017 -0
- package/skills/single-work-analysis/references/api-contracts/demo-api.md +717 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-app-v3-api.md +3594 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-billboard-api.md +2274 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-api.md +1575 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-creator-v2-api.md +3254 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-search-api.md +4118 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-web-api.md +5544 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-api.md +1916 -0
- package/skills/single-work-analysis/references/api-contracts/douyin-xingtu-v2-api.md +1540 -0
- package/skills/single-work-analysis/references/api-contracts/health-check.md +69 -0
- package/skills/single-work-analysis/references/api-contracts/hybrid-parsing.md +78 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v1-api.md +2256 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v2-api.md +2011 -0
- package/skills/single-work-analysis/references/api-contracts/instagram-v3-api.md +2630 -0
- package/skills/single-work-analysis/references/api-contracts/ios-shortcut.md +44 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-app-api.md +1518 -0
- package/skills/single-work-analysis/references/api-contracts/kuaishou-web-api.md +1242 -0
- package/skills/single-work-analysis/references/api-contracts/lemon8-app-api.md +1088 -0
- package/skills/single-work-analysis/references/api-contracts/linkedin-web-api.md +1949 -0
- package/skills/single-work-analysis/references/api-contracts/media-ingest-api.md +126 -0
- package/skills/single-work-analysis/references/api-contracts/pipixia-app-api.md +1142 -0
- package/skills/single-work-analysis/references/api-contracts/reddit-app-api.md +2025 -0
- package/skills/single-work-analysis/references/api-contracts/sora2-api.md +2266 -0
- package/skills/single-work-analysis/references/api-contracts/temp-mail-api.md +208 -0
- package/skills/single-work-analysis/references/api-contracts/threads-web-api.md +897 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-downloader-api.md +134 -0
- package/skills/single-work-analysis/references/api-contracts/tikhub-user-api.md +494 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-ads-api.md +5947 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-analytics-api.md +968 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-app-v3-api.md +5735 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-creator-api.md +1951 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-interaction-api.md +742 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-shop-web-api.md +1890 -0
- package/skills/single-work-analysis/references/api-contracts/tiktok-web-api.md +4448 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-app-api.md +342 -0
- package/skills/single-work-analysis/references/api-contracts/toutiao-web-api.md +143 -0
- package/skills/single-work-analysis/references/api-contracts/twitter-web-api.md +989 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-channels-api.md +809 -0
- package/skills/single-work-analysis/references/api-contracts/wechat-media-platform-web-api.md +677 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-app-api.md +1547 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-api.md +798 -0
- package/skills/single-work-analysis/references/api-contracts/weibo-web-v2-api.md +2459 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-api.md +1291 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-app-v2-api.md +1683 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-api.md +1324 -0
- package/skills/single-work-analysis/references/api-contracts/xiaohongshu-web-v2-api.md +1209 -0
- package/skills/single-work-analysis/references/api-contracts/xigua-app-v2-api.md +489 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-api.md +2636 -0
- package/skills/single-work-analysis/references/api-contracts/youtube-web-v2-api.md +2660 -0
- package/skills/single-work-analysis/references/api-contracts/zhihu-web-api.md +2315 -0
- package/skills/single-work-analysis/references/api-tags/asr-api.md +100 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-app-api.md +482 -0
- package/skills/single-work-analysis/references/api-tags/bilibili-web-api.md +1267 -0
- package/skills/single-work-analysis/references/api-tags/demo-api.md +365 -0
- package/skills/single-work-analysis/references/api-tags/douyin-app-v3-api.md +2012 -0
- package/skills/single-work-analysis/references/api-tags/douyin-billboard-api.md +1428 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-creator-v2-api.md +694 -0
- package/skills/single-work-analysis/references/api-tags/douyin-search-api.md +1059 -0
- package/skills/single-work-analysis/references/api-tags/douyin-web-api.md +3314 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-api.md +935 -0
- package/skills/single-work-analysis/references/api-tags/douyin-xingtu-v2-api.md +925 -0
- package/skills/single-work-analysis/references/api-tags/health-check.md +40 -0
- package/skills/single-work-analysis/references/api-tags/hybrid-parsing.md +57 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v1-api.md +1224 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v2-api.md +1147 -0
- package/skills/single-work-analysis/references/api-tags/instagram-v3-api.md +1123 -0
- package/skills/single-work-analysis/references/api-tags/ios-shortcut.md +45 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-app-api.md +846 -0
- package/skills/single-work-analysis/references/api-tags/kuaishou-web-api.md +551 -0
- package/skills/single-work-analysis/references/api-tags/lemon8-app-api.md +687 -0
- package/skills/single-work-analysis/references/api-tags/linkedin-web-api.md +1105 -0
- package/skills/single-work-analysis/references/api-tags/media-ingest-api.md +112 -0
- package/skills/single-work-analysis/references/api-tags/pipixia-app-api.md +721 -0
- package/skills/single-work-analysis/references/api-tags/reddit-app-api.md +1057 -0
- package/skills/single-work-analysis/references/api-tags/sora2-api.md +737 -0
- package/skills/single-work-analysis/references/api-tags/temp-mail-api.md +136 -0
- package/skills/single-work-analysis/references/api-tags/threads-web-api.md +472 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-downloader-api.md +65 -0
- package/skills/single-work-analysis/references/api-tags/tikhub-user-api.md +253 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-ads-api.md +1393 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-analytics-api.md +179 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-app-v3-api.md +3264 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-creator-api.md +709 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-interaction-api.md +366 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-shop-web-api.md +663 -0
- package/skills/single-work-analysis/references/api-tags/tiktok-web-api.md +2516 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-app-api.md +220 -0
- package/skills/single-work-analysis/references/api-tags/toutiao-web-api.md +96 -0
- package/skills/single-work-analysis/references/api-tags/twitter-web-api.md +562 -0
- package/skills/single-work-analysis/references/api-tags/wechat-channels-api.md +405 -0
- package/skills/single-work-analysis/references/api-tags/wechat-media-platform-web-api.md +431 -0
- package/skills/single-work-analysis/references/api-tags/weibo-app-api.md +851 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-api.md +470 -0
- package/skills/single-work-analysis/references/api-tags/weibo-web-v2-api.md +1405 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-api.md +534 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-app-v2-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-api.md +757 -0
- package/skills/single-work-analysis/references/api-tags/xiaohongshu-web-v2-api.md +762 -0
- package/skills/single-work-analysis/references/api-tags/xigua-app-v2-api.md +308 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-api.md +934 -0
- package/skills/single-work-analysis/references/api-tags/youtube-web-v2-api.md +717 -0
- package/skills/single-work-analysis/references/api-tags/zhihu-web-api.md +1384 -0
- package/skills/single-work-analysis/references/asr-and-fallback.md +20 -0
- package/skills/single-work-analysis/references/config-templates/defaults.yaml +58 -0
- package/skills/single-work-analysis/references/contracts/work-card-fields.md +41 -0
- package/skills/single-work-analysis/references/platform-guides/douyin.md +47 -0
- package/skills/single-work-analysis/references/platform-guides/generic.md +43 -0
- package/skills/single-work-analysis/references/platform-guides/xiaohongshu.md +54 -0
- package/skills/single-work-analysis/references/prompt-contracts/asr-clean.md +28 -0
- package/skills/single-work-analysis/references/prompt-contracts/cta.md +24 -0
- package/skills/single-work-analysis/references/prompt-contracts/hook.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/insight.md +47 -0
- package/skills/single-work-analysis/references/prompt-contracts/structure.md +25 -0
- package/skills/single-work-analysis/references/prompt-contracts/style.md +27 -0
- package/skills/single-work-analysis/references/prompt-contracts/summary.md +29 -0
- package/skills/single-work-analysis/references/prompt-contracts/topic.md +29 -0
- package/skills/single-work-analysis/references/schemas/work-card.schema.json +39 -0
- package/skills/single-work-analysis/references/service-guides/asr-u2-u3-fallback.md +75 -0
- package/skills/single-work-analysis/scripts/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/core/analysis_pipeline.py +133 -0
- package/skills/single-work-analysis/scripts/core/bootstrap_env.py +35 -0
- package/skills/single-work-analysis/scripts/core/config_loader.py +418 -0
- package/skills/single-work-analysis/scripts/core/extract_pipeline.py +173 -0
- package/skills/single-work-analysis/scripts/core/progress_report.py +111 -0
- package/skills/single-work-analysis/scripts/core/storage_router.py +253 -0
- package/skills/single-work-analysis/scripts/core/tikomni_common.py +588 -0
- package/skills/single-work-analysis/scripts/pipeline/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/asr_pipeline.py +1189 -0
- package/skills/single-work-analysis/scripts/pipeline/asr/poll_u2_task.py +95 -0
- package/skills/single-work-analysis/scripts/platform/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/douyin/douyin_video_type_matrix.py +224 -0
- package/skills/single-work-analysis/scripts/platform/douyin/run_douyin_single_video.py +1233 -0
- package/skills/single-work-analysis/scripts/platform/douyin/select_low_quality_video_url.py +200 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/platform/xiaohongshu/run_xiaohongshu_extract.py +2156 -0
- package/skills/single-work-analysis/scripts/writers/__init__.py +0 -0
- package/skills/single-work-analysis/scripts/writers/write_benchmark_card.py +1402 -0
|
@@ -0,0 +1,1951 @@
|
|
|
1
|
+
# TikTok-Creator-API Full Contract
|
|
2
|
+
|
|
3
|
+
- Back to index: [`api-capability-index.md`](../api-capability-index.md)
|
|
4
|
+
- Back to route summary: [`api-tags/tiktok-creator-api.md`](../api-tags/tiktok-creator-api.md)
|
|
5
|
+
- Current contract file: `api-contracts/tiktok-creator-api.md`
|
|
6
|
+
- Source: `https://app.tikomni.com/openapi/tikomni-openapi.full.with-u2.public.latest.json`
|
|
7
|
+
- Fetched at: `2026-03-08T06:54:04+00:00`
|
|
8
|
+
- Route count: `14`
|
|
9
|
+
- Default auth: Header `Authorization` Bearer
|
|
10
|
+
- Read this file only when you need precise auth notes, parameter descriptions, defaults, examples, or success-response fields.
|
|
11
|
+
- Tag description: **(TikTok创作者数据和账号收益数据接口/TikTok-Creator-API data and account revenue data endpoints)**
|
|
12
|
+
|
|
13
|
+
## Route Contracts
|
|
14
|
+
|
|
15
|
+
<a id="post-api-u1-v1-tiktok-creator-get-account-health-status"></a>
|
|
16
|
+
### `POST /api/u1/v1/tiktok/creator/get_account_health_status`
|
|
17
|
+
|
|
18
|
+
- Summary: 获取创作者账号健康状态/Get Creator Account Health Status
|
|
19
|
+
- Capabilities: creators
|
|
20
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
21
|
+
- operationId: `get_account_health_status_api_v1_tiktok_creator_get_account_health_status_post`
|
|
22
|
+
|
|
23
|
+
#### Notes
|
|
24
|
+
|
|
25
|
+
> # [中文]
|
|
26
|
+
> ### 用途:
|
|
27
|
+
> - 获取 TikTok Shop 创作者账号的健康状况信息,包括过去 90 天内的健康评分(风险等级)以及当前累计的违规积分数量。
|
|
28
|
+
> - 关于违规积分:
|
|
29
|
+
> - 违规积分是 TikTok 用于衡量账号健康状况的重要指标。
|
|
30
|
+
> - 违规积分越高,账号健康状况越差,可能面临限流、禁播、封禁等处罚。
|
|
31
|
+
> - 违规积分将直接影响账号的曝光量和推荐量。
|
|
32
|
+
>
|
|
33
|
+
> ### 累计违规积分对应的惩罚等级:
|
|
34
|
+
> | 分数范围 | 惩罚措施 | 惩罚时长 |
|
|
35
|
+
> | --------- | --------------------------------------------------------- | -------- |
|
|
36
|
+
> | 9-11 | 警告(Warning) | 无 |
|
|
37
|
+
> | 12-14 | 暂停电商权限(视频、直播、商品展示功能) | 24 小时 |
|
|
38
|
+
> | 15-17 | 暂停电商权限 | 48 小时 |
|
|
39
|
+
> | 18-20 | 暂停电商权限 | 72 小时 |
|
|
40
|
+
> | 21-23 | 暂停电商权限 | 1 周 |
|
|
41
|
+
> | 24 及以上 | 永久移除电商权限,封禁 TikTok Shop 创作者账号 | 永久禁用 |
|
|
42
|
+
>
|
|
43
|
+
> ### 备注:
|
|
44
|
+
> - 此接口仅适用于已开通 TikTok Shop 的创作者账号。
|
|
45
|
+
>
|
|
46
|
+
> ### 参数:
|
|
47
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
48
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
49
|
+
> - 示例格式: `http://username:password@host:port`
|
|
50
|
+
>
|
|
51
|
+
> ### 返回:
|
|
52
|
+
> - `risk_info`(健康状态信息):
|
|
53
|
+
> - `risk_level_text`: 当前风险等级描述(如 Healthy)
|
|
54
|
+
> - `light_color`: 健康状态浅色展示色值(rgba 格式)
|
|
55
|
+
> - `dark_color`: 健康状态深色展示色值(rgba 格式)
|
|
56
|
+
> - `vio_score_rule_learn_url`: 查看违规积分规则说明的链接
|
|
57
|
+
> - `is_show_score`: 是否展示违规积分(布尔值)
|
|
58
|
+
> - `violation_score`: 当前违规积分数量
|
|
59
|
+
> - `creator_status`: 创作者账号状态码(0=正常)
|
|
60
|
+
>
|
|
61
|
+
> # [English]
|
|
62
|
+
> ### Purpose:
|
|
63
|
+
> - Retrieve the health status of a TikTok Shop creator account, including the health score over the past 90 days and the current number of accumulated violation points.
|
|
64
|
+
> - About violation points:
|
|
65
|
+
> - Violation points are key metrics used by TikTok to measure the health of a creator account.
|
|
66
|
+
> - Higher violation points indicate worse account health, and may lead to restrictions such as reduced exposure, suspension, or account bans.
|
|
67
|
+
> - Violation points directly impact the account’s visibility and recommendation on the platform.
|
|
68
|
+
>
|
|
69
|
+
> ### Punishment Levels for Accumulated Violation Points:
|
|
70
|
+
> | Score Range | Punishment Measures | Duration |
|
|
71
|
+
> | ----------- | ---------------------------------------------------------- | ---------------- |
|
|
72
|
+
> | 9-11 | Warning | None |
|
|
73
|
+
> | 12-14 | E-commerce permissions suspended (video, live, product showcase) | 24 hours |
|
|
74
|
+
> | 15-17 | E-commerce permissions suspended | 48 hours |
|
|
75
|
+
> | 18-20 | E-commerce permissions suspended | 72 hours |
|
|
76
|
+
> | 21-23 | E-commerce permissions suspended | 1 week |
|
|
77
|
+
> | 24+ | Permanent removal of e-commerce permissions and banning of TikTok Shop creator account | Permanently disabled |
|
|
78
|
+
>
|
|
79
|
+
> ### Notes:
|
|
80
|
+
> - This API is only applicable to TikTok Shop creator accounts.
|
|
81
|
+
>
|
|
82
|
+
> ### Parameters:
|
|
83
|
+
> - cookie: User Cookie string for authentication
|
|
84
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not needed
|
|
85
|
+
> - Example format: `http://username:password@host:port`
|
|
86
|
+
>
|
|
87
|
+
> ### Response:
|
|
88
|
+
> - `risk_info`: Account health status:
|
|
89
|
+
> - `risk_level_text`: Current health level description (e.g., Healthy)
|
|
90
|
+
> - `light_color`: Light color code for health level display (RGBA format)
|
|
91
|
+
> - `dark_color`: Dark color code for health level display (RGBA format)
|
|
92
|
+
> - `vio_score_rule_learn_url`: URL to learn more about violation point rules
|
|
93
|
+
> - `is_show_score`: Whether to display violation points (boolean)
|
|
94
|
+
> - `violation_score`: Current violation score
|
|
95
|
+
> - `creator_status`: Creator account status code (0 = normal)
|
|
96
|
+
>
|
|
97
|
+
> # [示例/Example]
|
|
98
|
+
> ```json
|
|
99
|
+
> payload = {
|
|
100
|
+
> "cookie": "your_cookie"
|
|
101
|
+
> }
|
|
102
|
+
|
|
103
|
+
#### Parameters
|
|
104
|
+
|
|
105
|
+
None
|
|
106
|
+
|
|
107
|
+
#### Request Body
|
|
108
|
+
|
|
109
|
+
- required: Yes
|
|
110
|
+
|
|
111
|
+
##### `application/json`
|
|
112
|
+
|
|
113
|
+
- Schema summary: `cookie`:string, `proxy`:string
|
|
114
|
+
|
|
115
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
116
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
117
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
118
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
119
|
+
|
|
120
|
+
#### Success Response
|
|
121
|
+
|
|
122
|
+
##### `200 application/json`
|
|
123
|
+
|
|
124
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
125
|
+
|
|
126
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
127
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
128
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
129
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
130
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
131
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
132
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
133
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
134
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
135
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
136
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
137
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
138
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
139
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
140
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
141
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
142
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
143
|
+
|
|
144
|
+
<a id="post-api-u1-v1-tiktok-creator-get-account-insights-overview"></a>
|
|
145
|
+
### `POST /api/u1/v1/tiktok/creator/get_account_insights_overview`
|
|
146
|
+
|
|
147
|
+
- Summary: 获取创作者账号概览/Get Creator Account Overview
|
|
148
|
+
- Capabilities: creators / analytics
|
|
149
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
150
|
+
- operationId: `get_account_insights_overview_api_v1_tiktok_creator_get_account_insights_overview_post`
|
|
151
|
+
|
|
152
|
+
#### Notes
|
|
153
|
+
|
|
154
|
+
> # [中文]
|
|
155
|
+
> ### 用途:
|
|
156
|
+
> - 获取 TikTok Shop 创作者账号在指定时间范围内的表现概览,包括收益、曝光、点击、成交等多维度数据。
|
|
157
|
+
> - 默认统计从 `start_date` 当月起 1 个自然月(如传入 2025-04-01,则统计整个 4 月的数据)。
|
|
158
|
+
>
|
|
159
|
+
> ### 备注:
|
|
160
|
+
> - 此接口仅适用于已开通 TikTok Shop 功能的创作者账号。
|
|
161
|
+
> - 数据按照时间粒度进行分段统计,可用于数据分析和趋势观察。
|
|
162
|
+
>
|
|
163
|
+
> ### 参数:
|
|
164
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
165
|
+
> - start_date: 查询开始时间,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
166
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
167
|
+
> - 示例格式: `http://username:password@host:port`
|
|
168
|
+
>
|
|
169
|
+
> ### 返回:
|
|
170
|
+
> - `segments`(分段数据列表):
|
|
171
|
+
> - `time_selector`: 当前统计段的时间设置,包括周期、起止时间戳、时区、语言等
|
|
172
|
+
> - `timed_stats`: 每天/每段的详细数据,包含以下字段:
|
|
173
|
+
> - `live_revenue.amount`: 直播带货收益
|
|
174
|
+
> - `video_revenue.amount`: 视频带货收益
|
|
175
|
+
> - `revenue.amount`: 总收益(直播 + 视频)
|
|
176
|
+
> - `base_revenue.amount`: 基础收益
|
|
177
|
+
> - `commission_estimated.amount`: 预估佣金
|
|
178
|
+
> - `alc_base_revenue.amount`: ALC 模式下基础收益
|
|
179
|
+
> - `overall_item_sold_cnt`: 商品成交数
|
|
180
|
+
> - `product_show_cnt`: 商品展示次数
|
|
181
|
+
> - `product_click_cnt`: 商品点击次数
|
|
182
|
+
> - `alc_pay_sku_order_cnt`: ALC 成交订单数
|
|
183
|
+
> - `meta.is_bound_shop`: 是否绑定 TikTok 店铺
|
|
184
|
+
>
|
|
185
|
+
> # [English]
|
|
186
|
+
> ### Purpose:
|
|
187
|
+
> - Retrieve performance overview of a TikTok Shop creator account within a specified date range, including metrics like revenue, exposure, clicks, and orders.
|
|
188
|
+
> - By default, it aggregates data from the month of `start_date` (e.g., if `start_date` is 2025-04-01, it retrieves data for the entire month of April).
|
|
189
|
+
>
|
|
190
|
+
> ### Notes:
|
|
191
|
+
> - This API is only applicable to TikTok accounts that have TikTok Shop enabled.
|
|
192
|
+
> - Data is segmented by time granularity (daily/monthly), and can be used for performance analysis or trend monitoring.
|
|
193
|
+
>
|
|
194
|
+
> ### Parameters:
|
|
195
|
+
> - cookie: User cookie string for authentication
|
|
196
|
+
> - start_date: Query start date in 'MM-DD-YYYY' format, e.g. '04-01-2025'
|
|
197
|
+
> - proxy: Optional HTTP proxy address. Leave empty if not needed.
|
|
198
|
+
> - Example format: `http://username:password@host:port`
|
|
199
|
+
>
|
|
200
|
+
> ### Response:
|
|
201
|
+
> - `segments`: List of data segments, each containing:
|
|
202
|
+
> - `time_selector`: Time settings for the segment, including period, timestamp range, timezone, and locale
|
|
203
|
+
> - `timed_stats`: Daily or interval-based statistics, including:
|
|
204
|
+
> - `live_revenue.amount`: Revenue from livestream sales
|
|
205
|
+
> - `video_revenue.amount`: Revenue from video sales
|
|
206
|
+
> - `revenue.amount`: Total revenue (live + video)
|
|
207
|
+
> - `base_revenue.amount`: Base revenue
|
|
208
|
+
> - `commission_estimated.amount`: Estimated commission
|
|
209
|
+
> - `alc_base_revenue.amount`: Base revenue under ALC model
|
|
210
|
+
> - `overall_item_sold_cnt`: Total items sold
|
|
211
|
+
> - `product_show_cnt`: Product exposure count
|
|
212
|
+
> - `product_click_cnt`: Product click count
|
|
213
|
+
> - `alc_pay_sku_order_cnt`: Orders under ALC model
|
|
214
|
+
> - `meta.is_bound_shop`: Whether the TikTok account is bound to a shop
|
|
215
|
+
|
|
216
|
+
#### Parameters
|
|
217
|
+
|
|
218
|
+
None
|
|
219
|
+
|
|
220
|
+
#### Request Body
|
|
221
|
+
|
|
222
|
+
- required: Yes
|
|
223
|
+
|
|
224
|
+
##### `application/json`
|
|
225
|
+
|
|
226
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string
|
|
227
|
+
|
|
228
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
229
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
230
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
231
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
232
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
233
|
+
|
|
234
|
+
#### Success Response
|
|
235
|
+
|
|
236
|
+
##### `200 application/json`
|
|
237
|
+
|
|
238
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
239
|
+
|
|
240
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
241
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
242
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
243
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
244
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
245
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
246
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
247
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
248
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
249
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
250
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
251
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
252
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
253
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
254
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
255
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
256
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
257
|
+
|
|
258
|
+
<a id="post-api-u1-v1-tiktok-creator-get-account-violation-list"></a>
|
|
259
|
+
### `POST /api/u1/v1/tiktok/creator/get_account_violation_list`
|
|
260
|
+
|
|
261
|
+
- Summary: 获取创作者账号违规记录列表/Get Creator Account Violation Record List
|
|
262
|
+
- Capabilities: creators
|
|
263
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
264
|
+
- operationId: `get_account_violation_list_api_v1_tiktok_creator_get_account_violation_list_post`
|
|
265
|
+
|
|
266
|
+
#### Notes
|
|
267
|
+
|
|
268
|
+
> # [中文]
|
|
269
|
+
> ### 用途:
|
|
270
|
+
> - 获取 TikTok Shop 创作者账号的违规记录信息,用于了解账号在运营期间的违规历史和处理情况。
|
|
271
|
+
> - 返回的违规记录包含违规类型、违规时间、违规原因、违规处理措施、申诉状态、是否可申诉等信息。
|
|
272
|
+
> - 支持分页查询,可按时间顺序获取多条违规记录。
|
|
273
|
+
> - 适用于创作者账号违规风险管理、账号健康监控和数据合规审计。
|
|
274
|
+
>
|
|
275
|
+
> ### 备注:
|
|
276
|
+
> - 此接口仅适用于 TikTok Shop 创作者账号。
|
|
277
|
+
> - 支持分页查询,每次默认返回最新的违规记录。
|
|
278
|
+
>
|
|
279
|
+
> ### 参数:
|
|
280
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
281
|
+
> - page: 整数类型,页码,默认为第 1 页
|
|
282
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
283
|
+
> - 示例格式: `http://username:password@host:port`
|
|
284
|
+
>
|
|
285
|
+
> ### 返回:
|
|
286
|
+
> - `records`(违规记录列表):
|
|
287
|
+
> - `record_id`: 违规记录 ID
|
|
288
|
+
> - `violation_time`: 违规发生时间(Unix 时间戳)
|
|
289
|
+
> - `violation_info`:
|
|
290
|
+
> - `violation_reason`: 违规原因描述
|
|
291
|
+
> - `violation_detail`: 违规详情描述
|
|
292
|
+
> - `violation_suggestion`: 平台提供的整改建议
|
|
293
|
+
> - `policy_url`: 相关政策链接
|
|
294
|
+
> - `violation_type`: 违规类别(如视频违规)
|
|
295
|
+
> - `record_status`: 记录状态(1 表示有效)
|
|
296
|
+
> - `appeal_status`: 申诉状态(0=未申诉,1=已申诉)
|
|
297
|
+
> - `enforcement_title`: 平台针对违规采取的执行措施描述(例如扣分、佣金冻结等)
|
|
298
|
+
> - `appeal_valid_time`: 申诉有效截止时间(Unix 时间戳)
|
|
299
|
+
> - `can_appeal`: 是否允许发起申诉(布尔值)
|
|
300
|
+
> - `total`: 总违规记录数
|
|
301
|
+
> - `has_more`: 是否还有更多数据
|
|
302
|
+
> - `start_time`: 查询起始时间
|
|
303
|
+
> - `end_time`: 查询结束时间
|
|
304
|
+
> - `creator_status`: 创作者账号状态码(如 0=正常)
|
|
305
|
+
>
|
|
306
|
+
> # [English]
|
|
307
|
+
> ### Purpose:
|
|
308
|
+
> - Retrieve the violation history of a TikTok Shop creator account, providing details about past violations and corresponding enforcement actions.
|
|
309
|
+
> - The returned violation records include violation type, violation time, violation reasons, enforcement actions, appeal status, and eligibility for appeal.
|
|
310
|
+
> - Pagination is supported to retrieve multiple records in chronological order.
|
|
311
|
+
> - Suitable for creator account risk management, health monitoring, and compliance auditing.
|
|
312
|
+
>
|
|
313
|
+
> ### Notes:
|
|
314
|
+
> - This API is available only for TikTok Shop creator accounts.
|
|
315
|
+
> - Pagination is supported; by default, it retrieves the latest violation records.
|
|
316
|
+
>
|
|
317
|
+
> ### Parameters:
|
|
318
|
+
> - cookie: User's Cookie string for authentication
|
|
319
|
+
> - page: Integer, page number (default is `1`)
|
|
320
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not needed
|
|
321
|
+
> - Example format: `http://username:password@host:port`
|
|
322
|
+
>
|
|
323
|
+
> ### Response:
|
|
324
|
+
> - `records`: List of violation records:
|
|
325
|
+
> - `record_id`: Unique ID of the violation record
|
|
326
|
+
> - `violation_time`: Time when the violation occurred (Unix timestamp)
|
|
327
|
+
> - `violation_info`:
|
|
328
|
+
> - `violation_reason`: Reason for the violation
|
|
329
|
+
> - `violation_detail`: Detailed description (may be empty)
|
|
330
|
+
> - `violation_suggestion`: Recommended corrective action
|
|
331
|
+
> - `policy_url`: Link to the related policy
|
|
332
|
+
> - `violation_type`: Type of violation (e.g., Video violation)
|
|
333
|
+
> - `record_status`: Record status (1 = active)
|
|
334
|
+
> - `appeal_status`: Appeal status (0 = not appealed, 1 = appealed)
|
|
335
|
+
> - `enforcement_title`: List of enforcement actions taken (e.g., point assignment, commission withholding)
|
|
336
|
+
> - `appeal_valid_time`: Deadline for submitting an appeal (Unix timestamp)
|
|
337
|
+
> - `can_appeal`: Whether the record is eligible for appeal (boolean)
|
|
338
|
+
> - `total`: Total number of violation records
|
|
339
|
+
> - `has_more`: Whether there are more records to fetch
|
|
340
|
+
> - `start_time`: Query start time
|
|
341
|
+
> - `end_time`: Query end time
|
|
342
|
+
> - `creator_status`: Creator account status code (e.g., 0 = normal)
|
|
343
|
+
>
|
|
344
|
+
> # [示例/Example]
|
|
345
|
+
> ```json
|
|
346
|
+
> {
|
|
347
|
+
> "cookie": "your_cookie_here",
|
|
348
|
+
> "page": 1
|
|
349
|
+
> }
|
|
350
|
+
> ```
|
|
351
|
+
|
|
352
|
+
#### Parameters
|
|
353
|
+
|
|
354
|
+
None
|
|
355
|
+
|
|
356
|
+
#### Request Body
|
|
357
|
+
|
|
358
|
+
- required: Yes
|
|
359
|
+
|
|
360
|
+
##### `application/json`
|
|
361
|
+
|
|
362
|
+
- Schema summary: `cookie`:string, `proxy`:string, `page`:integer
|
|
363
|
+
|
|
364
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
365
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
366
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
367
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
368
|
+
| page | integer | No | 页码/Page Number | 1 | None | None |
|
|
369
|
+
|
|
370
|
+
#### Success Response
|
|
371
|
+
|
|
372
|
+
##### `200 application/json`
|
|
373
|
+
|
|
374
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
375
|
+
|
|
376
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
377
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
378
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
379
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
380
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
381
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
382
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
383
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
384
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
385
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
386
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
387
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
388
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
389
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
390
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
391
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
392
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
393
|
+
|
|
394
|
+
<a id="post-api-u1-v1-tiktok-creator-get-creator-account-info"></a>
|
|
395
|
+
### `POST /api/u1/v1/tiktok/creator/get_creator_account_info`
|
|
396
|
+
|
|
397
|
+
- Summary: 获取创作者账号信息/Get Creator Account Info
|
|
398
|
+
- Capabilities: creators
|
|
399
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
400
|
+
- operationId: `get_creator_account_info_api_v1_tiktok_creator_get_creator_account_info_post`
|
|
401
|
+
|
|
402
|
+
#### Notes
|
|
403
|
+
|
|
404
|
+
> # [中文]
|
|
405
|
+
> ### 用途:
|
|
406
|
+
> - 获取 TikTok Shop 创作者账号的基础信息,包括用户名、头像链接、账号ID、注册地区、绑定合作伙伴信息、权限列表等。
|
|
407
|
+
> - 可用于账号状态验证、账号信息展示、合作关系检查及后续业务逻辑处理。
|
|
408
|
+
>
|
|
409
|
+
> ### 备注:
|
|
410
|
+
> - 适用于所有 TikTok 创作者账号。
|
|
411
|
+
>
|
|
412
|
+
> ### 参数:
|
|
413
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
414
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
415
|
+
> - 示例格式: `http://username:password@host:port`
|
|
416
|
+
>
|
|
417
|
+
> ### 返回内容说明:
|
|
418
|
+
> - `user_id`: 用户ID(字符串)
|
|
419
|
+
> - `user_type`: 用户类型(数字,代表账号类型)
|
|
420
|
+
> - `register_region_id`: 注册地区代码(如 "us")
|
|
421
|
+
> - `user_name`: 用户名
|
|
422
|
+
> - `avatar`: 头像信息对象
|
|
423
|
+
> - `uri`: 头像资源URI
|
|
424
|
+
> - `url_list`: 头像图片URL列表
|
|
425
|
+
> - `permission_list`: 权限列表(整数数组)
|
|
426
|
+
> - `partner_id`: 合作伙伴ID
|
|
427
|
+
> - `partner_name`: 合作伙伴名称
|
|
428
|
+
> - `shop_account_official`: 是否为官方认证店铺账号(布尔值)
|
|
429
|
+
> - `switch_info`: 功能开关信息(如直播功能开关,字符串格式)
|
|
430
|
+
> - `tt_uid`: TikTok UID(字符串)
|
|
431
|
+
> - `nick_name`: 昵称
|
|
432
|
+
> - `live_streamer_menu_experiment`: 直播菜单实验字段(字符串,可能为空)
|
|
433
|
+
> - `experiment_variants`: 实验变种配置(对象)
|
|
434
|
+
>
|
|
435
|
+
> # [English]
|
|
436
|
+
> ### Purpose:
|
|
437
|
+
> - Retrieve basic information of a TikTok Shop creator account, including username, avatar URLs, account ID, register region, partner binding info, and permission list.
|
|
438
|
+
> - Useful for verifying account status, displaying user profile data, checking partner binding status, and determining access permissions for business processes.
|
|
439
|
+
>
|
|
440
|
+
> ### Notes:
|
|
441
|
+
> - Applicable to all TikTok creator accounts.
|
|
442
|
+
>
|
|
443
|
+
> ### Parameters:
|
|
444
|
+
> - cookie: User Cookie string for authentication
|
|
445
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not used
|
|
446
|
+
> - Example format: `http://username:password@host:port`
|
|
447
|
+
>
|
|
448
|
+
> ### Return Content Description:
|
|
449
|
+
> - `user_id`: User ID (string)
|
|
450
|
+
> - `user_type`: User type (integer, indicates account type)
|
|
451
|
+
> - `register_region_id`: Registered region code (e.g., "us")
|
|
452
|
+
> - `user_name`: Username
|
|
453
|
+
> - `avatar`: Avatar info object
|
|
454
|
+
> - `uri`: Avatar resource URI
|
|
455
|
+
> - `url_list`: List of avatar image URLs
|
|
456
|
+
> - `permission_list`: Permission list (list of integers)
|
|
457
|
+
> - `partner_id`: Partner ID
|
|
458
|
+
> - `partner_name`: Partner name
|
|
459
|
+
> - `shop_account_official`: Whether it's an official shop account (boolean)
|
|
460
|
+
> - `switch_info`: Feature switch info (e.g., live event switch, string format)
|
|
461
|
+
> - `tt_uid`: TikTok UID (string)
|
|
462
|
+
> - `nick_name`: Nickname
|
|
463
|
+
> - `live_streamer_menu_experiment`: Live streamer menu experiment field (string, may be empty)
|
|
464
|
+
> - `experiment_variants`: Experiment variant configurations (object)
|
|
465
|
+
>
|
|
466
|
+
> # [示例/Example]
|
|
467
|
+
> ```json
|
|
468
|
+
> {
|
|
469
|
+
> "cookie": "your_cookie"
|
|
470
|
+
> }
|
|
471
|
+
> ```
|
|
472
|
+
|
|
473
|
+
#### Parameters
|
|
474
|
+
|
|
475
|
+
None
|
|
476
|
+
|
|
477
|
+
#### Request Body
|
|
478
|
+
|
|
479
|
+
- required: Yes
|
|
480
|
+
|
|
481
|
+
##### `application/json`
|
|
482
|
+
|
|
483
|
+
- Schema summary: `cookie`:string, `proxy`:string
|
|
484
|
+
|
|
485
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
486
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
487
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
488
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
489
|
+
|
|
490
|
+
#### Success Response
|
|
491
|
+
|
|
492
|
+
##### `200 application/json`
|
|
493
|
+
|
|
494
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
495
|
+
|
|
496
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
497
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
498
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
499
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
500
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
501
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
502
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
503
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
504
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
505
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
506
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
507
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
508
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
509
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
510
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
511
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
512
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
513
|
+
|
|
514
|
+
<a id="post-api-u1-v1-tiktok-creator-get-live-analytics-summary"></a>
|
|
515
|
+
### `POST /api/u1/v1/tiktok/creator/get_live_analytics_summary`
|
|
516
|
+
|
|
517
|
+
- Summary: 获取创作者直播概览/Get Creator Live Overview
|
|
518
|
+
- Capabilities: creators / analytics / livestream
|
|
519
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
520
|
+
- operationId: `get_live_overview_api_v1_tiktok_creator_get_live_analytics_summary_post`
|
|
521
|
+
|
|
522
|
+
#### Notes
|
|
523
|
+
|
|
524
|
+
> # [中文]
|
|
525
|
+
> ### 用途:
|
|
526
|
+
> - 获取 TikTok Shop 创作者账号在指定时间范围内的直播表现数据概览。
|
|
527
|
+
> - 默认统计从 `start_date` 当月起 1 个自然月(如传入 2025-04-01,则统计整个 4 月的数据)。
|
|
528
|
+
>
|
|
529
|
+
> ### 返回内容说明:
|
|
530
|
+
> - `segments`(分段数据列表):
|
|
531
|
+
> - `time_selector`: 时间范围设置(周期、起止时间戳、时区、语言)
|
|
532
|
+
> - `filter.creator_id`: 创作者 ID
|
|
533
|
+
> - `timed_stats`: 每个时间段(通常按日或月分段)的直播表现数据,包含:
|
|
534
|
+
> - `live_revenue.amount`: 直播带货收入
|
|
535
|
+
> - `live_show_gpm.amount`: 直播场均带货收入
|
|
536
|
+
> - `new_follower_cnt`: 新增粉丝数量
|
|
537
|
+
> - `sku_order_paid_cnt`: 已付款 SKU 数量
|
|
538
|
+
> - `item_sold_cnt`: 成交商品件数
|
|
539
|
+
> - `product_view`: 商品曝光次数(浏览量)
|
|
540
|
+
> - `product_click`: 商品点击次数
|
|
541
|
+
> - `live_pay_order_ucnt`: 直播支付订单人数
|
|
542
|
+
> - `live_ctr`: 直播点击率(Click-Through Rate)
|
|
543
|
+
> - `live_co`: 直播转化率(Conversion Rate)
|
|
544
|
+
> - `live_like_cnt`: 直播点赞次数
|
|
545
|
+
> - `live_comment_cnt`: 直播评论次数
|
|
546
|
+
> - `live_show_cnt`: 直播场次
|
|
547
|
+
> - `live_watch_cnt`: 直播观看人数
|
|
548
|
+
>
|
|
549
|
+
> ### 备注:
|
|
550
|
+
> - 此接口仅适用于 TikTok Shop 创作者账号。
|
|
551
|
+
> - 直播期间数据按自然日拆分。
|
|
552
|
+
>
|
|
553
|
+
> ### 参数:
|
|
554
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
555
|
+
> - start_date: 查询开始时间(格式 `MM-DD-YYYY`),如 `04-01-2025`
|
|
556
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
557
|
+
> - 示例格式: `http://username:password@host:port`
|
|
558
|
+
>
|
|
559
|
+
> ### 返回:
|
|
560
|
+
> - 创作者账号直播数据概览
|
|
561
|
+
>
|
|
562
|
+
> # [English]
|
|
563
|
+
> ### Purpose:
|
|
564
|
+
> - Retrieve a summary of live streaming performance for a TikTok Shop creator account within a specified time range.
|
|
565
|
+
> - By default, it covers one full calendar month starting from the provided `start_date` (e.g., input `04-01-2025` will fetch data for the entire April 2025).
|
|
566
|
+
>
|
|
567
|
+
> ### Response Fields:
|
|
568
|
+
> - `segments` (List of segmented data):
|
|
569
|
+
> - `time_selector`: Time period settings (period, start/end timestamps, timezone, locale)
|
|
570
|
+
> - `filter.creator_id`: Creator ID
|
|
571
|
+
> - `timed_stats`: Live performance statistics per time segment, including:
|
|
572
|
+
> - `live_revenue.amount`: Live streaming revenue
|
|
573
|
+
> - `live_show_gpm.amount`: Average revenue per live show
|
|
574
|
+
> - `new_follower_cnt`: Number of new followers
|
|
575
|
+
> - `sku_order_paid_cnt`: Number of SKUs paid
|
|
576
|
+
> - `item_sold_cnt`: Number of items sold
|
|
577
|
+
> - `product_view`: Number of product views
|
|
578
|
+
> - `product_click`: Number of product clicks
|
|
579
|
+
> - `live_pay_order_ucnt`: Number of unique users who placed live orders
|
|
580
|
+
> - `live_ctr`: Live Click-Through Rate (CTR)
|
|
581
|
+
> - `live_co`: Live Conversion Rate (CO)
|
|
582
|
+
> - `live_like_cnt`: Number of live likes
|
|
583
|
+
> - `live_comment_cnt`: Number of live comments
|
|
584
|
+
> - `live_show_cnt`: Number of live sessions
|
|
585
|
+
> - `live_watch_cnt`: Number of live viewers
|
|
586
|
+
>
|
|
587
|
+
> ### Notes:
|
|
588
|
+
> - This API is only applicable to TikTok Shop creator accounts.
|
|
589
|
+
> - Data is split by natural days during the live sessions.
|
|
590
|
+
>
|
|
591
|
+
> ### Parameters:
|
|
592
|
+
> - cookie: User Cookie string for authentication
|
|
593
|
+
> - start_date: Query start date in the format `MM-DD-YYYY`, e.g., `04-01-2025`
|
|
594
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not used
|
|
595
|
+
> - Example format: `http://username:password@host:port`
|
|
596
|
+
>
|
|
597
|
+
> ### Return:
|
|
598
|
+
> - Creator live streaming performance overview
|
|
599
|
+
>
|
|
600
|
+
> # [示例/Example]
|
|
601
|
+
> ```json
|
|
602
|
+
> {
|
|
603
|
+
> "cookie": "your_cookie",
|
|
604
|
+
> "start_date": "04-01-2025"
|
|
605
|
+
> }
|
|
606
|
+
> ```
|
|
607
|
+
|
|
608
|
+
#### Parameters
|
|
609
|
+
|
|
610
|
+
None
|
|
611
|
+
|
|
612
|
+
#### Request Body
|
|
613
|
+
|
|
614
|
+
- required: Yes
|
|
615
|
+
|
|
616
|
+
##### `application/json`
|
|
617
|
+
|
|
618
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string
|
|
619
|
+
|
|
620
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
621
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
622
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
623
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
624
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
625
|
+
|
|
626
|
+
#### Success Response
|
|
627
|
+
|
|
628
|
+
##### `200 application/json`
|
|
629
|
+
|
|
630
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
631
|
+
|
|
632
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
633
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
634
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
635
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
636
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
637
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
638
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
639
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
640
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
641
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
642
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
643
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
644
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
645
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
646
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
647
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
648
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
649
|
+
|
|
650
|
+
<a id="post-api-u1-v1-tiktok-creator-get-product-analytics-list"></a>
|
|
651
|
+
### `POST /api/u1/v1/tiktok/creator/get_product_analytics_list`
|
|
652
|
+
|
|
653
|
+
- Summary: 获取创作者商品列表分析/Get Creator Product List Analytics
|
|
654
|
+
- Capabilities: creators / commerce / analytics
|
|
655
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
656
|
+
- operationId: `get_product_analytics_list_api_v1_tiktok_creator_get_product_analytics_list_post`
|
|
657
|
+
|
|
658
|
+
#### Notes
|
|
659
|
+
|
|
660
|
+
> # [中文]
|
|
661
|
+
> ### 用途:
|
|
662
|
+
> - 获取 TikTok Shop 创作者账号在指定时间范围内推广的商品列表及其销售数据分析。
|
|
663
|
+
> - 支持按商品成交额、商品上架时间排序,可分页查询。
|
|
664
|
+
>
|
|
665
|
+
> ### 返回内容说明:
|
|
666
|
+
> - `segments`(分段数据列表):
|
|
667
|
+
> - `filter.creator_id`: 创作者账号 ID
|
|
668
|
+
> - `list_control`:
|
|
669
|
+
> - `rules`: 列表排序规则(如按成交额、商品 ID 排序)
|
|
670
|
+
> - `next_pagination`: 翻页信息(是否还有更多页、下一页页码、总页数、总记录数)
|
|
671
|
+
> - `timed_lists`: 每个时间段内的商品数据,包括:
|
|
672
|
+
> - `product`:
|
|
673
|
+
> - `id`: 商品 ID
|
|
674
|
+
> - `name`: 商品标题
|
|
675
|
+
> - `cover_image.thumb_url_list`: 商品封面图列表
|
|
676
|
+
> - `item_sold_cnt`: 销售商品数量
|
|
677
|
+
> - `revenue.amount`: 该商品带来的总成交金额(GMV)
|
|
678
|
+
> - `commission.amount`: 该商品预估佣金收入
|
|
679
|
+
>
|
|
680
|
+
> ### 备注:
|
|
681
|
+
> - 此接口仅适用于 TikTok Shop 创作者账号。
|
|
682
|
+
> - 数据以自然月或自定义时间范围统计。
|
|
683
|
+
> - 默认排序为成交额(GMV)从高到低。
|
|
684
|
+
>
|
|
685
|
+
> ### 参数:
|
|
686
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
687
|
+
> - start_date: 开始日期,格式为 'YYYY-MM-DD',如 '2025-04-01'
|
|
688
|
+
> - end_date: 结束日期,格式为 'YYYY-MM-DD',如 '2025-05-01'
|
|
689
|
+
> - page: 页码,默认为第一页 `0`
|
|
690
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
691
|
+
> - 示例格式: `http://username:password@host:port`
|
|
692
|
+
>
|
|
693
|
+
> ### 返回:
|
|
694
|
+
> - 创作者账号商品列表及商品销售分析数据
|
|
695
|
+
>
|
|
696
|
+
> # [English]
|
|
697
|
+
> ### Purpose:
|
|
698
|
+
> - Retrieve the list of products promoted by a TikTok Shop creator account within a specified time range, along with their sales analytics.
|
|
699
|
+
> - Supports sorting by revenue or product publish time and allows pagination.
|
|
700
|
+
>
|
|
701
|
+
> ### Response Fields:
|
|
702
|
+
> - `segments` (List of segmented data):
|
|
703
|
+
> - `filter.creator_id`: Creator account ID
|
|
704
|
+
> - `list_control`:
|
|
705
|
+
> - `rules`: Sorting rules (e.g., by revenue, by product ID)
|
|
706
|
+
> - `next_pagination`: Pagination info (has more pages, next page number, total pages, total records)
|
|
707
|
+
> - `timed_lists`: List of product statistics within each time range, including:
|
|
708
|
+
> - `product`:
|
|
709
|
+
> - `id`: Product ID
|
|
710
|
+
> - `name`: Product title
|
|
711
|
+
> - `cover_image.thumb_url_list`: List of product thumbnail URLs
|
|
712
|
+
> - `item_sold_cnt`: Number of items sold
|
|
713
|
+
> - `revenue.amount`: Total Gross Merchandise Value (GMV) generated by the product
|
|
714
|
+
> - `commission.amount`: Estimated commission income from the product
|
|
715
|
+
>
|
|
716
|
+
> ### Notes:
|
|
717
|
+
> - This API is only available for TikTok Shop creator accounts.
|
|
718
|
+
> - Data is aggregated by natural month or the customized date range.
|
|
719
|
+
> - Default sorting is by GMV in descending order.
|
|
720
|
+
>
|
|
721
|
+
> ### Parameters:
|
|
722
|
+
> - cookie: User Cookie string for authentication
|
|
723
|
+
> - start_date: Start date, formatted as 'YYYY-MM-DD', e.g., '2025-04-01'
|
|
724
|
+
> - end_date: End date, formatted as 'YYYY-MM-DD', e.g., '2025-05-01'
|
|
725
|
+
> - page: Page number, default is the first page `0`
|
|
726
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not used
|
|
727
|
+
> - Example format: `http://username:password@host:port`
|
|
728
|
+
>
|
|
729
|
+
> ### Return:
|
|
730
|
+
> - Creator product list and corresponding sales analytics data
|
|
731
|
+
>
|
|
732
|
+
> # [示例/Example]
|
|
733
|
+
> ```json
|
|
734
|
+
> {
|
|
735
|
+
> "cookie": "your_cookie",
|
|
736
|
+
> "start_date": "2025-04-01",
|
|
737
|
+
> "end_date": "2025-05-01",
|
|
738
|
+
> "page": 0
|
|
739
|
+
> }
|
|
740
|
+
> ```
|
|
741
|
+
|
|
742
|
+
#### Parameters
|
|
743
|
+
|
|
744
|
+
None
|
|
745
|
+
|
|
746
|
+
#### Request Body
|
|
747
|
+
|
|
748
|
+
- required: Yes
|
|
749
|
+
|
|
750
|
+
##### `application/json`
|
|
751
|
+
|
|
752
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `end_date`:string, `page`:integer
|
|
753
|
+
|
|
754
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
755
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
756
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
757
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
758
|
+
| start_date | string | No | 开始日期,如 '2025-04-01'/ Start Date, e.g. '2025-04-01' | 2025-04-01 | None | None |
|
|
759
|
+
| end_date | string | No | 结束日期,如 '2025-05-01'/ End Date, e.g. '2025-05-01' | 2025-05-01 | None | None |
|
|
760
|
+
| page | integer | No | 页码/Page Number | 0 | None | None |
|
|
761
|
+
|
|
762
|
+
#### Success Response
|
|
763
|
+
|
|
764
|
+
##### `200 application/json`
|
|
765
|
+
|
|
766
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
767
|
+
|
|
768
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
769
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
770
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
771
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
772
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
773
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
774
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
775
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
776
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
777
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
778
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
779
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
780
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
781
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
782
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
783
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
784
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
785
|
+
|
|
786
|
+
<a id="post-api-u1-v1-tiktok-creator-get-product-related-videos"></a>
|
|
787
|
+
### `POST /api/u1/v1/tiktok/creator/get_product_related_videos`
|
|
788
|
+
|
|
789
|
+
- Summary: 获取同款商品关联视频/Get Product Related Videos
|
|
790
|
+
- Capabilities: creators / content details / commerce
|
|
791
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
792
|
+
- operationId: `get_product_related_videos_api_v1_tiktok_creator_get_product_related_videos_post`
|
|
793
|
+
|
|
794
|
+
#### Notes
|
|
795
|
+
|
|
796
|
+
> # [中文]
|
|
797
|
+
> ### 用途:
|
|
798
|
+
> - 获取与指定商品关联的所有视频列表和对应的互动数据(如点赞数、评论数、分享数)。
|
|
799
|
+
> - 可用于分析同款商品在不同创作者视频中的推广效果和差异。
|
|
800
|
+
> - 支持按时间筛选,默认查询指定 start_date 所在自然月内的数据。
|
|
801
|
+
>
|
|
802
|
+
> ### 备注:
|
|
803
|
+
> - 必须同时提供 item_id(当前视频 ID)和 product_id(商品 ID)。
|
|
804
|
+
> - 返回数据按时间范围查询,同一商品下的其他视频列表。
|
|
805
|
+
>
|
|
806
|
+
> ### 参数:
|
|
807
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
808
|
+
> - start_date: 查询起始日期,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
809
|
+
> - item_id: 当前视频 ID,例如 "7496499484705246507"
|
|
810
|
+
> - product_id: 商品 ID,例如 "1731050202505515549"
|
|
811
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
812
|
+
> - 示例格式: `http://username:password@host:port`
|
|
813
|
+
>
|
|
814
|
+
> ### 返回内容说明:
|
|
815
|
+
> - `segments`(数据分段列表):
|
|
816
|
+
> - `time_selector`: 时间筛选参数(period, granularity, start_timestamp, end_timestamp)
|
|
817
|
+
> - `filter`: 查询条件(creator_id, product_id, item_id)
|
|
818
|
+
> - `timed_lists`: 视频列表
|
|
819
|
+
> - `start_timestamp`: 开始时间戳
|
|
820
|
+
> - `end_timestamp`: 结束时间戳
|
|
821
|
+
> - `stats`:
|
|
822
|
+
> - `video_product_id`: 商品 ID
|
|
823
|
+
> - `video`:
|
|
824
|
+
> - `item_id`: 视频 ID
|
|
825
|
+
> - `video_id`: 视频内部唯一 ID
|
|
826
|
+
> - `name`: 视频文案标题
|
|
827
|
+
> - `publish_time`: 发布时间戳
|
|
828
|
+
> - `duration`: 视频时长(秒)
|
|
829
|
+
> - `video_play_info`:
|
|
830
|
+
> - `post_url`: 视频封面图片链接
|
|
831
|
+
> - `video_infos.main_url`: 视频播放地址
|
|
832
|
+
> - `video_like_cnt`: 视频点赞数
|
|
833
|
+
> - `video_comment_cnt`: 视频评论数
|
|
834
|
+
> - `video_share_cnt`: 视频分享数
|
|
835
|
+
>
|
|
836
|
+
> ### 示例请求体:
|
|
837
|
+
> ```json
|
|
838
|
+
> {
|
|
839
|
+
> "cookie": "your_cookie",
|
|
840
|
+
> "start_date": "04-01-2025",
|
|
841
|
+
> "item_id": "7496499484705246507",
|
|
842
|
+
> "product_id": "1731050202505515549"
|
|
843
|
+
> }
|
|
844
|
+
> ```
|
|
845
|
+
>
|
|
846
|
+
> # [English]
|
|
847
|
+
> ### Purpose:
|
|
848
|
+
> - Retrieve the list of all videos associated with a specified product along with their interaction metrics (such as like count, comment count, share count).
|
|
849
|
+
> - Useful for analyzing the promotional effectiveness and differences of the same product across different creators' videos.
|
|
850
|
+
> - Supports time-based filtering, defaulting to the calendar month of the specified start_date.
|
|
851
|
+
>
|
|
852
|
+
> ### Notes:
|
|
853
|
+
> - Requires both item_id (current video ID) and product_id (product ID).
|
|
854
|
+
> - Returns a list of other videos where the same product is featured.
|
|
855
|
+
>
|
|
856
|
+
> ### Return Description:
|
|
857
|
+
> - `segments`:
|
|
858
|
+
> - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)
|
|
859
|
+
> - `filter`: Query conditions (creator_id, product_id, item_id)
|
|
860
|
+
> - `timed_lists`: List of related videos
|
|
861
|
+
> - `start_timestamp`: Start timestamp
|
|
862
|
+
> - `end_timestamp`: End timestamp
|
|
863
|
+
> - `stats`:
|
|
864
|
+
> - `video_product_id`: Product ID
|
|
865
|
+
> - `video`:
|
|
866
|
+
> - `item_id`: Video ID
|
|
867
|
+
> - `video_id`: Video internal ID
|
|
868
|
+
> - `name`: Video caption/title
|
|
869
|
+
> - `publish_time`: Publish timestamp
|
|
870
|
+
> - `duration`: Video duration (seconds)
|
|
871
|
+
> - `video_play_info`:
|
|
872
|
+
> - `post_url`: Video cover image link
|
|
873
|
+
> - `video_infos.main_url`: Main video URL
|
|
874
|
+
> - `video_like_cnt`: Like count
|
|
875
|
+
> - `video_comment_cnt`: Comment count
|
|
876
|
+
> - `video_share_cnt`: Share count
|
|
877
|
+
>
|
|
878
|
+
> ### Example Request Body:
|
|
879
|
+
> ```json
|
|
880
|
+
> {
|
|
881
|
+
> "cookie": "your_cookie",
|
|
882
|
+
> "start_date": "04-01-2025",
|
|
883
|
+
> "item_id": "7496499484705246507",
|
|
884
|
+
> "product_id": "1731050202505515549"
|
|
885
|
+
> }
|
|
886
|
+
> ```
|
|
887
|
+
|
|
888
|
+
#### Parameters
|
|
889
|
+
|
|
890
|
+
None
|
|
891
|
+
|
|
892
|
+
#### Request Body
|
|
893
|
+
|
|
894
|
+
- required: Yes
|
|
895
|
+
|
|
896
|
+
##### `application/json`
|
|
897
|
+
|
|
898
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `item_id*`:string, `product_id*`:string
|
|
899
|
+
|
|
900
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
901
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
902
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
903
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
904
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
905
|
+
| item_id | string | Yes | 视频 ID/Video ID | None | None | None |
|
|
906
|
+
| product_id | string | Yes | 商品 ID/Product ID | None | None | None |
|
|
907
|
+
|
|
908
|
+
#### Success Response
|
|
909
|
+
|
|
910
|
+
##### `200 application/json`
|
|
911
|
+
|
|
912
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
913
|
+
|
|
914
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
915
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
916
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
917
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
918
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
919
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
920
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
921
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
922
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
923
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
924
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
925
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
926
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
927
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
928
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
929
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
930
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
931
|
+
|
|
932
|
+
<a id="post-api-u1-v1-tiktok-creator-get-showcase-product-list"></a>
|
|
933
|
+
### `POST /api/u1/v1/tiktok/creator/get_showcase_product_list`
|
|
934
|
+
|
|
935
|
+
- Summary: 获取橱窗商品列表/Get Showcase Product List
|
|
936
|
+
- Capabilities: creators / commerce
|
|
937
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
938
|
+
- operationId: `get_showcase_product_list_api_v1_tiktok_creator_get_showcase_product_list_post`
|
|
939
|
+
|
|
940
|
+
#### Notes
|
|
941
|
+
|
|
942
|
+
> # [中文]
|
|
943
|
+
> ### 用途:
|
|
944
|
+
> - 获取 TikTok Shop 创作者账号橱窗中正在展示的商品列表。
|
|
945
|
+
> - 可用于商品管理、数据分析、查看当前推广商品等场景。
|
|
946
|
+
>
|
|
947
|
+
> ### 备注:
|
|
948
|
+
> - 仅适用于已开通橱窗功能的 TikTok Shop 创作者账号。
|
|
949
|
+
> - 支持分页查询,通过 `count` 和 `offset` 控制数据量。
|
|
950
|
+
>
|
|
951
|
+
> ### 参数:
|
|
952
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
953
|
+
> - count: 每页返回商品数量,默认 20
|
|
954
|
+
> - offset: 分页偏移量,默认 0
|
|
955
|
+
> - proxy: 可选 HTTP 代理地址
|
|
956
|
+
> - 示例: `http://username:password@host:port`
|
|
957
|
+
>
|
|
958
|
+
> ### 返回内容说明:
|
|
959
|
+
> - `products` (List[Dict]): 商品列表,每项包含以下字段:
|
|
960
|
+
> - `product_id` (str): 商品ID
|
|
961
|
+
> - `title` (str): 商品标题
|
|
962
|
+
> - `format_available_price` (str): 商品展示价格(格式化后的字符串,如 `$7.94`)
|
|
963
|
+
> - `seller_info` (dict):
|
|
964
|
+
> - `seller_id` (str): 卖家ID
|
|
965
|
+
> - `shop_name` (str): 店铺名称
|
|
966
|
+
> - `cover` (dict): 主图信息
|
|
967
|
+
> - `url_list` (List[str]): 主图 URL 列表(300x300)
|
|
968
|
+
> - `images` (List[dict]): 图片列表
|
|
969
|
+
> - 每张图片包含 `url_list` (原图 URL)
|
|
970
|
+
> - `source` (str): 商品来源渠道(如 `Affiliate`)
|
|
971
|
+
> - `stock_status` (int): 库存状态(1: 有货)
|
|
972
|
+
> - `review_status` (int): 审核状态(1: 通过)
|
|
973
|
+
> - `affiliate_info` (dict): 联盟佣金信息
|
|
974
|
+
> - `commission_with_currency` (str): 佣金金额(如 `$0.95`)
|
|
975
|
+
> - `commission_rate` (int): 佣金比例(如 1200 = 12%)
|
|
976
|
+
> - `category_info` (dict): 类目信息
|
|
977
|
+
> - `name` (str): 主分类名(如 `Beauty & Personal Care`)
|
|
978
|
+
>
|
|
979
|
+
> ### 示例请求体:
|
|
980
|
+
> ```json
|
|
981
|
+
> {
|
|
982
|
+
> "cookie": "your_cookie_string",
|
|
983
|
+
> "count": 20,
|
|
984
|
+
> "offset": 0
|
|
985
|
+
> }
|
|
986
|
+
> ```
|
|
987
|
+
>
|
|
988
|
+
> ### 示例返回数据片段:
|
|
989
|
+
> ```json
|
|
990
|
+
> {
|
|
991
|
+
> "products": [
|
|
992
|
+
> {
|
|
993
|
+
> "product_id": "1730905148396180014",
|
|
994
|
+
> "title": "Car Paint Care Spray",
|
|
995
|
+
> "format_available_price": "$7.94",
|
|
996
|
+
> "seller_info": {
|
|
997
|
+
> "seller_id": "7496108716782225966",
|
|
998
|
+
> "shop_name": "moon moon shop shop"
|
|
999
|
+
> },
|
|
1000
|
+
> "cover": {
|
|
1001
|
+
> "url_list": [
|
|
1002
|
+
> "https://example.com/xxx.jpg"
|
|
1003
|
+
> ]
|
|
1004
|
+
> },
|
|
1005
|
+
> "images": [
|
|
1006
|
+
> {
|
|
1007
|
+
> "url_list": [
|
|
1008
|
+
> "https://example.com/xxx.jpg"
|
|
1009
|
+
> ]
|
|
1010
|
+
> }
|
|
1011
|
+
> ],
|
|
1012
|
+
> "source": "Affiliate",
|
|
1013
|
+
> "stock_status": 1,
|
|
1014
|
+
> "review_status": 1,
|
|
1015
|
+
> "affiliate_info": {
|
|
1016
|
+
> "commission_with_currency": "$0.95",
|
|
1017
|
+
> "commission_rate": 1200
|
|
1018
|
+
> },
|
|
1019
|
+
> "category_info": {
|
|
1020
|
+
> "name": "Beauty & Personal Care"
|
|
1021
|
+
> }
|
|
1022
|
+
> }
|
|
1023
|
+
> ]
|
|
1024
|
+
> }
|
|
1025
|
+
> ```
|
|
1026
|
+
>
|
|
1027
|
+
> # [English]
|
|
1028
|
+
> ### Purpose:
|
|
1029
|
+
> - Retrieve the list of products currently displayed in a TikTok Shop creator's showcase.
|
|
1030
|
+
> - Useful for product management, analytics, and monitoring promoted items.
|
|
1031
|
+
>
|
|
1032
|
+
> ### Notes:
|
|
1033
|
+
> - Only available for TikTok creator accounts with the showcase feature enabled.
|
|
1034
|
+
> - Supports pagination via `count` and `offset`.
|
|
1035
|
+
>
|
|
1036
|
+
> ### Parameters:
|
|
1037
|
+
> - cookie: User Cookie string for authentication
|
|
1038
|
+
> - count: Number of products per page (default 20)
|
|
1039
|
+
> - offset: Pagination offset (default 0)
|
|
1040
|
+
> - proxy: Optional HTTP proxy address
|
|
1041
|
+
> - Example: `http://username:password@host:port`
|
|
1042
|
+
>
|
|
1043
|
+
> ### Return Structure:
|
|
1044
|
+
> - `products` (List[Dict]): List of showcased products, including:
|
|
1045
|
+
> - `product_id`, `title`, `format_available_price`, `seller_info`, `cover`, `images`, `source`, `stock_status`, `review_status`, `affiliate_info`, `category_info`.
|
|
1046
|
+
>
|
|
1047
|
+
> ### Example Request:
|
|
1048
|
+
> ```json
|
|
1049
|
+
> {
|
|
1050
|
+
> "cookie": "your_cookie_string",
|
|
1051
|
+
> "count": 20,
|
|
1052
|
+
> "offset": 0
|
|
1053
|
+
> }
|
|
1054
|
+
> ```
|
|
1055
|
+
>
|
|
1056
|
+
> ### Example Response Snippet:
|
|
1057
|
+
> ```json
|
|
1058
|
+
> {
|
|
1059
|
+
> "products": [
|
|
1060
|
+
> {
|
|
1061
|
+
> "product_id": "1730905148396180014",
|
|
1062
|
+
> "title": "Car Paint Care Spray",
|
|
1063
|
+
> "format_available_price": "$7.94",
|
|
1064
|
+
> "seller_info": {
|
|
1065
|
+
> "seller_id": "7496108716782225966",
|
|
1066
|
+
> "shop_name": "moon moon shop shop"
|
|
1067
|
+
> },
|
|
1068
|
+
> "cover": {
|
|
1069
|
+
> "url_list": [
|
|
1070
|
+
> "https://example.com/xxx.jpg"
|
|
1071
|
+
> ]
|
|
1072
|
+
> },
|
|
1073
|
+
> "images": [...],
|
|
1074
|
+
> "source": "Affiliate",
|
|
1075
|
+
> "stock_status": 1,
|
|
1076
|
+
> "review_status": 1,
|
|
1077
|
+
> "affiliate_info": {
|
|
1078
|
+
> "commission_with_currency": "$0.95",
|
|
1079
|
+
> "commission_rate": 1200
|
|
1080
|
+
> },
|
|
1081
|
+
> "category_info": {
|
|
1082
|
+
> "name": "Beauty & Personal Care"
|
|
1083
|
+
> }
|
|
1084
|
+
> }
|
|
1085
|
+
> ]
|
|
1086
|
+
> }
|
|
1087
|
+
> ```
|
|
1088
|
+
|
|
1089
|
+
#### Parameters
|
|
1090
|
+
|
|
1091
|
+
None
|
|
1092
|
+
|
|
1093
|
+
#### Request Body
|
|
1094
|
+
|
|
1095
|
+
- required: Yes
|
|
1096
|
+
|
|
1097
|
+
##### `application/json`
|
|
1098
|
+
|
|
1099
|
+
- Schema summary: `cookie`:string, `proxy`:string, `count`:integer, `offset`:integer
|
|
1100
|
+
|
|
1101
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1102
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1103
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1104
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1105
|
+
| count | integer | No | 每页数量/Page Size | 20 | None | None |
|
|
1106
|
+
| offset | integer | No | 偏移量/Offset | 0 | None | None |
|
|
1107
|
+
|
|
1108
|
+
#### Success Response
|
|
1109
|
+
|
|
1110
|
+
##### `200 application/json`
|
|
1111
|
+
|
|
1112
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1113
|
+
|
|
1114
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1115
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1116
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1117
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1118
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1119
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1120
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1121
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1122
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1123
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1124
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1125
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1126
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1127
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1128
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1129
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1130
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1131
|
+
|
|
1132
|
+
<a id="post-api-u1-v1-tiktok-creator-get-video-analytics-summary"></a>
|
|
1133
|
+
### `POST /api/u1/v1/tiktok/creator/get_video_analytics_summary`
|
|
1134
|
+
|
|
1135
|
+
- Summary: 获取创作者视频概览/Get Creator Video Overview
|
|
1136
|
+
- Capabilities: creators / content details / analytics
|
|
1137
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1138
|
+
- operationId: `get_video_analytics_summary_api_v1_tiktok_creator_get_video_analytics_summary_post`
|
|
1139
|
+
|
|
1140
|
+
#### Notes
|
|
1141
|
+
|
|
1142
|
+
> # [中文]
|
|
1143
|
+
> ### 用途:
|
|
1144
|
+
> - 获取 TikTok Shop 创作者账号在指定时间范围内的视频表现概览。
|
|
1145
|
+
> - 默认统计从调用当天向前 30 天的数据(或按平台设定的自然月分段)。
|
|
1146
|
+
> - 适合用于视频表现分析,例如视频数量、播放量、粉丝增长、成交数据等。
|
|
1147
|
+
>
|
|
1148
|
+
> ### 返回内容说明:
|
|
1149
|
+
> - `segments`(分段数据列表):
|
|
1150
|
+
> - `time_selector`: 时间范围设置信息(周期、起止时间戳、时区、语言)
|
|
1151
|
+
> - `filter.creator_id`: 创作者账号 ID
|
|
1152
|
+
> - `timed_stats`: 每个时间段的视频表现数据,包含:
|
|
1153
|
+
> - `vv_cnt`: 视频播放量(Video Views Count)
|
|
1154
|
+
> - `new_follower_cnt`: 新增粉丝数量
|
|
1155
|
+
> - `video_cnt`: 发布视频数量
|
|
1156
|
+
> - `gmv.amount`: 视频带货产生的 GMV 金额
|
|
1157
|
+
> - `items_sold`: 售出商品数量
|
|
1158
|
+
>
|
|
1159
|
+
> ### 备注:
|
|
1160
|
+
> - 此接口仅适用于 TikTok Shop 创作者账号。
|
|
1161
|
+
> - 如果某个时间段无数据,返回的 `stats` 字段可能为空 `{}`。
|
|
1162
|
+
>
|
|
1163
|
+
> ### 参数:
|
|
1164
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
1165
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
1166
|
+
> - 示例格式: `http://username:password@host:port`
|
|
1167
|
+
>
|
|
1168
|
+
> ### 返回:
|
|
1169
|
+
> - 创作者账号视频表现概览
|
|
1170
|
+
>
|
|
1171
|
+
> # [English]
|
|
1172
|
+
> ### Purpose:
|
|
1173
|
+
> - Retrieve a video performance overview for a TikTok Shop creator account over a specified time range.
|
|
1174
|
+
> - By default, the API fetches data for the past 30 days (or full calendar month based on the platform settings).
|
|
1175
|
+
> - Useful for analyzing metrics like video count, views, new followers, and generated GMV.
|
|
1176
|
+
>
|
|
1177
|
+
> ### Response Fields:
|
|
1178
|
+
> - `segments` (List of segmented data):
|
|
1179
|
+
> - `time_selector`: Time period settings (period, start/end timestamps, timezone, locale)
|
|
1180
|
+
> - `filter.creator_id`: Creator account ID
|
|
1181
|
+
> - `timed_stats`: Video performance statistics for each time segment, including:
|
|
1182
|
+
> - `vv_cnt`: Video Views Count
|
|
1183
|
+
> - `new_follower_cnt`: Number of new followers
|
|
1184
|
+
> - `video_cnt`: Number of videos published
|
|
1185
|
+
> - `gmv.amount`: Gross Merchandise Value generated by videos
|
|
1186
|
+
> - `items_sold`: Number of items sold
|
|
1187
|
+
>
|
|
1188
|
+
> ### Notes:
|
|
1189
|
+
> - This API is only available for TikTok Shop creator accounts.
|
|
1190
|
+
> - If no data is available for a time segment, the `stats` field might be an empty `{}`.
|
|
1191
|
+
>
|
|
1192
|
+
> ### Parameters:
|
|
1193
|
+
> - cookie: User Cookie string for authentication
|
|
1194
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not used
|
|
1195
|
+
> - Example format: `http://username:password@host:port`
|
|
1196
|
+
>
|
|
1197
|
+
> ### Return:
|
|
1198
|
+
> - Creator account video performance overview
|
|
1199
|
+
>
|
|
1200
|
+
> # [示例/Example]
|
|
1201
|
+
> ```json
|
|
1202
|
+
> {
|
|
1203
|
+
> "cookie": "your_cookie"
|
|
1204
|
+
> }
|
|
1205
|
+
> ```
|
|
1206
|
+
|
|
1207
|
+
#### Parameters
|
|
1208
|
+
|
|
1209
|
+
None
|
|
1210
|
+
|
|
1211
|
+
#### Request Body
|
|
1212
|
+
|
|
1213
|
+
- required: Yes
|
|
1214
|
+
|
|
1215
|
+
##### `application/json`
|
|
1216
|
+
|
|
1217
|
+
- Schema summary: `cookie`:string, `proxy`:string
|
|
1218
|
+
|
|
1219
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1220
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1221
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1222
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1223
|
+
|
|
1224
|
+
#### Success Response
|
|
1225
|
+
|
|
1226
|
+
##### `200 application/json`
|
|
1227
|
+
|
|
1228
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1229
|
+
|
|
1230
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1231
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1232
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1233
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1234
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1235
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1236
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1237
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1238
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1239
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1240
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1241
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1242
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1243
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1244
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1245
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1246
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1247
|
+
|
|
1248
|
+
<a id="post-api-u1-v1-tiktok-creator-get-video-associated-product-list"></a>
|
|
1249
|
+
### `POST /api/u1/v1/tiktok/creator/get_video_associated_product_list`
|
|
1250
|
+
|
|
1251
|
+
- Summary: 获取视频关联商品列表/Get Video Associated Product List
|
|
1252
|
+
- Capabilities: creators / content details / commerce
|
|
1253
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1254
|
+
- operationId: `get_video_associated_product_list_api_v1_tiktok_creator_get_video_associated_product_list_post`
|
|
1255
|
+
|
|
1256
|
+
#### Notes
|
|
1257
|
+
|
|
1258
|
+
> # [中文]
|
|
1259
|
+
> ### 用途:
|
|
1260
|
+
> - 获取指定视频在 TikTok Shop 中关联展示的商品列表及其推广表现数据。
|
|
1261
|
+
> - 可用于分析每个视频挂载商品的数量、商品价格区间、商品跳转链接,以及商品销售和推广效果。
|
|
1262
|
+
>
|
|
1263
|
+
> ### 备注:
|
|
1264
|
+
> - 必须提供 item_ids(视频 ID 列表)。
|
|
1265
|
+
> - 时间范围默认使用 start_date 所在自然月。
|
|
1266
|
+
> - 支持单次查询多个视频,返回每个视频关联的所有商品信息及对应商品的推广数据。
|
|
1267
|
+
>
|
|
1268
|
+
> ### 参数:
|
|
1269
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
1270
|
+
> - start_date: 查询起始日期,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
1271
|
+
> - item_ids: 视频 ID 列表,例如 ["7496499484705246507", "7496110433699482923"]
|
|
1272
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
1273
|
+
> - 示例格式: `http://username:password@host:port`
|
|
1274
|
+
>
|
|
1275
|
+
> ### 返回内容说明:
|
|
1276
|
+
> - `segments`(分段数据列表):
|
|
1277
|
+
> - `time_selector`: 时间筛选信息(起止时间戳)
|
|
1278
|
+
> - `filter`: 查询条件(视频 ID 列表)
|
|
1279
|
+
> - `timed_lists`: 每个时间段下的视频商品关联列表
|
|
1280
|
+
> - `videoToProductsMap`:
|
|
1281
|
+
> - `item_id`: 视频 ID
|
|
1282
|
+
> - `products`: 关联商品列表
|
|
1283
|
+
> - `id`: 商品 ID
|
|
1284
|
+
> - `name`: 商品名称
|
|
1285
|
+
> - `cover_image.thumb_url_list`: 商品图片 URL 列表
|
|
1286
|
+
> - `product_detail_page_url`: 商品跳转链接
|
|
1287
|
+
> - `price_min` / `price_max`: 商品价格区间
|
|
1288
|
+
> - `stats`:
|
|
1289
|
+
> - `product.id`: 商品 ID
|
|
1290
|
+
> - 商品销售推广表现(如销量、点击率等)
|
|
1291
|
+
>
|
|
1292
|
+
> ### 示例请求体:
|
|
1293
|
+
> ```json
|
|
1294
|
+
> {
|
|
1295
|
+
> "cookie": "your_cookie",
|
|
1296
|
+
> "start_date": "04-01-2025",
|
|
1297
|
+
> "item_ids": ["7496499484705246507", "7496110433699482923"]
|
|
1298
|
+
> }
|
|
1299
|
+
> ```
|
|
1300
|
+
>
|
|
1301
|
+
> # [English]
|
|
1302
|
+
> ### Purpose:
|
|
1303
|
+
> - Retrieve the list of products associated with specified videos on TikTok Shop, along with their promotional performance data.
|
|
1304
|
+
> - Useful for analyzing the number of products linked to each video, the product price range, product detail page links, and sales performance metrics.
|
|
1305
|
+
>
|
|
1306
|
+
> ### Notes:
|
|
1307
|
+
> - Requires item_ids (list of video IDs).
|
|
1308
|
+
> - The time range defaults to the calendar month of the specified start_date.
|
|
1309
|
+
> - Supports querying multiple videos at once.
|
|
1310
|
+
>
|
|
1311
|
+
> ### Return Description:
|
|
1312
|
+
> - `segments`:
|
|
1313
|
+
> - `time_selector`: Time filter information (start/end timestamps)
|
|
1314
|
+
> - `filter`: Query conditions (video ID list)
|
|
1315
|
+
> - `timed_lists`: Product list associated with videos in the selected time range
|
|
1316
|
+
> - `videoToProductsMap`:
|
|
1317
|
+
> - `item_id`: Video ID
|
|
1318
|
+
> - `products`:
|
|
1319
|
+
> - `id`: Product ID
|
|
1320
|
+
> - `name`: Product name
|
|
1321
|
+
> - `cover_image.thumb_url_list`: List of product image URLs
|
|
1322
|
+
> - `product_detail_page_url`: Product detail page link
|
|
1323
|
+
> - `price_min` / `price_max`: Price range
|
|
1324
|
+
> - `stats`:
|
|
1325
|
+
> - `product.id`: Product ID
|
|
1326
|
+
> - Promotional performance metrics (e.g., sales volume, CTR)
|
|
1327
|
+
>
|
|
1328
|
+
> ### Example Request Body:
|
|
1329
|
+
> ```json
|
|
1330
|
+
> {
|
|
1331
|
+
> "cookie": "your_cookie",
|
|
1332
|
+
> "start_date": "04-01-2025",
|
|
1333
|
+
> "item_ids": ["7496499484705246507", "7496110433699482923"]
|
|
1334
|
+
> }
|
|
1335
|
+
> ```
|
|
1336
|
+
|
|
1337
|
+
#### Parameters
|
|
1338
|
+
|
|
1339
|
+
None
|
|
1340
|
+
|
|
1341
|
+
#### Request Body
|
|
1342
|
+
|
|
1343
|
+
- required: Yes
|
|
1344
|
+
|
|
1345
|
+
##### `application/json`
|
|
1346
|
+
|
|
1347
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `item_ids*`[string]
|
|
1348
|
+
|
|
1349
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1350
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1351
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1352
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1353
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
1354
|
+
| item_ids | array<string> | Yes | 视频 ID 列表/Video ID List | None | None | None |
|
|
1355
|
+
|
|
1356
|
+
#### Success Response
|
|
1357
|
+
|
|
1358
|
+
##### `200 application/json`
|
|
1359
|
+
|
|
1360
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1361
|
+
|
|
1362
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1363
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1364
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1365
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1366
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1367
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1368
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1369
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1370
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1371
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1372
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1373
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1374
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1375
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1376
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1377
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1378
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1379
|
+
|
|
1380
|
+
<a id="post-api-u1-v1-tiktok-creator-get-video-audience-stats"></a>
|
|
1381
|
+
### `POST /api/u1/v1/tiktok/creator/get_video_audience_stats`
|
|
1382
|
+
|
|
1383
|
+
- Summary: 获取视频受众分析数据/Get Video Audience Analysis Data
|
|
1384
|
+
- Capabilities: creators / content details
|
|
1385
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1386
|
+
- operationId: `get_video_audience_stats_api_v1_tiktok_creator_get_video_audience_stats_post`
|
|
1387
|
+
|
|
1388
|
+
#### Notes
|
|
1389
|
+
|
|
1390
|
+
> # [中文]
|
|
1391
|
+
> ### 用途:
|
|
1392
|
+
> - 获取指定 TikTok 视频观众的用户画像统计数据,包括性别分布、年龄分布、地区分布等维度。
|
|
1393
|
+
> - 可用于精准了解视频观众群体特征,指导内容创作、商品选择和营销策略优化。
|
|
1394
|
+
> - 支持按时间段(日/周/月)分析变化趋势。
|
|
1395
|
+
>
|
|
1396
|
+
> ### 备注:
|
|
1397
|
+
> - 此接口需要提供 item_id(视频 ID)。
|
|
1398
|
+
> - 受众画像数据来源于观看和互动用户的统计特征。
|
|
1399
|
+
>
|
|
1400
|
+
> ### 参数:
|
|
1401
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
1402
|
+
> - start_date: 查询起始日期,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
1403
|
+
> - item_id: 视频 ID,例如 "7496499484705246507"
|
|
1404
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
1405
|
+
> - 示例格式: `http://username:password@host:port`
|
|
1406
|
+
>
|
|
1407
|
+
> ### 返回内容说明:
|
|
1408
|
+
> - `segments`(数据分段列表):
|
|
1409
|
+
> - `time_selector`: 时间筛选参数(period, granularity, start_timestamp, end_timestamp)
|
|
1410
|
+
> - `filter`: 查询条件(creator_id, item_id)
|
|
1411
|
+
> - `timed_profile`: 分段画像统计数据
|
|
1412
|
+
> - `start_timestamp`: 开始时间戳
|
|
1413
|
+
> - `end_timestamp`: 结束时间戳
|
|
1414
|
+
> - `stats`:
|
|
1415
|
+
> - `follower_genders`: 性别分布
|
|
1416
|
+
> - `key`: 性别(female/male)
|
|
1417
|
+
> - `value`: 占比(字符串,0-1)
|
|
1418
|
+
> - `follower_ages`: 年龄段分布
|
|
1419
|
+
> - `key`: 年龄段(如 "18-24", "25-34", 等)
|
|
1420
|
+
> - `value`: 占比(字符串,0-1)
|
|
1421
|
+
> - `follower_regions`: 地区分布
|
|
1422
|
+
> - `key`: 国家代码(如 "US")
|
|
1423
|
+
> - `value`: 占比(字符串,0-1)
|
|
1424
|
+
> - `profile_type`: 画像类型,固定值 2(受众画像)
|
|
1425
|
+
>
|
|
1426
|
+
> ### 示例请求体:
|
|
1427
|
+
> ```json
|
|
1428
|
+
> {
|
|
1429
|
+
> "cookie": "your_cookie",
|
|
1430
|
+
> "start_date": "04-01-2025",
|
|
1431
|
+
> "item_id": "7496499484705246507"
|
|
1432
|
+
> }
|
|
1433
|
+
> ```
|
|
1434
|
+
>
|
|
1435
|
+
> # [English]
|
|
1436
|
+
> ### Purpose:
|
|
1437
|
+
> - Retrieve audience profile statistics for a specified TikTok video, including gender distribution, age distribution, and regional distribution.
|
|
1438
|
+
> - Useful for accurately understanding the characteristics of the video audience to guide content creation, product selection, and marketing strategy optimization.
|
|
1439
|
+
> - Supports trend analysis across different time intervals (daily/weekly/monthly).
|
|
1440
|
+
>
|
|
1441
|
+
> ### Notes:
|
|
1442
|
+
> - Requires item_id (video ID).
|
|
1443
|
+
> - Audience profile data is based on characteristics of users who viewed and interacted with the video.
|
|
1444
|
+
>
|
|
1445
|
+
> ### Return Description:
|
|
1446
|
+
> - `segments`:
|
|
1447
|
+
> - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)
|
|
1448
|
+
> - `filter`: Query conditions (creator_id, item_id)
|
|
1449
|
+
> - `timed_profile`: Audience profile statistics
|
|
1450
|
+
> - `start_timestamp`: Start timestamp
|
|
1451
|
+
> - `end_timestamp`: End timestamp
|
|
1452
|
+
> - `stats`:
|
|
1453
|
+
> - `follower_genders`: Gender distribution
|
|
1454
|
+
> - `key`: Gender ("female" or "male")
|
|
1455
|
+
> - `value`: Proportion (string, range 0-1)
|
|
1456
|
+
> - `follower_ages`: Age group distribution
|
|
1457
|
+
> - `key`: Age group (e.g., "18-24", "25-34")
|
|
1458
|
+
> - `value`: Proportion (string, range 0-1)
|
|
1459
|
+
> - `follower_regions`: Regional distribution
|
|
1460
|
+
> - `key`: Country code (e.g., "US")
|
|
1461
|
+
> - `value`: Proportion (string, range 0-1)
|
|
1462
|
+
> - `profile_type`: Profile type, fixed value 2 (Audience Profile)
|
|
1463
|
+
>
|
|
1464
|
+
> ### Example Request Body:
|
|
1465
|
+
> ```json
|
|
1466
|
+
> {
|
|
1467
|
+
> "cookie": "your_cookie",
|
|
1468
|
+
> "start_date": "04-01-2025",
|
|
1469
|
+
> "item_id": "7496499484705246507"
|
|
1470
|
+
> }
|
|
1471
|
+
> ```
|
|
1472
|
+
|
|
1473
|
+
#### Parameters
|
|
1474
|
+
|
|
1475
|
+
None
|
|
1476
|
+
|
|
1477
|
+
#### Request Body
|
|
1478
|
+
|
|
1479
|
+
- required: Yes
|
|
1480
|
+
|
|
1481
|
+
##### `application/json`
|
|
1482
|
+
|
|
1483
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `item_id*`:string
|
|
1484
|
+
|
|
1485
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1486
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1487
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1488
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1489
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
1490
|
+
| item_id | string | Yes | 视频 ID/Video ID | None | None | None |
|
|
1491
|
+
|
|
1492
|
+
#### Success Response
|
|
1493
|
+
|
|
1494
|
+
##### `200 application/json`
|
|
1495
|
+
|
|
1496
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1497
|
+
|
|
1498
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1499
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1500
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1501
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1502
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1503
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1504
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1505
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1506
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1507
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1508
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1509
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1510
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1511
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1512
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1513
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1514
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1515
|
+
|
|
1516
|
+
<a id="post-api-u1-v1-tiktok-creator-get-video-detailed-stats"></a>
|
|
1517
|
+
### `POST /api/u1/v1/tiktok/creator/get_video_detailed_stats`
|
|
1518
|
+
|
|
1519
|
+
- Summary: 获取视频详细分段统计数据/Get Video Detailed Statistics
|
|
1520
|
+
- Capabilities: creators / content details / details
|
|
1521
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1522
|
+
- operationId: `get_video_detailed_stats_api_v1_tiktok_creator_get_video_detailed_stats_post`
|
|
1523
|
+
|
|
1524
|
+
#### Notes
|
|
1525
|
+
|
|
1526
|
+
> # [中文]
|
|
1527
|
+
> ### 用途:
|
|
1528
|
+
> - 获取指定 TikTok 视频在指定自然月内的详细分段统计数据。
|
|
1529
|
+
> - 支持按时间段(日/周/月)统计新粉丝、点赞、评论、分享、商品浏览、完播率等多维指标。
|
|
1530
|
+
> - 可用于深入分析单个视频在不同时间段的表现变化,优化内容策略和推广效果。
|
|
1531
|
+
>
|
|
1532
|
+
> ### 备注:
|
|
1533
|
+
> - 必须提供 item_id(视频 ID)。
|
|
1534
|
+
> - 时间范围基于 start_date 所在自然月。
|
|
1535
|
+
> - 若数据量大,返回的数据将按不同时间粒度分段统计(granularity=日/周/月)。
|
|
1536
|
+
>
|
|
1537
|
+
> ### 参数:
|
|
1538
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
1539
|
+
> - start_date: 查询起始日期,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
1540
|
+
> - item_id: 视频 ID,例如 "7496499484705246507"
|
|
1541
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
1542
|
+
> - 示例格式: `http://username:password@host:port`
|
|
1543
|
+
>
|
|
1544
|
+
> ### 返回内容说明:
|
|
1545
|
+
> - `segments`(数据分段列表):
|
|
1546
|
+
> - `time_selector`: 时间筛选条件(period, granularity, start_timestamp, end_timestamp)
|
|
1547
|
+
> - `filter`: 查询条件(creator_id, item_id)
|
|
1548
|
+
> - `timed_stats`: 按时间段返回的统计数据列表
|
|
1549
|
+
> - `start_timestamp`: 开始时间戳
|
|
1550
|
+
> - `end_timestamp`: 结束时间戳
|
|
1551
|
+
> - `stats`:
|
|
1552
|
+
> - `creator_id`: 创作者账号 ID
|
|
1553
|
+
> - `item_id`: 视频 ID
|
|
1554
|
+
> - `new_follower_cnt`: 新增粉丝数量
|
|
1555
|
+
> - `share_cnt`: 分享次数
|
|
1556
|
+
> - `comment_cnt`: 评论次数
|
|
1557
|
+
> - `like_cnt`: 点赞次数
|
|
1558
|
+
> - `product_view_cnt`: 商品浏览量
|
|
1559
|
+
> - `video_completion_rate`: 视频完播率(字符串,0-1)
|
|
1560
|
+
>
|
|
1561
|
+
> ### 示例请求体:
|
|
1562
|
+
> ```json
|
|
1563
|
+
> {
|
|
1564
|
+
> "cookie": "your_cookie",
|
|
1565
|
+
> "start_date": "04-01-2025",
|
|
1566
|
+
> "item_id": "7496499484705246507"
|
|
1567
|
+
> }
|
|
1568
|
+
> ```
|
|
1569
|
+
>
|
|
1570
|
+
> # [English]
|
|
1571
|
+
> ### Purpose:
|
|
1572
|
+
> - Retrieve detailed segmented statistics for a specified TikTok video within a given calendar month.
|
|
1573
|
+
> - Supports analyzing new followers, likes, comments, shares, product views, and video completion rates across different time segments (daily/weekly/monthly).
|
|
1574
|
+
> - Useful for deeply analyzing the performance changes of a single video over time, optimizing content strategies and promotional outcomes.
|
|
1575
|
+
>
|
|
1576
|
+
> ### Notes:
|
|
1577
|
+
> - Requires item_id (video ID).
|
|
1578
|
+
> - Time range is based on the calendar month of start_date.
|
|
1579
|
+
> - Large datasets will be automatically segmented based on granularity (daily/weekly/monthly).
|
|
1580
|
+
>
|
|
1581
|
+
> ### Return Description:
|
|
1582
|
+
> - `segments`:
|
|
1583
|
+
> - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)
|
|
1584
|
+
> - `filter`: Query conditions (creator_id, item_id)
|
|
1585
|
+
> - `timed_stats`: Segmented statistics list
|
|
1586
|
+
> - `start_timestamp`: Start timestamp
|
|
1587
|
+
> - `end_timestamp`: End timestamp
|
|
1588
|
+
> - `stats`:
|
|
1589
|
+
> - `creator_id`: Creator ID
|
|
1590
|
+
> - `item_id`: Video ID
|
|
1591
|
+
> - `new_follower_cnt`: Number of new followers
|
|
1592
|
+
> - `share_cnt`: Number of shares
|
|
1593
|
+
> - `comment_cnt`: Number of comments
|
|
1594
|
+
> - `like_cnt`: Number of likes
|
|
1595
|
+
> - `product_view_cnt`: Number of product views
|
|
1596
|
+
> - `video_completion_rate`: Video completion rate (string, range 0-1)
|
|
1597
|
+
>
|
|
1598
|
+
> ### Example Request Body:
|
|
1599
|
+
> ```json
|
|
1600
|
+
> {
|
|
1601
|
+
> "cookie": "your_cookie",
|
|
1602
|
+
> "start_date": "04-01-2025",
|
|
1603
|
+
> "item_id": "7496499484705246507"
|
|
1604
|
+
> }
|
|
1605
|
+
> ```
|
|
1606
|
+
|
|
1607
|
+
#### Parameters
|
|
1608
|
+
|
|
1609
|
+
None
|
|
1610
|
+
|
|
1611
|
+
#### Request Body
|
|
1612
|
+
|
|
1613
|
+
- required: Yes
|
|
1614
|
+
|
|
1615
|
+
##### `application/json`
|
|
1616
|
+
|
|
1617
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `item_id*`:string
|
|
1618
|
+
|
|
1619
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1620
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1621
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1622
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1623
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
1624
|
+
| item_id | string | Yes | 视频 ID/Video ID | None | None | None |
|
|
1625
|
+
|
|
1626
|
+
#### Success Response
|
|
1627
|
+
|
|
1628
|
+
##### `200 application/json`
|
|
1629
|
+
|
|
1630
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1631
|
+
|
|
1632
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1633
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1634
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1635
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1636
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1637
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1638
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1639
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1640
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1641
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1642
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1643
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1644
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1645
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1646
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1647
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1648
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1649
|
+
|
|
1650
|
+
<a id="post-api-u1-v1-tiktok-creator-get-video-list-analytics"></a>
|
|
1651
|
+
### `POST /api/u1/v1/tiktok/creator/get_video_list_analytics`
|
|
1652
|
+
|
|
1653
|
+
- Summary: 获取创作者视频列表分析/Get Creator Video List Analytics
|
|
1654
|
+
- Capabilities: creators / content details / analytics
|
|
1655
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1656
|
+
- operationId: `get_video_list_api_v1_tiktok_creator_get_video_list_analytics_post`
|
|
1657
|
+
|
|
1658
|
+
#### Notes
|
|
1659
|
+
|
|
1660
|
+
> # [中文]
|
|
1661
|
+
> ### 用途:
|
|
1662
|
+
> - 获取 TikTok Shop 创作者账号在指定时间范围内发布的视频列表及其详细数据表现。
|
|
1663
|
+
> - 支持分页查询,每页返回指定时间段内的视频及其播放、成交等详细数据。
|
|
1664
|
+
>
|
|
1665
|
+
> ### 返回内容说明:
|
|
1666
|
+
> - `segments`(分段数据列表):
|
|
1667
|
+
> - `time_selector`: 查询时间范围(起止时间戳、时区、语言等)
|
|
1668
|
+
> - `filter.creator_id`: 创作者账号 ID
|
|
1669
|
+
> - `list_control`:
|
|
1670
|
+
> - `rules`: 列表排序规则(通常按发布时间降序)
|
|
1671
|
+
> - `next_pagination`: 翻页信息(是否有更多页,当前页,总页数,总记录数)
|
|
1672
|
+
> - `timed_lists`: 每个时间段内的视频数据,包括:
|
|
1673
|
+
> - `video_meta`:
|
|
1674
|
+
> - `item_id`: 视频 Item ID
|
|
1675
|
+
> - `name`: 视频标题
|
|
1676
|
+
> - `publish_time`: 视频发布时间(Unix 时间戳)
|
|
1677
|
+
> - `duration`: 视频时长(秒)
|
|
1678
|
+
> - `video_play_info`: 视频播放资源信息(封面图、播放链接等)
|
|
1679
|
+
> - `new_follower_cnt`: 视频期间新增粉丝数
|
|
1680
|
+
> - `vv_cnt`: 视频播放量
|
|
1681
|
+
> - `ctr`: 商品点击率(Click Through Rate)
|
|
1682
|
+
> - `gmv.amount`: 视频带货产生的总 GMV 金额
|
|
1683
|
+
> - `item_sold_cnt`: 视频带动的商品售出数量
|
|
1684
|
+
> - `direct_gmv.amount`: 直接带货 GMV
|
|
1685
|
+
> - `completion_rate`: 视频观看完成率
|
|
1686
|
+
>
|
|
1687
|
+
> ### 备注:
|
|
1688
|
+
> - 此接口仅适用于 TikTok Shop 创作者账号。
|
|
1689
|
+
> - 数据按自然日或周分组,且每条视频数据对应一段时间内的统计值。
|
|
1690
|
+
>
|
|
1691
|
+
> ### 参数:
|
|
1692
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
1693
|
+
> - start_date: 查询起始日期,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
1694
|
+
> - page: 页码,默认为第一页 `0`
|
|
1695
|
+
> - rules: 列表排序规则,默认按发布时间排序,可选值如下:
|
|
1696
|
+
> - `"VIDEO_LIST_PUBLISH_TIME"`:按发布时间排序
|
|
1697
|
+
> - `"VIDEO_LIST_GMV"`:按商品交易总额排序
|
|
1698
|
+
> - `"VIDEO_LIST_DIRECT_GMV"`:按直接商品交易总额排序
|
|
1699
|
+
> - `"VIDEO_LIST_VV_CNT"`:按观看人次数排序
|
|
1700
|
+
> - `"VIDEO_LIST_ITEM_SOLD_CNT"`:按成交件数排序
|
|
1701
|
+
> - `"VIDEO_LIST_CTR"`:按商品点击率排序
|
|
1702
|
+
> - `"VIDEO_LIST_COMPLETION_RATE"`:按观看完播率排序
|
|
1703
|
+
> - `"VIDEO_LIST_LIKE_CNT"`:按点赞数排序
|
|
1704
|
+
> - `"VIDEO_LIST_NEW_FOLLOWER_CNT"`:按新增粉丝数排序
|
|
1705
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
1706
|
+
> - 示例格式: `http://username:password@host:port`
|
|
1707
|
+
>
|
|
1708
|
+
> ### 返回:
|
|
1709
|
+
> - 创作者账号视频列表及详细分析数据
|
|
1710
|
+
>
|
|
1711
|
+
> # [English]
|
|
1712
|
+
> ### Purpose:
|
|
1713
|
+
> - Retrieve a list of videos published by a TikTok Shop creator account within a specified time range, along with detailed performance metrics.
|
|
1714
|
+
> - Supports pagination to fetch multiple pages of video records within the given time range.
|
|
1715
|
+
>
|
|
1716
|
+
> ### Response Fields:
|
|
1717
|
+
> - `segments` (List of segmented data):
|
|
1718
|
+
> - `time_selector`: Time range settings (start/end timestamps, timezone, locale)
|
|
1719
|
+
> - `filter.creator_id`: Creator account ID
|
|
1720
|
+
> - `list_control`:
|
|
1721
|
+
> - `rules`: List sorting rules (typically by publish time descending)
|
|
1722
|
+
> - `next_pagination`: Pagination information (has more pages, current page, total pages, total records)
|
|
1723
|
+
> - `timed_lists`: List of videos for each time range, including:
|
|
1724
|
+
> - `video_meta`:
|
|
1725
|
+
> - `item_id`: Video Item ID
|
|
1726
|
+
> - `name`: Video title
|
|
1727
|
+
> - `publish_time`: Video publish time (Unix timestamp)
|
|
1728
|
+
> - `duration`: Video duration (seconds)
|
|
1729
|
+
> - `video_play_info`: Video play resources (cover image, playback URL, etc.)
|
|
1730
|
+
> - `new_follower_cnt`: Number of new followers during the video's period
|
|
1731
|
+
> - `vv_cnt`: Video views count
|
|
1732
|
+
> - `ctr`: Click Through Rate for associated products
|
|
1733
|
+
> - `gmv.amount`: Gross Merchandise Value generated by the video
|
|
1734
|
+
> - `item_sold_cnt`: Number of items sold due to the video
|
|
1735
|
+
> - `direct_gmv.amount`: Direct GMV from the video
|
|
1736
|
+
> - `completion_rate`: Video completion rate
|
|
1737
|
+
>
|
|
1738
|
+
> ### Notes:
|
|
1739
|
+
> - This API is only available for TikTok Shop creator accounts.
|
|
1740
|
+
> - Data is grouped by natural day or week, and each video's stats represent the corresponding period.
|
|
1741
|
+
>
|
|
1742
|
+
> ### Parameters:
|
|
1743
|
+
> - cookie: User Cookie string for authentication
|
|
1744
|
+
> - start_date: Query start date, formatted as 'MM-DD-YYYY', e.g., '04-01-2025'
|
|
1745
|
+
> - page: Page number, default is the first page `0`
|
|
1746
|
+
> - rules: List sorting rules, default is by publish time. Available options:
|
|
1747
|
+
> - `"VIDEO_LIST_PUBLISH_TIME"`: Sort by video publish time
|
|
1748
|
+
> - `"VIDEO_LIST_GMV"`: Sort by gross merchandise value (GMV)
|
|
1749
|
+
> - `"VIDEO_LIST_DIRECT_GMV"`: Sort by direct GMV
|
|
1750
|
+
> - `"VIDEO_LIST_VV_CNT"`: Sort by video view count
|
|
1751
|
+
> - `"VIDEO_LIST_ITEM_SOLD_CNT"`: Sort by number of items sold
|
|
1752
|
+
> - `"VIDEO_LIST_CTR"`: Sort by click-through rate
|
|
1753
|
+
> - `"VIDEO_LIST_COMPLETION_RATE"`: Sort by video completion rate
|
|
1754
|
+
> - `"VIDEO_LIST_LIKE_CNT"`: Sort by number of likes
|
|
1755
|
+
> - `"VIDEO_LIST_NEW_FOLLOWER_CNT"`: Sort by number of new followers
|
|
1756
|
+
> - proxy: Optional HTTP proxy address, can be omitted if not used
|
|
1757
|
+
> - Example format: `http://username:password@host:port`
|
|
1758
|
+
>
|
|
1759
|
+
> ### Return:
|
|
1760
|
+
> - Detailed video list and performance analysis for the creator account
|
|
1761
|
+
>
|
|
1762
|
+
> # [示例/Example]
|
|
1763
|
+
> ```json
|
|
1764
|
+
> {
|
|
1765
|
+
> "cookie": "your_cookie",
|
|
1766
|
+
> "start_date": "04-01-2025",
|
|
1767
|
+
> "page": 0
|
|
1768
|
+
> }
|
|
1769
|
+
> ```
|
|
1770
|
+
|
|
1771
|
+
#### Parameters
|
|
1772
|
+
|
|
1773
|
+
None
|
|
1774
|
+
|
|
1775
|
+
#### Request Body
|
|
1776
|
+
|
|
1777
|
+
- required: Yes
|
|
1778
|
+
|
|
1779
|
+
##### `application/json`
|
|
1780
|
+
|
|
1781
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `page`:integer, `rules`:string
|
|
1782
|
+
|
|
1783
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1784
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1785
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1786
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1787
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
1788
|
+
| page | integer | No | 页码/Page Number | 0 | None | None |
|
|
1789
|
+
| rules | string | No | 列表排序规则,默认按发布时间排序/ List sorting rule, default is by publish time | VIDEO_LIST_PUBLISH_TIME | None | None |
|
|
1790
|
+
|
|
1791
|
+
#### Success Response
|
|
1792
|
+
|
|
1793
|
+
##### `200 application/json`
|
|
1794
|
+
|
|
1795
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1796
|
+
|
|
1797
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1798
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1799
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1800
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1801
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1802
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1803
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1804
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1805
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1806
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1807
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1808
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1809
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1810
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1811
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1812
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1813
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|
|
1814
|
+
|
|
1815
|
+
<a id="post-api-u1-v1-tiktok-creator-get-video-to-product-stats"></a>
|
|
1816
|
+
### `POST /api/u1/v1/tiktok/creator/get_video_to_product_stats`
|
|
1817
|
+
|
|
1818
|
+
- Summary: 获取视频与商品关联统计数据/Get Video-Product Association Statistics
|
|
1819
|
+
- Capabilities: creators / content details / commerce
|
|
1820
|
+
- Auth: Header `Authorization: Bearer {token}`; docs also allow Cookie `Authorization` as fallback (`HTTPBearer`)
|
|
1821
|
+
- operationId: `get_video_to_product_stats_api_v1_tiktok_creator_get_video_to_product_stats_post`
|
|
1822
|
+
|
|
1823
|
+
#### Notes
|
|
1824
|
+
|
|
1825
|
+
> # [中文]
|
|
1826
|
+
> ### 用途:
|
|
1827
|
+
> - 获取指定 TikTok 视频与指定商品关联的推广详细统计数据。
|
|
1828
|
+
> - 支持分析视频为商品带来的商品浏览量、点击量、销售量、订单量、商品收入、直接收入等多维度指标。
|
|
1829
|
+
> - 返回数据按时间段(日/周/月)分段统计,便于观察趋势变化。
|
|
1830
|
+
>
|
|
1831
|
+
> ### 备注:
|
|
1832
|
+
> - 必须同时提供 item_id(视频 ID)和 product_id(商品 ID)。
|
|
1833
|
+
> - 时间范围基于 start_date 所在自然月。
|
|
1834
|
+
>
|
|
1835
|
+
> ### 参数:
|
|
1836
|
+
> - cookie: 用户 Cookie 字符串(用于身份认证)
|
|
1837
|
+
> - start_date: 查询起始日期,格式为 'MM-DD-YYYY',如 '04-01-2025'
|
|
1838
|
+
> - item_id: 视频 ID,例如 "7496499484705246507"
|
|
1839
|
+
> - product_id: 商品 ID,例如 "1731050202505515549"
|
|
1840
|
+
> - proxy: 可选 HTTP 代理地址,如不使用可省略
|
|
1841
|
+
> - 示例格式: `http://username:password@host:port`
|
|
1842
|
+
>
|
|
1843
|
+
> ### 返回内容说明:
|
|
1844
|
+
> - `segments`(数据分段列表):
|
|
1845
|
+
> - `time_selector`: 时间筛选参数(period, granularity, start_timestamp, end_timestamp)
|
|
1846
|
+
> - `filter`: 查询条件(creator_id, item_id, product_id)
|
|
1847
|
+
> - `timed_stats`: 按时间段分段的统计数据
|
|
1848
|
+
> - `start_timestamp`: 时间段开始时间戳
|
|
1849
|
+
> - `end_timestamp`: 时间段结束时间戳
|
|
1850
|
+
> - `stats`:
|
|
1851
|
+
> - `item_id`: 视频 ID
|
|
1852
|
+
> - `product_id`: 商品 ID
|
|
1853
|
+
> - `product_revenue.amount_formatted`: 商品产生的总收入(格式化字符串,如 "$100.00")
|
|
1854
|
+
> - `product_revenue.amount`: 商品产生的总收入(数值)
|
|
1855
|
+
> - `direct_revenue.amount_formatted`: 直接成交产生的收入(格式化字符串)
|
|
1856
|
+
> - `product_sales_cnt`: 商品销售数量
|
|
1857
|
+
> - `product_view_cnt`: 商品浏览量
|
|
1858
|
+
> - `product_click_cnt`: 商品点击量
|
|
1859
|
+
> - `order_cnt`: 生成订单数量
|
|
1860
|
+
>
|
|
1861
|
+
> ### 示例请求体:
|
|
1862
|
+
> ```json
|
|
1863
|
+
> {
|
|
1864
|
+
> "cookie": "your_cookie",
|
|
1865
|
+
> "start_date": "04-01-2025",
|
|
1866
|
+
> "item_id": "7496499484705246507",
|
|
1867
|
+
> "product_id": "1731050202505515549"
|
|
1868
|
+
> }
|
|
1869
|
+
> ```
|
|
1870
|
+
>
|
|
1871
|
+
> # [English]
|
|
1872
|
+
> ### Purpose:
|
|
1873
|
+
> - Retrieve detailed promotional statistics between a specific TikTok video and a specific product.
|
|
1874
|
+
> - Supports analyzing metrics such as product views, clicks, sales, order counts, product revenue, and direct revenue.
|
|
1875
|
+
> - The data is segmented by time intervals (daily/weekly/monthly) to observe trends over time.
|
|
1876
|
+
>
|
|
1877
|
+
> ### Notes:
|
|
1878
|
+
> - Requires both item_id (video ID) and product_id (product ID).
|
|
1879
|
+
> - The time range is based on the calendar month of the specified start_date.
|
|
1880
|
+
>
|
|
1881
|
+
> ### Return Description:
|
|
1882
|
+
> - `segments`:
|
|
1883
|
+
> - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp)
|
|
1884
|
+
> - `filter`: Query conditions (creator_id, item_id, product_id)
|
|
1885
|
+
> - `timed_stats`: Segmented statistics list
|
|
1886
|
+
> - `start_timestamp`: Start timestamp
|
|
1887
|
+
> - `end_timestamp`: End timestamp
|
|
1888
|
+
> - `stats`:
|
|
1889
|
+
> - `item_id`: Video ID
|
|
1890
|
+
> - `product_id`: Product ID
|
|
1891
|
+
> - `product_revenue.amount_formatted`: Total product revenue (formatted string, e.g., "$100.00")
|
|
1892
|
+
> - `product_revenue.amount`: Total product revenue (numeric)
|
|
1893
|
+
> - `direct_revenue.amount_formatted`: Direct sales revenue (formatted string)
|
|
1894
|
+
> - `product_sales_cnt`: Number of products sold
|
|
1895
|
+
> - `product_view_cnt`: Number of product views
|
|
1896
|
+
> - `product_click_cnt`: Number of product clicks
|
|
1897
|
+
> - `order_cnt`: Number of orders created
|
|
1898
|
+
>
|
|
1899
|
+
> ### Example Request Body:
|
|
1900
|
+
> ```json
|
|
1901
|
+
> {
|
|
1902
|
+
> "cookie": "your_cookie",
|
|
1903
|
+
> "start_date": "04-01-2025",
|
|
1904
|
+
> "item_id": "7496499484705246507",
|
|
1905
|
+
> "product_id": "1731050202505515549"
|
|
1906
|
+
> }
|
|
1907
|
+
> ```
|
|
1908
|
+
|
|
1909
|
+
#### Parameters
|
|
1910
|
+
|
|
1911
|
+
None
|
|
1912
|
+
|
|
1913
|
+
#### Request Body
|
|
1914
|
+
|
|
1915
|
+
- required: Yes
|
|
1916
|
+
|
|
1917
|
+
##### `application/json`
|
|
1918
|
+
|
|
1919
|
+
- Schema summary: `cookie`:string, `proxy`:string, `start_date`:string, `item_id*`:string, `product_id*`:string
|
|
1920
|
+
|
|
1921
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1922
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1923
|
+
| cookie | string | No | 用户 Cookie 字符串/User Cookie String | Your_Cookie_String | None | None |
|
|
1924
|
+
| proxy | string | No | 可选 HTTP 代理地址/Optional HTTP Proxy Address | None | None | None |
|
|
1925
|
+
| start_date | string | No | 查询开始时间,如 '04-01-2025'/ Query Start Date, e.g. '04-01-2025' | 04-01-2025 | None | None |
|
|
1926
|
+
| item_id | string | Yes | 视频 ID/Video ID | None | None | None |
|
|
1927
|
+
| product_id | string | Yes | 商品 ID/Product ID | None | None | None |
|
|
1928
|
+
|
|
1929
|
+
#### Success Response
|
|
1930
|
+
|
|
1931
|
+
##### `200 application/json`
|
|
1932
|
+
|
|
1933
|
+
- Schema summary: `code`:integer, `request_id`:string, `message`:string, `message_zh`:string, `support`:string, `time`:string, `time_stamp`:integer, `time_zone`:string, ...
|
|
1934
|
+
|
|
1935
|
+
| Field | Type | Required | Description | Default | Example | Enum |
|
|
1936
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
1937
|
+
| code | integer | No | HTTP status code \| HTTP状态码 | 200 | None | None |
|
|
1938
|
+
| request_id | string | No | Unique request identifier \| 唯一请求标识符 | None | None | None |
|
|
1939
|
+
| message | string | No | Response message (EN-US) \| 响应消息 (English) | Request successful. This request will incur a charge. | None | None |
|
|
1940
|
+
| message_zh | string | No | Response message (ZH-CN) \| 响应消息 (中文) | 请求成功,本次请求将被计费。 | None | None |
|
|
1941
|
+
| support | string | No | Support message \| 支持消息 | Discord: https://discord.gg/aMEAS8Xsvz | None | None |
|
|
1942
|
+
| time | string | No | The time the response was generated \| 生成响应的时间 | None | None | None |
|
|
1943
|
+
| time_stamp | integer | No | The timestamp the response was generated \| 生成响应的时间戳 | None | None | None |
|
|
1944
|
+
| time_zone | string | No | The timezone of the response time \| 响应时间的时区 | America/Los_Angeles | None | None |
|
|
1945
|
+
| docs | string | No | Link to the API Swagger documentation for this endpoint \| 此端点的 API Swagger 文档链接 | None | None | None |
|
|
1946
|
+
| cache_message | string | No | Cache message (EN-US) \| 缓存消息 (English) | This request will be cached. You can access the cached result directly using th… | None | None |
|
|
1947
|
+
| cache_message_zh | string | No | Cache message (ZH-CN) \| 缓存消息 (中文) | 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 | None | None |
|
|
1948
|
+
| cache_url | string | No | The URL to access the cached result \| 访问缓存结果的 URL | None | None | None |
|
|
1949
|
+
| router | string | No | The endpoint that generated this response \| 生成此响应的端点 | None | None | None |
|
|
1950
|
+
| params | dynamic object | No | The parameters used in the request \| 请求中使用的参数 | None | None | None |
|
|
1951
|
+
| data | null | No | The response data \| 响应数据 | None | None | None |
|