Site Audit credits statistics

SerpstatLimitsProcedure.getAuditStats — this method displays the statistics of Site Audit credits.

Use case: With the SerpstatLimitsProcedure.getAuditStats method, check how many credits you have left.

Request parameters
Parameter	Description	Type	Optional	Default value	Value Options
id	A request id: the response contains the same id.	int/string	no		Text or number value, 1, test
method	API method name	string	no		SerpstatLimitsProcedure.getAuditStats

Response parameters
Parameters	Description
id	Response id corresponds the request id
result	Contains the answer
data	Array with data
hasAuditOnePage	Whether the Single Page Audit is available for the account
hasAuditJsScanPage	Whether JS page scanning is available to the user
hasAuditLimitPage	Whether the audit is restricted to the user
maxAuditLimitPage	Maximum number of pages in an audit
total	The total number of credits given for a charged period on the account plan
used	Total used credits
left	How many credits are left to use until the end of the plan duration

Credits for this method are not deducted.

Example

Request data:

{
 "id":1,
 "method": "SerpstatLimitsProcedure.getAuditStats"
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "hasAuditOnePage": true,
            "hasAuditJsScanPage": true,
            "hasAuditLimitPage": false,
            "maxAuditLimitPage": 0,
            "total": 500000,
            "used": 420,
            "left": 499580
        }
    }
}