Docs
Query Followers
Create Query Task
Query
Query Parameters
Key | Type | Description | Example | Required |
category | string | The data category for which the analysis is planned | followers_list | Yes |
condition_groups | object | Specifications for what data should be returned and processed | condition_groups = [ | No |
fields | string | Data fields to be returned. Interface will only return the fields listed here. | display_name, user_name | No |
limit | int | The maximum number of records that will be returned. Test Stage The default value is 100, and the maximum value is 5000 per day. Execution Stage The default value is 1000, and the maximum value is 100,000 in one query. | 200 | No |
Query Condition
Key | Type | Description | Required |
and | list<Condition> | The | No |
or | list<Condition> | The | No |
not | list<Condition> | The | No |
Response
Key | Type | Description | Example |
task_id | int | Data query job task identifier | 12345 |
Check Query Task Status
Query Parameters
Key | Type | Description | Example | Required |
task_id | int | Data query job task identifier | 12345 | Yes |
Response
Key | Type | Description | Example | Required |
status | string | Data query job task status | Created AnalysisFailed Processing Completed Cancelled Validating | Yes |
Cancel Query Task
Query Parameters
Key | Type | Description | Example | Required |
task_id | int | Data query job task identifier | 12345 | Yes |
Response
Key | Type | Description | Example |
success | bool | Whether the request was successfullycancelled | True |
Get Query Task Result
Query Parameters
Key | Type | Description | Example | Required |
task_id | int | Data query job task identifier | 12345 | Yes |
Response
Key | Type | Description | Example |
result | string | Data fields returned from the query. Interface will only return the fields listed here. | display_name, user_name |
Query Followers Data from TikTok via SDK
Example code
from pyrqs import rqs
import time
from datetime import datetime, timedelta
import json
category = 'followers_list'
fields = 'display_name, username'
limit = 60
client = rqs.RQSClient()
condition_groups = [
{
"operator": "and",
"conditions": [
{
"field": "username",
"operator": "EQ",
"field_values": ["test_user"] #enter a valid user name
}
]
}
]
data = client.query(category=category, fields = fields, condition_groups=condition_groups, limit=limit)
print(data)