Статистика по In-App

Два метода возвращают статистику для мгновенных In-App кампаний. Используйте inapps:totals для получения итоговых данных за период по одной или нескольким кампаниям, и inapps:timeline для получения временного ряда по одной кампании. Значения соответствуют экрану статистики по In-App в Панели управления.

In-App, отправленные из Journey

Эти методы охватывают только мгновенные In-App кампании. Статистика по In-App, доставленным элементом Customer Journey, предоставляется для каждой точки Journey методом Get Journey stats.

Метрики

Поле	Тип	Описание
impressions	number	Сколько раз был показан In-App. В Панели управления называется Impressions.
unique_impressions	number	Количество уникальных устройств, на которых был показан In-App.
interactions	number	Взаимодействия с контентом In-App: клики по кнопкам, клики по ссылкам и отправка форм.
unique_interactions	number	Количество уникальных устройств, которые взаимодействовали с In-App.
skips	number	Сколько раз пользователи закрыли In-App, не взаимодействуя с ним.
audience	number	Количество уникальных устройств, которые сгенерировали любое событие In-App за указанный период.

Примечание

Уникальные метрики и audience являются приблизительными, так как для их подсчета используется вероятностный метод. Данные по платформам не суммируются в общий итог кампании: устройство, которое появляется на двух платформах, учитывается один раз в разбивке по каждой платформе и один раз в общем итоге кампании.

inapps:totals

Возвращает итоговые данные за период. Передайте inapp_codes для получения отчета по конкретным кампаниям или опустите его, чтобы постранично обойти все In-App приложения. Этот метод следует использовать для запланированного экспорта.

POST https://api.pushwoosh.com/api/v2/statistics/inapps:totals

Заголовки

Имя	Обязательный	Описание
Authorization	Да	Токен Server API в формате Authorization: Api <Server Key>.

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

Имя	Обязательный	Тип	Описание
application	Да	String	Код приложения.
date_range	Да	Object	Отчетный период. date_from и date_to используют формат YYYY-MM-DD и являются включительными. Период рассчитывается в UTC и не должен превышать 366 дней.
inapp_codes	Нет	Array	Коды In-App, до 100 на запрос. Опустите, чтобы получить отчет по всем In-App приложения. Если какой-либо код в списке не принадлежит приложению, весь запрос завершится с ошибкой 404.
platforms	Нет	Array	Ограничить метрики этими платформами. Возможные значения: "IOS", "ANDROID", "HUAWEI_ANDROID", "AMAZON", "OSX", "WINDOWS", "SAFARI", "CHROME", "FIREFOX", "WEB".
with_platforms	Нет	Boolean	Добавить разбивку по платформам к каждому элементу.
page	Нет	Integer	Номер страницы, начиная с 0. Применяется, когда inapp_codes опущен.
per_page	Нет	Integer	Элементов на странице, по умолчанию 20, максимум 100.

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

curl -X POST https://api.pushwoosh.com/api/v2/statistics/inapps:totals \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "XXXXX-XXXXX",
    "date_range": {
      "date_from": "2026-07-01",
      "date_to": "2026-07-31"
    },
    "inapp_codes": ["AAAAA-BBBBB"],
    "with_platforms": true
  }'

Поля ответа

total — это количество In-App, соответствующих запросу. Когда inapp_codes опущен, это все In-App приложения, поэтому их можно обойти с помощью пагинации. items содержит текущую страницу. page считается с 0.

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

{
  "total": 1,
  "page": 0,
  "per_page": 20,
  "items": [{
    "inapp": {
      "code": "AAAAA-BBBBB",
      "name": "Summer sale",
      "status": "active",
      "rich_media_code": "CCCCC-DDDDD"
    },
    "metrics": {
      "impressions": 15230,
      "unique_impressions": 9120,
      "interactions": 2311,
      "unique_interactions": 1980,
      "skips": 640,
      "audience": 9120
    },
    "platforms": [{
      "platform": "IOS",
      "metrics": {
        "impressions": 8100,
        "unique_impressions": 4900,
        "interactions": 1300,
        "unique_interactions": 1120,
        "skips": 310,
        "audience": 4900
      }
    }],
    "frequency_capping": {
      "suppressions": 45,
      "affected_users": 30,
      "data_available_from": "2026-07-17"
    }
  }]
}

