GetForecastList

Returns a list of reports that have been generated or are being generated about the projected number of impressions, clicks and campaign spending.

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

Input data

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

{
   "method": "GetForecastList"
}

Output data

The method returns an array of ForecastStatusInfo 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 ForecastID.

The output data structure in JSON is shown below.

{
   "data": [
      {  /* ForecastStatusInfo */
         "ForecastID": (int),
         "StatusForecast": (string)
      }
      ...
   ]
}

Parameters are described below.

ParameterDescription
ForecastStatusInfo object
ForecastIDID of the report.
StatusForecast

Report status:

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