Skip to content
TikTok Shop Partner API

Get Shop Performance

GET
/analytics/202609/shop/performance

Returns performance metrics at shop/seller level.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “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)

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.

Available values: USD, LOCAL Default value: LOCAL

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

Responses

Section titled “Responses”

200

Section titled “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 shop.

object
intervals

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

Array<object>
object
breakdowns

Breakdowns of performance data by content type, channel, and attribution.

object
affiliate_product_card_attributed_gmv

GMV attributed to affiliate product cards.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
content_breakdown

GMV breakdown by content type and channel.

Array<object>
object
channel

Channel type. Possible values: CREATOR, SELLER

string
Allowed values: CREATOR SELLER
content_type

Content type. Possible values: LIVE, VIDEO

string
Allowed values: LIVE VIDEO
gmv

GMV for this content type and channel.

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
indirect_gmv

Indirect GMV for this content type and channel.

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
seller_product_card_gmv

GMV from seller product cards.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
shop_tab_and_search

Attribution breakdown by shop tab and search.

object
others

GMV from other attribution sources.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
search_attributed

GMV attributed to search.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
shop_tab_attributed

GMV attributed to shop tab.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
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
avg_order_value

Average order value during the selected period.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
avg_sku_order_value

Average SKU order value during the selected period.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
cancellations_and_returns

Total number of cancellations and returns during the selected period.

integer format: int64
creator_live_attributed_gmv

GMV attributed to creator live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
creator_live_gmv

GMV from creator live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
creator_live_indirect_gmv

Indirect GMV from creator live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
creator_video_attributed_gmv

GMV attributed to creator videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
creator_video_gmv

GMV from creator videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
creator_video_indirect_gmv

Indirect GMV from creator videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
customers_count

Number of unique users who paid for orders during the selected period.

integer format: int64
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
gmv_with_tax

GMV including tax.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
gmv_with_tiktok_co_funding

GMV including TikTok co-funding.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
items_sold

The total number of individual items sold. Example: If a customer buys 3 units of SKU A and 2 units of SKU B, the items sold would be 5.

integer format: int64
live_attributed_gmv

GMV attributed to live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
live_gmv

GMV from live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
live_indirect_gmv

Indirect GMV from live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
orders_count

The number of paid orders during the selected period.

integer format: int64
product_card_attributed_gmv

GMV attributed to product cards.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
refunds

The amount of order refunds generated.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
seller_live_attributed_gmv

GMV attributed to seller live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
seller_live_gmv

GMV from seller live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
seller_live_indirect_gmv

Indirect GMV from seller live streams.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
seller_video_attributed_gmv

GMV attributed to seller videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
seller_video_gmv

GMV from seller videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
seller_video_indirect_gmv

Indirect GMV from seller videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
shipping_fees

Total shipping fees during the selected period.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
sku_orders_count

A total count of distinct SKUs sold.

integer format: int64
tax

Tax amount during the selected period.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
video_attributed_gmv

GMV attributed to videos.

object
amount

Amount in the corresponding currency.

string
currency

Currency code (ISO 4217 standard).

string
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
start_date

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

string format: date
traffic

Traffic data for the interval.

object
avg_conversation_rate

The daily average percentage of unique users who paid for orders after viewing product detail pages during the selected period.

string
avg_page_views

Daily average number of page views for all of your product detail pages during the selected period.

integer format: int64
avg_visitors

Daily average number of unique users who visited your product detail pages during the selected period

integer format: int64
product_clicks

Total number of product clicks during the selected period.

integer format: int64
product_impressions

Total number of product impressions during the selected period.

integer format: int64
unique_clicks

Total number of unique clicks during the selected period.

integer format: int64
unique_product_impressions

Total number of unique product impressions during the selected period.

integer format: int64
Example
{
  "code": 0,
  "data": {
    "latest_available_date": "2024-04-07",
    "performance": {
      "intervals": [
        {
          "breakdowns": {
            "affiliate_product_card_attributed_gmv": {
              "amount": "2363.83",
              "currency": "USD"
            },
            "content_breakdown": [
              {
                "channel": "CREATOR",
                "content_type": "LIVE",
                "gmv": {
                  "amount": "0.00",
                  "currency": "USD"
                },
                "indirect_gmv": {
                  "amount": "0.00",
                  "currency": "USD"
                }
              }
            ],
            "seller_product_card_gmv": {
              "amount": "2363.83",
              "currency": "USD"
            },
            "shop_tab_and_search": {
              "others": {
                "amount": "0.00",
                "currency": "USD"
              },
              "search_attributed": {
                "amount": "1484.40",
                "currency": "USD"
              },
              "shop_tab_attributed": {
                "amount": "879.43",
                "currency": "USD"
              }
            }
          },
          "end_date": "2024-04-08",
          "sales": {
            "avg_order_value": {
              "amount": "2.29",
              "currency": "USD"
            },
            "avg_sku_order_value": {
              "amount": "2.29",
              "currency": "USD"
            },
            "cancellations_and_returns": 0,
            "creator_live_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "creator_live_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "creator_live_indirect_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "creator_video_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "creator_video_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "creator_video_indirect_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "customers_count": 7,
            "gmv": {
              "amount": "29.71",
              "currency": "USD"
            },
            "gmv_with_tax": {
              "amount": "0.00",
              "currency": "USD"
            },
            "gmv_with_tiktok_co_funding": {
              "amount": "0.00",
              "currency": "USD"
            },
            "items_sold": 13,
            "live_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "live_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "live_indirect_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "orders_count": 13,
            "product_card_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "refunds": {
              "amount": "0.00",
              "currency": "USD"
            },
            "seller_live_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "seller_live_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "seller_live_indirect_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "seller_video_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "seller_video_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "seller_video_indirect_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "shipping_fees": {
              "amount": "0.00",
              "currency": "USD"
            },
            "sku_orders_count": 13,
            "tax": {
              "amount": "0.00",
              "currency": "USD"
            },
            "video_attributed_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "video_gmv": {
              "amount": "0.00",
              "currency": "USD"
            },
            "video_indirect_gmv": {
              "amount": "0.00",
              "currency": "USD"
            }
          },
          "start_date": "2024-04-01",
          "traffic": {
            "avg_conversation_rate": "0.3342",
            "avg_page_views": 56234,
            "avg_visitors": 3433,
            "product_clicks": 12654,
            "product_impressions": 86234,
            "unique_clicks": 8342,
            "unique_product_impressions": 52314
          }
        }
      ]
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}
DocsSDKsAPI Reference

Start here

Getting StartedConceptsAuthorizationWebhooksErrors

SDKs

Choose an SDK

OpenAPI

The spec