Get Shop Video Performance Overview

GET

/analytics/202609/shop_videos/overview_performance

Returns overall performance metrics for all videos under a shop.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

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)

end_date_lt

required

string format: date

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

today

boolean

If “today” is set to true, start_date_ge and end_date_lt will be overwritten. The response will contain real-time metrics of today (local time)

granularity

string

Allowed values: ALL 1D

Granularity of the data. Available values: ALL, 1D Default value: ALL

• ALL: aggregate
• 1D: daily

currency

string

Allowed values: USD LOCAL

Currently, only local currency is supported in the response.

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

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

account_type

string

Allowed values: ALL OFFICIAL_ACCOUNTS MARKETING_ACCOUNTS AFFILIATE_ACCOUNTS

Types of the accounts under which videos were created. Available values:

• ALL: All account types.
• OFFICIAL_ACCOUNTS: Official accounts.
• MARKETING_ACCOUNTS: Marketing accounts.
• AFFILIATE_ACCOUNTS: Affiliate accounts. Default value: ALL

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

performance

Overall performance data for videos.

object

intervals

Interval data for the requested time range. The time range of each interval is determined by the granularity.

Array<object>

object

avg_daily_customers

Daily average number of customers.

integer format: int64

ctor_sku_order

Conversion rate from product clicks to SKU orders in raw decimal format.

string

ctr

Ratio of product clicks to video views in raw decimal format.

string

end_date

End date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive.

string format: date

gpm

GMV per thousand video views. Returned only for offline data.

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

product_clicks

The number of product clicks from videos.

integer format: int64

product_impressions

The number of impressions of all video products.

integer format: int64

shoppable_video_attributed_gmv

GMV attributed to shoppable videos. Returned only for offline data.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

start_date

Start date of the interval (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive.

string format: date

today

Whether the interval contains real-time data for today.

boolean

video_attributed_gmv

GMV attributed to videos.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

video_attributed_sku_orders

The number of paid SKU orders attributed to videos.

integer format: int64

video_gmv

GMV from videos.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

video_indirect_gmv

Indirect GMV from videos.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

video_product_viewers

The number of users who viewed products from videos. Returned only for offline data.

integer format: int64

video_views

The number of video views. Returned only for offline data.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "latest_available_date": "2024-09-08",
    "performance": {
      "intervals": [
        {
          "avg_daily_customers": 23,
          "ctor_sku_order": "0.0528",
          "ctr": "0.0528",
          "end_date": "2024-09-08",
          "gpm": {
            "amount": "0.00",
            "currency": "USD"
          },
          "product_clicks": 23,
          "product_impressions": 23,
          "shoppable_video_attributed_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "start_date": "2024-09-01",
          "today": false,
          "video_attributed_gmv": {
            "amount": "246.80",
            "currency": "USD"
          },
          "video_attributed_sku_orders": 13,
          "video_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "video_indirect_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "video_product_viewers": 500,
          "video_views": 1000
        }
      ]
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}