Credits statistics
The SerpstatLimitsProcedure.getStats method is for checking the number of available and used API and Serpstat extension credits.
Credits for this method are not used.
Request parameters | ||
Parameter | Description | Value options |
id | A request id: the response contains the same id. Enter any number (number) or text (string) value | 1, test |
method | API method name | SerpstatLimitsProcedure.getStats |
Response parameters | ||
---|---|---|
Parameter | Description | Value |
id | Response id corresponds the request id | |
result | Contains the answer | |
data | Array with data | |
max_lines | Max number of API credits available per month | int |
used_lines | Number of API credits used | int |
left_lines | Number of available API credits | int |
user_info | API User Information | json object |
user_id | User ID in Serpstat | int |
plugin_limits | Serpstat extension API credits information | json object |
hasApiPlugin | Availability of access to the Serpstat extension API: true - have access false - no access | bool |
delayBetweenRequests | Number of Serpstat extension API requests per second | int |
total | The number of credits per day for the Serpstat extension API | int |
used | The number of used credits for the current day via the extension API | int |
left | The number of remaining credits for the current day via the extension API | int |
summary_info | Object with data | |
left_lines | Number of remaining API lines |
{
"id": 1,
"method": "SerpstatLimitsProcedure.getStats"
}
{
"id": "1",
"result": {
"data": {
"max_lines": 1000000,
"used_lines": 1053,
"left_lines": 998947,
"user_info": {
"user_id": "111111"
},
"plugin_limits": {
"hasApiPlugin": true,
"delayBetweenRequests": 1,
"total": 1000,
"used": 0,
"left": 1000
}
},
"summary_info": {
"left_lines": 998947
}
}
}