Получить отчет

Получает отчет в разрезе кампаний, публикаций или обложек. Срок хранения отчетов 30 дней, но не более 1000 последних отчетов.

Запрос на получение отчета следует передавать по протоколу HTTPS методом GET.

Параметры необходимо указывать в параметрах запроса в формате json. Данные передаются в кодировке UTF-8.

Формат запроса

GET https://promopages.yandex.ru/api/promo/v1/reports/{report_id}

report_id

Идентификатор отчета.

Формат ответа

{
    "type": String,
    "statistics": [
        {
            "campaignId": String,
            "publicationId": String,
            "previewId": String,
            "mskDate": String,
            "impressions": long,
            "reach": long,
            "budget": double,
            "cpm": double,
            "clickouts": long,
            "clickoutCost": double,
            "clickoutPercent": int,
            "fullReads": long,
            "fullReadPercent": int,
            "ctr": double,
            "videoExpands": long,
            "videoFullViews": long,
            "videoExpandPercent": int,
            "videoFullViewPercent": int,
            "metricaVisits": long,
            "metricaVisitPercent": int,
            "metricaVisitCost": double
        },
    ]
}

Параметр

Тип

Описание

type

string

Тип заказанного отчета:

campaigns_daily_stats — отчет по кампаниям;
campaigns_publications_daily_stats — отчет по публикациям;
campaigns_previews_daily_stats — отчет по обложкам.

Структура statistics

Параметр	Тип	Описание
`campaignId`	String	Идентификатор кампании.
`publicationId`	String	Идентификатор публикации, возвращается только с типом отчета `campaigns_publications_daily_stats` или `campaigns_previews_daily_stats`.
`previewId`	String	Идентификатор обложки, возвращается только с типом отчета `campaigns_previews_daily_stats`.
`mskDate`	String	Дата события.
`impressions`	long	Показы.
`reach`	long	Охват.
`budget`	double	Расход (без НДС).
`cpm`	double	CPM — цена за тысячу показов.
`clickouts`	long	Внешние переходы.
`clickoutPercent`	int	Процент внешних переходов от дочитавших или досмотревших.
`clickoutCost`	double	Стоимость внешнего перехода.
`fullReads`	long	Дочитывания.
`fullReadPercent`	int	Процент дочитываний.
`ctr`	double	CTR — отношение количества кликов по обложке к показам в ленте.
`videoExpands`	long	Расхлоп видео в ленте.
`videoFullViews`	long	Досмотры видео.
`videoExpandPercent`	int	Процент расхлопов видео.
`videoFullViewPercent`	int	Процент досмотров видео.
`metricaVisits`	long	Визиты по Метрике.
`metricaVisitPercent`	int	Процент визитов от дочитавших или досмотревших.
`metricaVisitCost`	double	Стоимость визита.

Пример

Запрос:

https://promopages.yandex.ru/api/promo/v1/reports/621e101296d79c3daa2c94fa?format=json

Ответ:

{
    "type": "campaigns_previews_daily_stats",
    "statistics": [
        {
            "campaignId": "5e67a3c5bf998668491f9079",
            "publicationId": "5d67c6491ee34f00ad33c655",
            "previewId": "5d67c6491ee34f00ad33c655",
            "mskDate": "2022-02-10",
            "impressions": 1791,
            "reach": 1697,
            "budget": 42.0,
            "cpm": 23.45,
            "clickouts": 6,
            "clickoutCost": 7.0,
            "clickoutPercent": 29,
            "fullReads": 21,
            "fullReadPercent": 42,
            "ctr": 0.01172529,
            "metricaVisits": 4,
            "metricaVisitPercent": 10,
            "metricaVisitCost": 10.5
        },
    ]
}

Была ли статья полезна?

Создать отчет

Получить баланс кошелька