Получить доступный диапазон дат

Если вам нужно ограничить выбор дат по конкретному объекту (кампании, баннеру или сайту), запросите допустимый диапазон дат:

GET /api/v2/reports/available-dates?level=campaign&id=12345

Параметры query

Параметр

Тип

Обязательность

Описание

level

string

Да

Доступные уровни отчета:

  • owner — общий отчет;
  • supercampaign — на уровне суперкампании;
  • campaign — на уровне кампании;
  • banner — на уровне баннера;
  • site — на уровне сайта;
  • section — на уровне раздела;
  • place — на уровне рекламного места.

objectId

string

Да

Идентификатор объекта в том же виде, что использует UI для этого уровня (строка; для числовых id допустима передача как строка цифр).

ownerId

string (положительное целое)

Опционален для администратора / ассистента, обязателен для рекламодателя / владельца сайта

Аккаунт владельца (см. раздел Авторизация).

Успешный ответ

Поле

Тип

Описание

result

object

result.level

string

Эхо level в нижнем регистре (campaign / banner / site).

result.id

string

Эхо переданного id.

result.dateRange

object

result.dateRange.from

string

Нижняя граница (формат задается источником данных; обычно дата в компактном строковом виде).

result.dateRange.to

string

Верхняя граница.

Пример запроса

curl -H 'Authorization: OAuth <токен>' \
  'https://adfox.yandex.ru/api/v2/reports/available-dates?level=campaign&objectId=12345&ownerId=67890'

Пример ответа

{
  "result": {
    "level": "campaign",
    "id": "12345",
    "dateRange": {
      "from": "2023-01-01",
      "to": "2024-06-30"
    }
  }
}

Ошибка

С кодами ошибок можно ознакомиться на странице Коды ошибок.