Get Shop LIVE Performance Overview

GET

/analytics/202609/shop_lives/overview_performance

Returns overall performance metrics for all LIVE stream sessions under a certain 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: Aggregate data for the full requested time range.
• 1D: Daily data. Default value: ALL

currency

string

Allowed values: USD LOCAL

Currently, only local currency is supported in the response.

Available values:

• USD: US dollars.
• LOCAL: Local currency where the shop is located. Default value: LOCAL

account_type

string

Allowed values: ALL LINKED_ACCOUNTS AFFILIATE_ACCOUNTS

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

• ALL: All account types.
• LINKED_ACCOUNTS: Linked 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 livestream.

object

intervals

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

Array<object>

object

avg_live_auction_price

Average price per item sold for LIVE auction products.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

avg_viewing_duration

Average viewing duration in seconds.

integer format: int64

ctor_sku_order

Ratio of LIVE-attributed SKU orders to product clicks 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

live_attributed_gmv

GMV attributed to LIVE streams.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

live_attributed_items_sold

Number of items sold attributed to LIVE streams.

integer format: int64

live_attributed_sku_orders

Number of paid SKU orders attributed to LIVE streams.

integer format: int64

live_auction_attributed_gmv

GMV attributed to LIVE auction products.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

live_auction_attributed_items_sold

Number of items sold attributed to LIVE auction products.

integer format: int64

live_auction_attributed_sku_orders

Number of paid SKU orders attributed to LIVE auction products.

integer format: int64

live_ctr

Ratio of product clicks to product impressions from LIVE streams in raw decimal format.

string

live_gmv

Direct GMV generated from LIVE streams.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

live_indirect_gmv

Indirect GMV generated from LIVE streams.

object

amount

Amount in the corresponding currency.

string

currency

Currency code (ISO 4217 standard).

string

show_gpm

LIVE-attributed GMV generated per 1,000 impressions.

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

views

Number of LIVE views.

integer format: int64

updated_at

Time when the data was last updated in shop registered timezone.

string

Example

{
  "code": 0,
  "data": {
    "latest_available_date": "2024-09-07",
    "performance": {
      "intervals": [
        {
          "avg_live_auction_price": {
            "amount": "0.00",
            "currency": "USD"
          },
          "avg_viewing_duration": 0,
          "ctor_sku_order": "0.0000",
          "end_date": "2026-09-02",
          "live_attributed_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "live_attributed_items_sold": 0,
          "live_attributed_sku_orders": 0,
          "live_auction_attributed_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "live_auction_attributed_items_sold": 0,
          "live_auction_attributed_sku_orders": 0,
          "live_ctr": "0.0000",
          "live_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "live_indirect_gmv": {
            "amount": "0.00",
            "currency": "USD"
          },
          "show_gpm": {
            "amount": "0.00",
            "currency": "USD"
          },
          "start_date": "2026-08-27",
          "views": 0
        }
      ]
    },
    "updated_at": "2026-09-02 21:25:00"
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}