inapps:timeline

Возвращает итоговые данные за период и временной ряд для одной In-App кампании.

POST https://api.pushwoosh.com/api/v2/statistics/inapps:timeline

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

Имя	Обязательный	Тип	Описание
application	Да	String	Код приложения.
inapp_code	Да	String	Код In-App.
date_range	Да	Object	Отчетный период. date_from и date_to используют формат YYYY-MM-DD и являются включительными. Период рассчитывается в UTC и не должен превышать 366 дней. Необязательный interval: "HOUR", "DAY" (по умолчанию), "WEEK" или "MONTH". "HOUR" доступен для периодов до 31 дня.
platforms	Нет	Array	Ограничить метрики этими платформами.
with_platforms	Нет	Boolean	Добавить разбивку по платформам к итоговым значениям и к каждой строке.

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

curl -X POST https://api.pushwoosh.com/api/v2/statistics/inapps:timeline \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "XXXXX-XXXXX",
    "inapp_code": "AAAAA-BBBBB",
    "date_range": {
      "date_from": "2026-07-01",
      "date_to": "2026-07-07",
      "interval": "DAY"
    }
  }'

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

{
  "inapp": {
    "code": "AAAAA-BBBBB",
    "name": "Summer sale",
    "status": "active",
    "rich_media_code": "CCCCC-DDDDD"
  },
  "totals": {
    "impressions": 15230,
    "unique_impressions": 9120,
    "interactions": 2311,
    "unique_interactions": 1980,
    "skips": 640,
    "audience": 9120
  },
  "frequency_capping": {
    "suppressions": 45,
    "affected_users": 30,
    "data_available_from": "2026-07-17"
  },
  "rows": [{
    "timestamp": "2026-07-01T00:00:00Z",
    "metrics": {
      "impressions": 2140,
      "unique_impressions": 1700,
      "interactions": 320,
      "unique_interactions": 290,
      "skips": 95,
      "audience": 1700
    }
  }],
  "impression_duration": [
    { "from_seconds": 0, "to_seconds": 5, "count": 3200 },
    { "from_seconds": 5, "to_seconds": 15, "count": 5400 },
    { "from_seconds": 15, "to_seconds": 30, "count": 4100 },
    { "from_seconds": 30, "to_seconds": 0, "count": 2530 }
  ]
}

impression_duration группирует данные о том, как долго In-App оставался на экране. В последней группе to_seconds равно 0, что означает “30 секунд и дольше”.

Ограничение частоты

Блок frequency_capping сообщает о показах In-App, которые были предотвращены ограничением частоты, и о количестве затронутых уникальных пользователей. Подавленные показы не учитываются в impressions.

Данные о подавленных показах доступны с 17 июля 2026 года

До этой даты подавленные показы не регистрировались. Для периода, который заканчивается раньше, блок frequency_capping возвращается как null вместо нулей, чтобы отсутствие данных никогда не было ошибочно принято за ограничение, которое ничего не подавило. data_available_from в ответе указывает первый день, за который доступны данные. Ограничение частоты не имеет разбивки по платформам.

Хранение данных

Статистика хранится 365 дней, поэтому для периода, который начинается раньше, данные за непокрытые дни не возвращаются.

Коды ответа

Код	Значение
200	Успех.
400	Неверный запрос: отсутствует или некорректно сформирован date_range, период превышает 366 дней, часовой интервал превышает 31 день или указано более 100 inapp_codes.
401	Отсутствует или недействителен токен API.
404	Код In-App не найден в этом приложении.