GET Get Shop Video Performance Overview
Get Shop Video Performance Overview Shop Required scope: data.shop_analytics.public.read Returns overall performance metrics for all videos under a shop. Version 202509
GET/analytics/202509/shop_videos/overview_performance
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| start_date_ge Required | string | 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 | End date (ISO 8601 YYYY-MM-DD format) in shop registered timezone.In the parameter name, "lt" refers to "less than" (exclusive) |
| today | bool | 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 | Granularity of the data.Available values: ALL, 1DDefault value: ALL* ALL: aggregate* 1D: daily |
| currency | string | Currency.Available values: USD, LOCALDefault value: LOCAL* USD: US dollars* LOCAL: local currency where the shop is located |
| account_type | string | Types of the accounts under which videos were created.Available values: ALL, OFFICIAL_ACCOUNTS, MARKETING_ACCOUNTS, AFFILIATE_ACCOUNTSDefault value: ALL- ALL: all account types- OFFICIAL_ACCOUNTS,- MARKETING_ACCOUNTS,- AFFILIATE_ACCOUNTS |
| shop_cipher Required | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | Empty. No business logic error codes. |
Is this content helpful?Helpful
Not Helpful
PreviousNext