Статистика кампании (campaigns/info)
Метод позволяет получить статистику использования кампании: сколько осталось неиспользованных бонусов, сколько получили пользователи, сколько использовали.
 
Запрос
Адрес для отправки запроса
POST https://yoomoney.ru/api/offerwall/v1/campaigns/info
Параметры
ПараметрТипОписание
partnerCampaignIdintИдентификатор кампании. Возвращается в ответе на запрос campaigns/create.
Пример тела запроса
JSON
{
    "ymCampaignId": 34
}
Пример запроса
cURL
curl -X POST \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <авторизационный токен>'  -d '{
    "ymCampaignId": 34
 }' 'https://yoomoney.ru/api/offerwall/v1/campaigns/info'
 
Ответ
Параметры
ПараметрТипОписание
ymCampaignIdintИдентификатор кампании в сервисе ЮMoney.
campaignStatusenumСтатус кампании
campaignAcceptsintКоличество полученных пользователями, но еще не использованных пин-кодов или ссылок (
pinURL
).
campaignRedeemsint
Количество использованных пин-кодов.
На основании данных, которые агрегатор или магазин загружает в сервис ЮMoney с помощью метода campaigns/redeem.
campaignShowsintКоличество показов — сколько раз кампанию увидели пользователи.
campaignPinsStats.unusedintКоличество неиспользованных пин-кодов (пользователи смогут их получить и использовать).
campaignPinsStats.totalintОбщее количество пин-кодов, загруженных для этой кампании.
campaignRedeemStats.usedCountintКоличество использованных пин-кодов (лидов).
campaignRedeemStats.approvedCountintКоличество подтвержденных пин-кодов.
campaignRedeemStats.declinedCountintКоличество отклоненных пин-кодов.
Ошибки
Код ошибкиЗначениеОписание
campaignNotFoundНе найденаКампания с таким
ymCampaignId
не существует.
Пример тела ответа
JSON
{
    "status": "success",
    "result": {
        "ymCampaignId": 2563,
        "campaignStatus": "started",
        "campaignAccepts": 287,
        "campaignRedeems": 24,
        "campaignShows": 1055,
        "campaignPinsStats": {
            "unused": 713,
            "total": 1000
        },
        "campaignRedeemStats": {
            "usedCount": 14,
            "approvedCount": 9,
            "declinedCount": 1
        }
    }
}