# 获取作品的统计数据/Get video metrics ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/tiktok/analytics/fetch_video_metrics: get: summary: 获取作品的统计数据/Get video metrics deprecated: false description: >- # [中文] ### 用途: - 获取TikTok视频的详细统计数据，包括观看量、点赞数、评论数和收藏数等核心指标 - 提供总量统计以及从发布日期起14天的每日趋势数据，便于分析视频表现 - 帮助创作者分析内容效果，评估用户互动情况，优化内容策略 ### 参数: - item_id: 视频作品ID，必填参数，可从视频分享链接或TikTok Studio获取 ### 返回内容说明: - `item_id`: 请求的视频ID - `video_views`: 视频总观看次数 - `value`: 观看次数数值 - `video_views_14_days`: 近14天的每日观看量趋势数据 - `interval`: 数据间隔类型 - `value`: 每日数据列表 - `likes`: 视频总点赞数 - `value`: 点赞数值 - `likes_14_days`: 近14天的每日点赞数趋势数据 - `comments`: 视频总评论数 - `value`: 评论数值 - `comments_14_days`: 近14天的每日评论数趋势数据 - `favorites`: 视频总收藏数 - `value`: 收藏数值 - `favorites_14_days`: 近14天的每日收藏数趋势数据 - `video_summary`: 视频表现的概览分析 - `title`: 概览标题 - `content`: 概览内容 - `summary_type`: 概览类型 ### 示例响应: ```json { "code": 200, "router": "/api/v1/tiktok/analytics/fetch_video_metrics", "params": { "item_id": "7502551047378832671" }, "data": { "item_id": "7502551047378832671", "video_views": { "value": 1555500 }, "likes": { "value": 11571 }, "comments": { "value": 6920 }, "favorites": { "value": 1243 }, "video_summary": { "title": "Overview", "content": "This post received more comments per view than most other posts." } } } ``` # [English] ### Purpose: - Retrieve detailed analytics data for TikTok videos, including views, likes, comments, and favorites - Provide total statistics and daily trends for 14 days since the release date, facilitating video performance analysis - Help creators analyze content effectiveness, evaluate user engagement, and optimize content strategy ### Parameters: - item_id: Video ID, required parameter, can be obtained from video sharing links or TikTok Studio ### Return Description: - `item_id`: The requested video ID - `video_views`: Total number of video views - `value`: View count value - `video_views_14_days`: Daily view trends for the past 14 days - `interval`: Data interval type - `value`: List of daily data - `likes`: Total number of likes on the video - `value`: Like count value - `likes_14_days`: Daily like trends for the past 14 days - `comments`: Total number of comments on the video - `value`: Comment count value - `comments_14_days`: Daily comment trends for the past 14 days - `favorites`: Total number of times the video was favorited - `value`: Favorite count value - `favorites_14_days`: Daily favorite trends for the past 14 days - `video_summary`: Overview analysis of video performance - `title`: Overview title - `content`: Overview content - `summary_type`: Overview type ### Example Response: ```json { "code": 200, "router": "/api/v1/tiktok/analytics/fetch_video_metrics", "params": { "item_id": "7502551047378832671" }, "data": { "item_id": "7502551047378832671", "video_views": { "value": 1555500 }, "likes": { "value": 11571 }, "comments": { "value": 6920 }, "favorites": { "value": 1243 }, "video_summary": { "title": "Overview", "content": "This post received more comments per view than most other posts." } } } ``` operationId: fetch_video_metrics_api_v1_tiktok_analytics_fetch_video_metrics_get tags: - TikTok-Analytics-API - TikTok-Analytics-API parameters: - name: item_id in: query description: 作品id/Video id required: true example: '7502551047378832671' schema: type: string description: 作品id/Video id title: Item Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' headers: {} x-apifox-name: OK '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' headers: {} x-apifox-name: Unprocessable Entity security: - HTTPBearer: [] x-apifox: schemeGroups: - id: AThNPQW0fxUETMHTStcA_ schemeIds: - HTTPBearer required: true use: id: AThNPQW0fxUETMHTStcA_ scopes: AThNPQW0fxUETMHTStcA_: HTTPBearer: [] x-apifox-folder: TikTok-Analytics-API x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-298317626-run components: schemas: ResponseModel: properties: code: type: integer title: Code description: HTTP status code | HTTP状态码 default: 200 request_id: anyOf: - type: string - type: 'null' title: Request Id description: Unique request identifier | 唯一请求标识符 message: type: string title: Message description: Response message (EN-US) | 响应消息 (English) default: Request successful. This request will incur a charge. message_zh: type: string title: Message Zh description: Response message (ZH-CN) | 响应消息 (中文) default: 请求成功，本次请求将被计费。 support: type: string title: Support description: Support message | 支持消息 default: 'Discord: https://discord.gg/aMEAS8Xsvz' time: type: string title: Time description: The time the response was generated | 生成响应的时间 time_stamp: type: integer title: Time Stamp description: The timestamp the response was generated | 生成响应的时间戳 time_zone: type: string title: Time Zone description: The timezone of the response time | 响应时间的时区 default: America/Los_Angeles docs: anyOf: - type: string - type: 'null' title: Docs description: >- Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接 cache_message: anyOf: - type: string - type: 'null' title: Cache Message description: Cache message (EN-US) | 缓存消息 (English) default: >- This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again. cache_message_zh: anyOf: - type: string - type: 'null' title: Cache Message Zh description: Cache message (ZH-CN) | 缓存消息 (中文) default: >- 本次响应已缓存，可通过下方 URL 直接查看，有效期 24 小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。 cache_url: anyOf: - type: string - type: 'null' title: Cache Url description: The URL to access the cached result | 访问缓存结果的 URL router: type: string title: Router description: The endpoint that generated this response | 生成此响应的端点 default: '' params: type: string data: anyOf: - type: string - type: 'null' title: Data description: The response data | 响应数据 type: object title: ResponseModel x-apifox-orders: - code - request_id - message - message_zh - support - time - time_stamp - time_zone - docs - cache_message - cache_message_zh - cache_url - router - params - data x-apifox-ignore-properties: [] x-apifox-folder: '' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError x-apifox-orders: - detail x-apifox-ignore-properties: [] x-apifox-folder: '' ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError x-apifox-orders: - loc - msg - type x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: HTTPBearer: type: bearer description: > ---- #### API Token Introduction: ##### Method 1: Use API Token in the Request Header (Recommended) - **Header**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: Click on the `Authorize` button in the upper right corner of the page to enter the API token directly without the `Bearer` keyword. ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only When Method 1 is Unavailable) - **Cookie**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `Authorization=Bearer your_token` #### Get API Token: 1. Register and log in to your account on the TikHub website. 2. Go to the user center, click on the API token menu, and create an API token. 3. Copy and use the API token in the request header. 4. Keep your API token confidential and use it only in the request header. ---- #### API令牌简介: ##### 方法一：在请求头中使用API令牌（推荐） - **请求头**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。 ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用） - **Cookie**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `Authorization=Bearer your_token` #### 获取API令牌: 1. 在TikHub网站注册并登录账户。 2. 进入用户中心，点击API令牌菜单，创建API令牌。 3. 复制并在请求头中使用API令牌。 4. 保密您的API令牌，仅在请求头中使用。 scheme: bearer servers: - url: https://api.tikhub.io description: Production Environment security: [] ```