# 获取作品流量来源统计/Fetch item play source statistics

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/creator_v2/fetch_item_play_source:
    post:
      summary: 获取作品流量来源统计/Fetch item play source statistics
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取抖音作品的流量来源统计数据

        - 流量来源统计了作品从不同途径播放的占比

        - **若暂时没有看到某个渠道，说明对应渠道暂时没有播放**

        - **作品刚发布推荐页流量占比可能偏低，请等待系统推流**

        - **此接口需要用户提供有效的抖音创作者平台Cookie**

        - **使用 POST 方法，Cookie 在请求体中传输，更安全**


        ### 请求体参数:

        - cookie: 用户的抖音创作者平台Cookie（必填，在请求体中传输）

        - item_id: 作品ID（必填）


        ### 返回数据说明:

        - play_source: 流量来源列表，包含各渠道的播放占比
          - key: 流量来源渠道标识
          - value: 当前占比（0-1之间的小数，如0.85表示85%）
          - history_difference: 与历史数据的差异
          - app_id: 应用ID

        ### 流量来源渠道说明:

        - **homepage_hot**: 推荐页（系统推荐流量）

        - **familiar**: 朋友页（关注的人、好友推荐）

        - **search**: 搜索（用户主动搜索）

        - **homepage**: 个人主页（访问主页观看）

        - **message**: 消息页（通过消息入口）

        - **other**: 其他（其他途径）


        ### Cookie 获取方式:

        1. 登录抖音创作者平台 (https://creator.douyin.com)

        2. 打开浏览器开发者工具（F12）

        3. 切换到 Network 标签

        4. 刷新页面或进行操作

        5. 找到任意请求，复制 Cookie 请求头的值


        # [English]

        ### Purpose:

        - Get Douyin item play source statistics

        - Statistics of the proportion of item views from different sources

        - **If a channel is not shown, it means there are no views from that
        channel yet**

        - **For newly published items, the recommended page traffic may be low
        initially, please wait for system distribution**

        - **This API requires users to provide valid Douyin Creator Platform
        Cookie**

        - **Use POST method, Cookie is transmitted in request body, more
        secure**


        ### Request Body Parameters:

        - cookie: User's Douyin Creator Platform Cookie (required, transmitted
        in request body)

        - item_id: Item ID (required)


        ### Return Data Description:

        - play_source: List of traffic sources with play proportion for each
        channel
          - key: Traffic source channel identifier
          - value: Current proportion (decimal between 0-1, e.g., 0.85 means 85%)
          - history_difference: Difference from historical data
          - app_id: Application ID

        ### Traffic Source Channel Description:

        - **homepage_hot**: Recommended page (system recommendation traffic)

        - **familiar**: Friends page (followed people, friend recommendations)

        - **search**: Search (user active search)

        - **homepage**: Personal homepage (views from homepage visits)

        - **message**: Message page (through message entry)

        - **other**: Other (other sources)


        ### How to get Cookie:

        1. Login to Douyin Creator Platform (https://creator.douyin.com)

        2. Open browser developer tools (F12)

        3. Switch to Network tab

        4. Refresh page or perform operations

        5. Find any request and copy the Cookie header value


        # [示例/Example]

        ```json

        {
            "cookie": "Your_Cookie_Here",
            "item_id": "7559536212910853422"
        }

        ```


        ### 返回数据示例/Response Example:

        ```json

        {
            "play_source": [
                {
                    "app_id": 1128,
                    "history_difference": 0.8543689320388349,
                    "key": "homepage_hot",
                    "value": 0.8543689320388349
                },
                {
                    "app_id": 1128,
                    "history_difference": 0.05825242718446602,
                    "key": "familiar",
                    "value": 0.05825242718446602
                },
                {
                    "app_id": 1128,
                    "history_difference": 0.04854368932038835,
                    "key": "search",
                    "value": 0.04854368932038835
                }
            ],
            "status_code": 0,
            "status_msg": ""
        }

        ```


        ### 数据解读/Data Interpretation:

        - value 值表示该渠道的流量占比，例如 0.85 表示 85% 的流量来自该渠道

        - homepage_hot 占比高说明作品获得了较好的系统推荐

        - familiar 占比高说明作品在关注用户中传播较好

        - search 占比高说明作品搜索热度高
      operationId: >-
        fetch_item_play_source_api_v1_douyin_creator_v2_fetch_item_play_source_post
      tags:
        - Douyin-Creator-V2-API
        - Douyin-Creator-V2-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemPlaySourceRequest'
              description: 作品流量来源统计请求参数/Item play source statistics request parameters
            example:
              cookie: Your_Cookie_Here
              item_id: '7559536212910853422'
      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: '-HEsVYw4pHzS31jm_OQdJ'
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: '-HEsVYw4pHzS31jm_OQdJ'
            scopes:
              '-HEsVYw4pHzS31jm_OQdJ':
                HTTPBearer: []
      x-apifox-folder: Douyin-Creator-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-359719862-run
components:
  schemas:
    ItemPlaySourceRequest:
      properties:
        cookie:
          type: string
          title: Cookie
          description: 用户Cookie/User Cookie
          examples:
            - Your_Cookie_Here
        item_id:
          type: string
          title: Item Id
          description: 作品ID/Item ID
          examples:
            - '7559536212910853422'
      type: object
      required:
        - cookie
        - item_id
      title: ItemPlaySourceRequest
      description: |-
        作品流量来源统计请求模型
        Item Play Source Statistics Request Model
      x-apifox-orders:
        - cookie
        - item_id
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    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: []

```