Acceptable reporting periods

Note

Report data is stored for 3 years.

To find out the acceptable periods for building a report, you need to send two requests.

  1. Using the first request, you need to find out which parameters affect the period for the selected level of detail:

    https://adfox.yandex.com/api/report/date/argument/list/<level>
    

    Request parameters

    Parameter

    Description

    level

    The level of detail.

    Response format

    The response is an array of parameter names.

    Response example

    {
        "result": [
            "supercampaignId"
        ],
        "error": null
    }
    
  2. The received parameters must be passed to the second request in order to get acceptable periods:

    https://adfox.yandex.com/api/report/date/interval/<level>?<arguments>
    

    Request parameters

    Parameter

    Description

    level

    The level of detail.

    arguments

    The parameters that you received in response to your first request with values.

    Response format

    {
      "result": {
          "dateFrom": (string)
          "dateTo": (string)
      },
      "error": (string)
    }
    

    Parameter

    Description

    dateFrom

    The date in YYYY-MM-DD format, starting from which you can build a report.

    dateTo

    The date in the YYYY-MM-DD format, up to which data for building the report are available.

    Sample request

    https://adfox.yandex.com/api/report/date/interval/owner?name=devicesTypes
    

    Response example

    {
        "result": {
            "dateFrom": "2019-07-09",
            "dateTo": "2022-04-17"
        },
        "error": null
    }
    

Level of detail Available levels of detail:

  • owner: A general report.

  • supercampaign: At the supercampaign level.

  • campaign: At the campaign level.

  • banner: At the banner level.

  • site: At the site level.

  • section: At the site section level.

  • place: At the placement level.