Propush.me API
ValeriaN avatar
Written by ValeriaN
Updated over a week ago

Propush.me API - инструмент, позволяющий отслеживать статистику и удаленно управлять данными посредством команд.

Документацию и список доступных запросов можно найти по ссылке: https://api.propush.me/v5/docs

Для получения доступа к Propush.me API необходимо связаться с нашей службой поддержки и предоставить информацию о том, как вы планируете работать с этим инструментом.

После получения доступа к API зайдите в настройки профиля в личном аккаунте Propush.me и создайте токен, который необходим для авторизации в Propush SSP API (доступно к созданию до 10 токенов).

Примеры запросов методом POST/GET:

1. https://api.propush.me/v5/docs/#/statistics/pub-statistics - статистика по всему аккаунту за всё время


2. Для того, чтобы посмотреть статистику по всему аккаунту за выбранный период, добавьте параметр ?date_from=YYYY-MM-DD&date_to=YYYY-MM-DD, например: https://api.propush.me/v5/docs/#/statistics/pub-statistics?date_from=2023-05-01&date_to=2023-05-08


3. Группировка по зонам доступна через параметр group_by[]=zone_id: https://api.propush.me/v5/docs/#/statistics/pub-statistics?group_by[]=zone_id&date_from=2023-05-01&date_to=2023-05-08


4. При необходимости группировать по нескольким параметрам (до трёх одновременно) просто добавьте этот параметр в эндпойнт, например: + группировка по гео group_by[]=geo будет выглядеть следующим образом - https://api.propush.me/v5/docs/#/statistics/pub-statistics?group_by[]=zone_id&group_by[]=geo&date_from=2023-05-01&date_to=2023-05-08

*** Если группировка по нескольким параметрам недоступна, пожалуйста, напишите нам на support@propush.me

Пожалуйста, обратите внимание, что параметр {request_var} должен быть не более 40 символов в длину со следующим списком допустимых символов:
• a-z
• A-Z
• 0-9
• +!:/ ,?()$=.%[]_-


6. При работе с большим количеством зон можно запрашивать статистику по каждой зоне или нескольким зонам одновременно (а не по всем сразу). Для этого используется параметр zone_ids[]=ХХХ (если зон несколько, то добавить zone_ids[]=ХХХ несколько раз).

Пример: https://api.propush.me/v5/docs/#/statistics/pub-statistics?group_by[]=zone_id& group_by[]=geo&group_by[]=request_var&date_from =2023-05-01&date_to=2023-05-08&zone_ids[]=123&zone_ids[]=111


7. https://api.propush.me/v5/docs/#/sites/pub-sites-list - данный эндпоинт возвращает список добавленных сайтов


8. https://api.propush.me/v5/docs/#/sites/pub-zones-list - возвращает список зон.

Если вам нужна помощь с настройкой API, пожалуйста, свяжитесь с нашей службой поддержки в чатах или по почте support@propush.me.

Did this answer your question?