Статистика приложения и подписчиков
getAppStats
Anchor link toПолучение статистики для конкретного приложения за определенный период времени.
POST
https://cp.pushwoosh.com/json/1.3/getAppStats
Параметры запроса
Anchor link toИмя | Обязательно | Тип | Описание |
---|---|---|---|
auth | Да | string | API-токен доступа из Панели управления Pushwoosh. |
application | Да | string | Код приложения Pushwoosh |
datefrom | Да | string | Дата и время начала отчетного периода. Формат: Y-m-d H:i:s . |
dateto | Да | string | Дата и время окончания отчетного периода. Формат: Y-m-d H:i:s . |
Пример запроса
Anchor link to{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel "application": "XXXXX-XXXXX", // required. Pushwoosh application code "datefrom": "2013-06-04 00:00:00", // required. Date and time, start of the reporting period "dateto": "2013-06-07 00:00:00" // required. Date and time, end of the reporting period }}
Пример ответа
Anchor link to{ "status_code": 200, "status_message": "OK", "response": { "request_id": "c93a202f439235f9adaaa06d651548ab" }}
Анализ статистики
Anchor link toСтатистика отображает зарегистрированные действия для приложения, устройства или сообщения за указанный период времени.
Отчеты автоматически агрегируются по следующим правилам:
- Годовая: если период превышает один год.
- Месячная: если период превышает один месяц.
- Дневная: если период превышает один день.
- Часовая: если период превышает три часа.
- Минутная: во всех остальных случаях.
Типы действий
Anchor link to- Уровень приложения:
_open_
,_install_
- Уровень устройства:
_register_
,_unregister_
- Уровень сообщения:
_send_
,_open_
Формат ответа
Anchor link toВсе объекты статистики имеют одинаковый формат:
Поле | Тип | Описание |
---|---|---|
formatter | string | Масштаб отчета: годовой, месячный, дневной, часовой, минутный. |
rows | list | Содержит данные отчета по каждому зарегистрированному действию. |
Каждая строка отчета содержит:
Поле | Тип | Описание |
---|---|---|
count | int | Количество зарегистрированных действий. |
action | string | Тип зарегистрированного действия. |
datetime | string | Отформатированная дата: Y-m-d H:i:s . |
Получение результатов запланированного запроса
Anchor link toТело ответа
Anchor link toПоле | Тип | Описание |
---|---|---|
request_id | string | ID запланированного запроса. Для получения дополнительной информации обратитесь к /getResults . |
Тело ответа запланированного запроса (/getResults)
Anchor link toПоле | Тип | Описание |
---|---|---|
applications | dictionary | Статистика по приложениям. |
devices | dictionary | Статистика по устройствам. |
messages | dictionary | Статистика по сообщениям. |
Пример
Anchor link to{ "error": { "code": 0, "message": "OK" }, "json_data": { "applications": { "formatter": "hourly", "rows": [{ "count": 0, "action": "open", "datetime": "2013-06-06 00:00:00" }, { ... }] } }}
getApplicationSubscribersStats
Anchor link toОтображает список подписчиков приложения, сгруппированный по типам их устройств.
POST
https://api.pushwoosh.com/json/1.3/getApplicationSubscribersStats
Тело запроса
Anchor link toИмя | Обязательно | Тип | Описание |
---|---|---|---|
auth | Да | string | API-токен доступа из Панели управления Pushwoosh. |
application | Да | string | Код приложения Pushwoosh |
Пример запроса
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel "application": "XXXXX-XXXXX" // required. Pushwoosh application code }}
{ "status_code": 200, "status_message": "OK", "response": { "IOS": 1, "ANDROID": 1, "OSX": 0, "WINDOWS": 0, "AMAZON": 0, "SAFARI": 0, "FIREFOX": 0 }}
getSubscribersStatistics
Anchor link toПолучает статистику подписчиков приложения за определенный период времени.
POST
https://api.pushwoosh.com/api/v2/statistics/application/getSubscribersStatistics
Заголовки
Anchor link to| Имя
| Обязательно | Тип | Описание ||-----------------|-------------|--------|------------------------------------------------------------------------------------------------------------------------------|
| Authorization | Да | string | API-токен доступа в формате:
Key PKX.......NHg
. || Content-Type | Да | string | Должен быть установлен в
application/json
. |Параметры запроса
Anchor link to| Имя
| Обязательно | Тип | Описание ||------------------|-------------|--------|------------------------------------------------------------------------------------------------|
| application_code | Да | string | Код приложения Pushwoosh |
| timestamp_from | Да | string | Дата и время начала периода статистики (формат:
YYYY-MM-DD hh:mm:ss
, UTC+0). || timestamp_to | Да | string | Дата и время окончания периода статистики (формат:
YYYY-MM-DD hh:mm:ss
, UTC+0). |Пример запроса
curl --location --request POST 'https://go.pushwoosh.com/api/v2/statistics/application/getSubscribersStatistics' \--header 'Authorization: Key 3a2X......828JreCk48f' \--header 'Content-Type: application/json' \--data-raw '{ "application_code": "12345-67890", // Pushwoosh app code "timestamp_from": "2022-08-01 00:00:00", // UTC+0 "timestamp_to": "2022-09-01 00:00:00" // UTC+0}'
Пример ответа
{ "statistics": [{ "timestamp": "YYYY-MM-DD hh:mm:ss", // UTC+0 "platform": 1, "push_enabled": 100, "push_disabled": 100 }]}
Коды ответа
{ "statistics": [{ "timestamp": "YYYY-MM-DD hh:mm:ss", "platform": 1, "push_enabled": 100, "push_disabled": 100 }]}
Пояснение: Запрос выполнен успешно, возвращена статистика.
{ // Response}
Пояснение: Запрос имеет неверный синтаксис или параметры.
{ // Response}
Пояснение: На сервере произошла ошибка. Повторите попытку позже.
{ // Response}
Пояснение: Ошибка аутентификации. Проверьте ваш API-ключ или токен.
{ // Response}
Пояснение: Доступ к указанному коду приложения запрещен.
{ // Response}
Пояснение: Код приложения не найден или не существует.
Правила интервалов для временных меток
Anchor link to| Запрошенный период
| Интервал в ответе||-------------------|--------------------|
| Более 1 года | 1 год |
| 1 год | 1 месяц |
| 1 месяц - 1 год | 1 день |
| Менее 1 месяца | 1 час |