Get Shop SKU Performance Detail

GET

/analytics/202509/shop_skus/{sku_id}/performance

Returns performance metrics for the specified SKU.

Authorizations

• accessToken

Parameters

Path Parameters

sku_id

required

string

The ID of the SKU whose performance metrics are requested.

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 time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive.

end_date_lt

required

string format: date

End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. It must be later than start_date_ge.

granularity

string

Allowed values: ALL 1D

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

• ALL: aggregate
• 1D: daily

currency

string

Currency:

• USD: US dollars
• LOCAL (default): Local currency where the shop is located

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 the SKU.

object

product_id

The ID of the product that the SKU belongs to.

integer format: int64

sku_id

The ID of the SKU for this performance object.

string

intervals

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

Array<object>

object

start_date

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

string format: date

end_date

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

string format: date

gmv

Overall Gross Merchandise Value (GMV) for the SKU.

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

gmv_breakdown

GMV breakdowns for the SKU.

Array<object>

object

amount

GMV amount for the corresponding type and 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

type

GMV breakdown type. Possible values:

• LIVE: Live stream content.
• VIDEO: Video content.
• PRODUCT_CARD: Product card.

string

Allowed values: LIVE VIDEO PRODUCT_CARD

items_sold

Number of units sold for the SKU.

integer format: int64

items_sold_breakdown

Unit sold breakdowns.

Array<object>

object

amount

Number of units sold for the corresponding type.

integer format: int64

type

Items-sold breakdown type. Possible values:

• LIVE: Live stream content.
• VIDEO: Video content.
• PRODUCT_CARD: Product card.

string

Allowed values: LIVE VIDEO PRODUCT_CARD

sku_orders

Total (sum of all) orders for the SKU.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "latest_available_date": "2024-04-07",
    "performance": {
      "product_id": 123456789,
      "sku_id": "123456789",
      "intervals": [
        {
          "start_date": "2024-04-01",
          "end_date": "2024-04-07",
          "gmv": {
            "amount": "135.42",
            "currency": "USD"
          },
          "gmv_breakdown": [
            {
              "amount": "82.15",
              "currency": "USD",
              "type": "LIVE"
            }
          ],
          "items_sold": 10,
          "items_sold_breakdown": [
            {
              "amount": 10,
              "type": "LIVE"
            }
          ],
          "sku_orders": 10
        }
      ]
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}