Get Shop Product Performance Detail

GET

/analytics/202509/shop_products/{product_id}/performance

Returns detailed performance metrics for the specified product.

Authorizations

accessToken

Parameters

Path Parameters

product_id

required

string

The ID of the product 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 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 of the requested range in the shop’s registered timezone, in ISO 8601 YYYY-MM-DD format. This date is exclusive and 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

Allowed values: USD LOCAL

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

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

Responses

200

Success

application/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

performance

Overall performance data for the product.

object

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

sales

Sales performance within the interval.

object

gmv

Gross merchandise value: Total amount paid for orders during the selected period, including canceled and refunded orders.

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

orders

Total (sum of all) orders for the product.

integer format: int64

items_sold

Number of items sold for the product.

integer format: int64

breakdowns

Sales breakdowns.

Array<object>

object

content_type

Sales breakdown content type. Possible values:

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

string

Allowed values: VIDEO LIVE PRODUCT_CARD

sales

Sales of the corresponding content type.

object

gmv

Gross merchandise value.

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

items_sold

Number of items sold in the corresponding content type.

integer format: int64

avg_customers

Daily average count of customers.

integer format: int64

traffic

Traffic performance.

object

breakdowns

Traffic breakdowns.

Array<object>

object

traffic

Traffic performance of the corresponding content type.

object

impressions

Each time a link to your listing appears in the shop tab, it’s counted as one impression. Users can tap links to visit your listings page directly.

integer format: int64

page_views

Total number of product details page views during the selected period, including multiple views from unique users.

integer format: int64

avg_unique_page_views

Daily average unique views visitors to your product details pages.

integer format: int64

ctr

The percentage of viewers who clicked on product links after seeing them in the Shop tab. Number of clicks divided by the number of views.

string

avg_conversion_rate

Average percentage of unique page views that result in sales.

string

content_type

Traffic breakdown content type. Possible values:

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

string

Allowed values: VIDEO LIVE PRODUCT_CARD

cancel_and_refunds

Cancel and refunds data

object

returned

Returned refers to units that were returned and refunded.

integer format: int64

canceled

Canceled refers to units included in orders that were either “Unpaid” or “Awaiting Shipment.”

integer format: int64

refunded

Refunded refers to units that were refunded but not returned.

integer format: int64

replacements

Replacements refers to units that were returned and replaced.

integer format: int64

ratings

Ratings within the choosen start_date_ge and end_date_ge

Array<object>

object

stars

Rating star bucket. Possible values:

1_STAR: One-star rating.
2_STAR: Two-star rating.
3_STAR: Three-star rating.
4_STAR: Four-star rating.
5_STAR: Five-star rating.

string

Allowed values: 1_STAR 2_STAR 3_STAR 4_STAR 5_STAR

count

Number of reviews in the corresponding rating.

integer format: int64

percentage

Share of all product reviews in the corresponding rating bucket. The value is the bucket’s review count divided by the total product review count and is returned as a decimal from 0 to 1, rounded to four decimal places. For example, 0.23 means 23%.

string

top_contents

Product-related content for the period from start_date_ge (inclusive) to end_date_lt (exclusive). Sorted by GMV; returns only the top 100.

Array<object>

object

type

Example

{
  "code": 0,
  "data": {
    "performance": {
      "intervals": [
        {
          "start_date": "2024-04-01",
          "end_date": "2024-04-08",
          "sales": {
            "gmv": {
              "amount": "233",
              "currency": "USD"
            },
            "orders": 23,
            "items_sold": 23,
            "breakdowns": [
              {
                "content_type": "LIVE",
                "sales": {
                  "gmv": {
                    "amount": "43",
                    "currency": "USD"
                  },
                  "items_sold": 454,
                  "avg_customers": 34
                }
              }
            ]
          },
          "traffic": {
            "breakdowns": [
              {
                "traffic": {
                  "impressions": 34,
                  "page_views": 43,
                  "avg_unique_page_views": 34,
                  "ctr": "0.034",
                  "avg_conversion_rate": "0.033"
                },
                "content_type": "LIVE"
              }
            ]
          },
          "cancel_and_refunds": {
            "returned": 2,
            "canceled": 23,
            "refunded": 3,
            "replacements": 3
          }
        }
      ],
      "ratings": [
        {
          "stars": "1_STAR",
          "count": 23,
          "percentage": "0.23"
        }
      ],
      "top_contents": [
        {
          "type": "LIVE",
          "contents": [
            {
              "content_id": "2304002883",
              "items_sold": 23,
              "gmv": {
                "amount": "323",
                "currency": "GBP"
              }
            }
          ]
        }
      ],
      "top_creators": [
        {
          "creator_open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg",
          "creator_name": "nick.name",
          "creator_profile": "https://www.example.com/images/creator-profile.webp",
          "gmv": {
            "amount": "2365",
            "currency": "GBP"
          },
          "items_sold": 32
        }
      ]
    },
    "latest_available_date": "2024-04-07"
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}

Get Shop Product Performance Detail

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

Start here

SDKs

OpenAPI