Get Shop Video Product Performance List

GET

/analytics/202509/shop_videos/{video_id}/products/performance

Returns performance metrics for a list of products promoted in a given video.

Authorizations

• accessToken

Parameters

Path Parameters

video_id

required

string

The ID of the shop video whose promoted product performance list is requested.

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

end_date_lt

required

string format: date

End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. It must be later than start_date_ge. In the parameter name, “lt” refers to “less than” (exclusive)

page_size

integer format: int64

>= 1 <= 100

Number of products per page. Min value: 1 Max value: 100 Default value: 10

sort_field

string

Allowed values: gmv units_sold daily_avg_buyers

Sort on. Available values: gmv, units_sold, daily_avg_buyers Default value: gmv

sort_order

string

Allowed values: ASC DESC

Sort direction. Available values: ASC, DESC Default value: DESC

• ASC: ascending
• DESC: descending

currency

string

Allowed values: USD LOCAL

Currency. Available values: USD, LOCAL Default value: LOCAL

• USD: US dollars
• LOCAL: local currency where the shop is located

page_token

string

Page token, indicating the current position. Used for requesting next page data. Leave this field empty for first time queries.

start_date_ge

required

string format: date

Start date (ISO 8601 YYYY-MM-DD format) in shop registered timezone. In the parameter name, “ge” refers to “greater than or equal to” (inclusive)

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

latest_available_date

Latest date in local timezone where data is ready (ISO 8601 format).

string format: date

next_page_token

Page token for the next page request. If this value is nonempty, pass it as page_token in the next request and reuse the same video_id, start_date_ge, end_date_lt, sort_field, sort_order, currency, and page_size values. An empty value means that there are no more pages.

string

products

List of product performance metrics.

Array<object>

object

ctr

Ratio of product clicks to product impressions in raw decimal format.

string

customers

Number of customers who purchased the product.

integer format: int64

daily_avg_buyers

Average number of buyers per day for the current product.

string

gmv

Overall Gross Merchandise Value (GMV) for the product.

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

gpm

Average GMV generated per 1,000 product impressions.

object

amount

GPM amount in the corresponding currency.

string

currency

GPM 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

id

The ID of the product promoted in the video.

string

name

The name of the product promoted in the video.

string

product_clicks

Number of product clicks.

integer format: int64

product_impressions

Number of product impressions.

integer format: int64

units_sold

Number of units sold for the current product.

integer format: int64

total_count

Total number of products matching the request across all pages.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "latest_available_date": "2024-09-07",
    "next_page_token": "cGFnZV9udW1iZXI9MQ==",
    "products": [
      {
        "ctr": "0",
        "customers": 0,
        "daily_avg_buyers": "0",
        "gmv": {
          "amount": "0",
          "currency": "USD"
        },
        "gpm": {
          "amount": "0",
          "currency": "USD"
        },
        "id": "105xxxxxxxxxxxxx247",
        "name": "Product Name",
        "product_clicks": 0,
        "product_impressions": 0,
        "units_sold": 0
      }
    ],
    "total_count": 10
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}