GetWordstatReportList

Returns a list of query statistics reports that have been generated or are being generated.

This method is used for checking whether a report with a certain ID is ready. Using this method, you can also get report IDs in order to delete reports (using the DeleteWordstatReport method).

Restrictions

We don't recommend calling this method too often. On average, generating reports takes about one minute, so repeating calls for checking report status every 10-20 seconds is frequent enough.

Input data

The input data structure in JSON is shown below. The method does not have any input parameters.

{
   "method": "GetWordstatReportList"
}

Output data

The method returns an array of WordstatReportStatusInfo objects, each of which contains information about a single report. The array can have a total of up to five objects. The array is sorted by decreasing ReportID.

The output data structure in JSON is shown below.

{
   "data": [
      {  /* WordstatReportStatusInfo */
         "ReportID": (int),
         "StatusReport": (string)
      }
      ...
   ]
}

Parameters are described below.

Parameter Description
WordstatReportStatusInfo object
ReportID ID of a search query statistics report.
StatusReport

Report status:

  • Done — Report has been generated.
  • Pending — Report is in progress.
  • Failed — Report was not generated.