Get Video Performances

GET

/analytics/202403/videos/performances

Use this US-creator-only API to retrieve TikTok e-commerce video metrics, including anchor_display_rate, click_through_rate, orders, items_sold, and GMV, for the requested videos.

Authorizations

• accessToken

Parameters

Query Parameters

video_ids

required

string

Comma-separated video IDs for which to retrieve e-commerce metrics. All video IDs must belong to the same author. Maximum: 100 video IDs per request.

start_time_ge

required

integer format: int64

Start date for the metrics, set with a one-day delay from today due to latency in the data pipeline. The start_time parameter must be within the last 180 days from the current date. Only date value is processed, hour/mininute/second values will be ignored. For example, if the start_time value is: 1703507696 (“26-12-2023 04:34:56”), backend service will only consider the part “26-12-2023” when doing the query because by default, in offline data analytics, there is no hour/min/sec data level.

end_time_le

required

integer format: int64

End date for the metrics, set with a one-day delay from today due to latency in the data pipeline. Only date value is processed, hour/mininute/second values will be ignored.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

videos

Contains a list of video objects. The inner list of objects will be organized in ascending order based on the video_id field.

Array<object>

object

id

The video ID. The performances array contains the daily metrics for this video.

string

performances

The list of objects within will be arranged in ascending order based on the start_time field.

Array<object>

object

time_range

Time range object

object

start_time

Date of the metrics.

integer format: int64

end_time

Date of the metrics.

integer format: int64

metrics

Performance metrics for this video.

object

anchor_display_rate

Display rate for anchors, specified with two decimal numbers.

string

click_through_rate

Click through rate, specified with two decimal numbers.

string

order_count

Number of orders in this date.

integer format: int64

item_sold_count

Number of sold items in this date.

integer format: int64

gmv

Gross merchandise value (GMV) for this video.

object

amount

GMV amount in the corresponding currency.

string

currency

GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP).

string

Example

{
  "code": 0,
  "data": {
    "videos": [
      {
        "id": "7271486684427046149",
        "performances": [
          {
            "time_range": {
              "start_time": 1704067200,
              "end_time": 1704067200
            },
            "metrics": {
              "anchor_display_rate": "0.64",
              "click_through_rate": "0.08",
              "order_count": 3,
              "item_sold_count": 3,
              "gmv": {
                "amount": "27.85",
                "currency": "USD"
              }
            }
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}