Список кампаний (campaigns/get-all-campaigns)

Метод позволяет получить все актуальные кампании по токену агрегатора или магазина. Список отдается по страницам.

Запрос

Адрес для отправки запроса

POST https://yoomoney.ru/api/offerwall/v1/campaigns/get-all-campaigns

Параметры

Агрегатор или магазин определяется по токену.

Параметр	Тип	Описание
limit	enum	Максимальное количество строк (кампаний) в ответе. Обязательный параметр
offset	int	Порядковый номер строки, начиная с которого нужно загружать выборку. Если нужно начать сначала, `offset=0`. Обязательный параметр

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

JSON
{
  "limit": 3,
  "offset": 0
}

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

cURL
curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer: <авторизационный токен>' \
  -d '{
    "limit": 10,
    "offset": 0
  }' 'https://yoomoney.ru/api/offerwall/v1/campaigns/get-all-campaigns'

Ответ

Параметры

Параметр	Тип	Описание
total	enum	Общее количество кампаний этого агрегатора или магазина.
campaigns	массив объектов	Список всех кампаний.
ymCampaignId	int	Уникальный идентификатор кампании в сервисе ЮMoney.
campaignStatus	enum	Статус кампании

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

JSON
{
  "status": "success",
  "total": 3,
  "campaigns":
    [
      {
          "ymCampaignId": 41,
          "campaignStatus": "finished"
      },
      {
          "ymCampaignId": 42,
          "campaignStatus": "started"
      },
      {
          "ymCampaignId": 43,
          "campaignStatus": "started"
      }
    ]
}