Key

Type

Description

Example

Required

category

string

The data category for which the analysis is planned. As the scripting language is the same across various data categories, this value will help determine what data to fetch.

tiktok_shop_info

Yes

condition_groups

object

Specifications for what data should be used for querying.

condition_groups = [
{
"operator": "and",
"conditions": [
{
"field": "shop_name",
"operator": "eq",
"field_values": ["tiktok_shop"]
}
]
}
]

No

fields

string

Data fields to be returned. Interface will only return the fields listed here.

shop_name,shop_rating,shop_review_count,item_sold_count,shop_id

No

limit

int

The maximum number of records that will be returned.

Test Stage

The default value is 10, and the maximum value is 5000 per day across end points. (The value is low here as researchers can see the data and we want to keep this data to a low sample count only)

Execution Stage

The default value is 100, and the maximum value is 1000 in one query. If there are less than 1,000 results, that number will be returned in one go. (This is where researchers get access to all data and hence the increments are maximized based on performance possible)

No

Key

Type

Description

Required

and

list<Condition>

The and conditions specify that all the conditions in the list must be met

No

or

list<Condition>

The or conditions specify that at least one of the conditions in the list must be met

No

not

list<Condition>

The not conditions specify that none of the conditions in the list must be met

No

Key

Type

Description

Example

result

string

Data fields returned from the query. Interface will only return the fields listed here for shops actively listed in the EU.

shop_name,shop_rating,shop_review_count,item_sold_count,shop_id,shop_performance_value

Key

Type

Description

Example

Required

category

string

The data category for which the analysis is planned. As the scripting language is the same across various data categories, this value will help determine what data to fetch.

tiktok_shop_products

Yes

condition_groups

object

Specifications for what data should be used for querying.

The data can be: product_name, shop_name

condition_groups = [
{
"operator": "and",
"conditions": [
{
"field": "shop_id",
"operator": "eq",
"field_values": ["7495177166735509999"]
}
]
}
]

No

fields

string

Data fields to be returned. Interface will only return the fields listed here.

shop_name,product_id,product_sold_count,product_description,product_price,product_review_count,product_name,product_rating_1_count,product_rating_2_count,product_rating_3_count,product_rating_4_count,product_rating_5_count

No

limit

int

The maximum number of records that will be returned.

Test Stage

The default value is 10, and the maximum value is 5000 per day across end points. (The value is low here as researchers can see the data and we want to keep this data to a low sample count only)

Execution Stage

The default value is 100, and the maximum value is 1000 in one query. If there are less than 1,000 results, that number will be returned in one go. (This is where researchers get access to all data and hence the increments are maximized based on performance possible)

No

Key

Type

Description

Required

and

list<Condition>

The and conditions specify that all the conditions in the list must be met

No

or

list<Condition>

The or conditions specify that at least one of the conditions in the list must be met

No

not

list<Condition>

The not conditions specify that none of the conditions in the list must be met

No

Key

Type

Description

Example

result

string

Data fields returned from the query. Interface will only return the fields listed here for products sold in the EU.

shop_name,product_id,product_sold_count,product_description,product_price,product_review_count,product_name,product_rating_1_count,product_rating_2_count,product_rating_3_count,product_rating_4_count,product_rating_5_count

Key

Type

Description

Example

Required

category

string

The data category for which the analysis is planned. As the scripting language is the same across various data categories, this value will help determine what data to fetch.

tiktok_shop_reviews

Yes

condition_groups

object

Specifications for what data should be used for querying.

The data can be: product_name, shop_name

No

fields

string

Data fields to be returned. Interface will only return the fields listed here.

product_name,review_text,review_like_count,create_time,review_rating

No

limit

int

The maximum number of records that will be returned.

Test Stage

The default value is 10, and the maximum value is 5000 per day across end points. (The value is low here as researchers can see the data and we want to keep this data to a low sample count only)

Execution Stage

The default value is 100, and the maximum value is 1000 in one query. If there are less than 1,000 results, that number will be returned in one go. (This is where researchers get access to all data and hence the increments are maximized based on performance possible)

No

Key

Type

Description

Required

and

list<Condition>

The and conditions specify that all the conditions in the list must be met

No

or

list<Condition>

The or conditions specify that at least one of the conditions in the list must be met

No

not

list<Condition>

The not conditions specify that none of the conditions in the list must be met

No

Key

Type

Description

Example

result

string

Data fields returned from the query. Interface will only return the fields listed here foe reviews given for products sold in the EU.

product_name,review_text,review_like_count,create_time,review_rating