Статистика кампании (campaigns/info)

Метод позволяет получить статистику использования кампании: сколько осталось неиспользованных бонусов, сколько получили пользователи, сколько использовали.

Запрос

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

POST https://yoomoney.ru/api/offerwall/v1/campaigns/info

Параметры

Параметр	Тип	Описание
partnerCampaignId	int	Идентификатор кампании. Возвращается в ответе на запрос 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'

Ответ

Параметры

Параметр	Тип	Описание
ymCampaignId	int	Идентификатор кампании в сервисе ЮMoney.
campaignStatus	enum	Статус кампании
campaignAccepts	int	Количество полученных пользователями, но еще не использованных пин-кодов или ссылок (`pinURL`).
campaignRedeems	int	Количество использованных пин-кодов. На основании данных, которые агрегатор или магазин загружает в сервис ЮMoney с помощью метода campaigns/redeem.
campaignShows	int	Количество показов — сколько раз кампанию увидели пользователи.
campaignPinsStats.unused	int	Количество неиспользованных пин-кодов (пользователи смогут их получить и использовать).
campaignPinsStats.total	int	Общее количество пин-кодов, загруженных для этой кампании.
campaignRedeemStats.usedCount	int	Количество использованных пин-кодов (лидов).
campaignRedeemStats.approvedCount	int	Количество подтвержденных пин-кодов.
campaignRedeemStats.declinedCount	int	Количество отклоненных пин-кодов.

Ошибки

Код ошибки	Значение	Описание
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
		}
	}
}