GetReportList
Returns a list of campaign statistics reports that have been generated or are being generated.
Disabled method. Use version 5 of the API.
For information about the compatibility of methods between versions 4 and 5, see the Migration guide.
This method is used for checking whether a report with a certain ID is ready. Using this method, you can also get the report ID in order to delete a report (using the DeleteReport method).
Restrictions
We recommend invoking the method no more than once every 10-20 seconds (it takes on average one to two minutes to generate a report). When the report is ready, the method returns a link for downloading the file from the server.
Input data
The input data structure in JSON is shown below. The method does not have any input parameters.
{
"method": "GetReportList"
}
Output data
The method returns an array of ReportInfo 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": [
{ /* ReportInfo */
"ReportID": (int),
"Url": (string),
"StatusReport": (string)
}
...
]
}
Parameters are described below.
Parameter | Description |
ReportInfo object | |
---|---|
ReportID | ID of the campaign statistics report. |
Url | Link for downloading the report from the server. If the report is not finished, an empty string is returned. The report is accessible over the HTTPS protocol. |
StatusReport | Report status:
|
Parameter | Description |
ReportInfo object | |
---|---|
ReportID | ID of the campaign statistics report. |
Url | Link for downloading the report from the server. If the report is not finished, an empty string is returned. The report is accessible over the HTTPS protocol. |
StatusReport | Report status:
|