# 获取作品总览数据/Fetch item overview data

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/creator_v2/fetch_item_overview_data:
    post:
      summary: 获取作品总览数据/Fetch item overview data
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取抖音作品总览数据，包括流量指标、审核状态、播放信息等

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

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


        ### 请求体参数:

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

        - ids: 作品ID列表，多个ID用逗号分隔（例如: "7559536212910853422,7559536212910853423"）

        - fields: 需要返回的字段，默认为
        "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis"
          - 可选字段（用逗号分隔，可自行组合）:
            - metrics: 流量指标数据（播放量、点赞量、评论量等）
            - review: 审核状态信息
            - play_info: 播放相关信息
            - dou_plus: 抖+推广信息
            - integrated_incentive: 综合激励数据
            - incentive_life: 激励生命周期信息
            - content_analysis: 内容分析数据

        ### 返回:

        - 作品总览数据，根据 fields 参数返回对应的字段内容


        ### Cookie 获取方式:

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

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

        3. 切换到 Network 标签

        4. 刷新页面或进行操作

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


        # [English]

        ### Purpose:

        - Get Douyin item overview data, including traffic metrics, review
        status, play info, etc.

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

        - ids: Item ID list, separated by comma (e.g.,
        "7559536212910853422,7559536212910853423")

        - fields: Fields to return, default is
        "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis"
          - Available fields (comma-separated, customizable):
            - metrics: Traffic metrics data (views, likes, comments, etc.)
            - review: Review status information
            - play_info: Play related information
            - dou_plus: DOU+ promotion information
            - integrated_incentive: Integrated incentive data
            - incentive_life: Incentive lifecycle information
            - content_analysis: Content analysis data

        ### Return:

        - Item overview data, returns corresponding fields based on the fields
        parameter


        ### 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",
            "ids": "7559536212910853422",
            "fields": "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis"
        }

        ```


        ### 字段组合示例/Field Combination Examples:

        - 只获取流量指标: "metrics"

        - 获取流量和审核: "metrics,review"

        - 获取所有字段:
        "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis"
      operationId: >-
        fetch_item_overview_data_api_v1_douyin_creator_v2_fetch_item_overview_data_post
      tags:
        - Douyin-Creator-V2-API
        - Douyin-Creator-V2-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemMgetRequest'
              description: 作品总览数据请求参数/Item overview data request parameters
            example:
              cookie: Your_Cookie_Here
              ids: '7559536212910853422'
              fields: >-
                metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis
      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: EDkqdd1KODX5kOQjbVqx2
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: EDkqdd1KODX5kOQjbVqx2
            scopes:
              EDkqdd1KODX5kOQjbVqx2:
                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-359719861-run
components:
  schemas:
    ItemMgetRequest:
      properties:
        cookie:
          type: string
          title: Cookie
          description: 用户Cookie/User Cookie
          examples:
            - Your_Cookie_Here
        ids:
          type: string
          title: Ids
          description: 作品ID列表,多个ID用逗号分隔/Item IDs, separated by comma
          examples:
            - 7559536212910853422,7559536212910853423
        fields:
          anyOf:
            - type: string
            - type: 'null'
          title: Fields
          description: >-
            需要返回的字段,多个字段用逗号分隔/Fields to return, separated by comma. 可选值:
            metrics(指标),review(审核),play_info(播放信息),dou_plus(抖+),integrated_incentive(综合激励),incentive_life(激励生命周期),content_analysis(内容分析)
          default: >-
            metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis
      type: object
      required:
        - cookie
        - ids
      title: ItemMgetRequest
      description: |-
        作品总览数据请求模型
        Item Overview Data Request Model
      x-apifox-orders:
        - cookie
        - ids
        - fields
      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: []

```