Получить статистику по сегментам

Описание

Получить статистику подписок профилей в сегменте.

Обратите внимание

Методы get_counters и refresh_counters работают в связке. Статистика по сегменту не обновляется автоматически — сначала необходимо вызвать метод refresh_counters, который инициирует пересчет данных и возвращает ID задания. После успешного выполнения задания (статус можно проверить через tasks/status) обновленные данные станут доступны в методе get_counters.

URL-адрес

Метод: POST

https://example.com/api/v1.1/segments/get_counters

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API-токен
list_id	int	3	Да, для динамического сегмента	Идентификатор базы данных Параметр используется только для динамического сегмента
resource_id	int	2	Да	Идентификатор ресурса
id	int	1	Да	Идентификатор сегмента
format	int	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "list_id": 1,
    "resource_id": 24,
    "id": 7,
    "format": "json"
}

XML

<xml>
     <token>abcdefghijklmnqrstuvwxyz</token>
     <list_id>1</list_id>
     <resource_id>24</resource_id>
     <id>7</id>
     <format>json</format>
</xml>

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

JSON

{
    "data": [
        {
            "channel": "email",
            "status": {
                "subscribed_sendable": 209,
                "unconfirmed_sendable": 0
            }
        },
        {
            "channel": "push",
            "status": {
                "subscribed_sendable": 0,
                "unconfirmed_sendable": 0
            }
        },
        {
            "channel": "sms",
            "status": {
                "subscribed_sendable": 108,
                "unconfirmed_sendable": 0
            }
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
     <data>
         <channel>email</channel>
         <status>
             <subscribed_sendable>209</subscribed_sendable>
             <unconfirmed_sendable>0</unconfirmed_sendable>
         </status>
     </data>
     <data>
         <channel>push</channel>
         <status>
             <subscribed_sendable>0</subscribed_sendable>
             <unconfirmed_sendable>0</unconfirmed_sendable>
         </status>
     </data>
     <data>
         <channel>sms</channel>
         <status>
             <subscribed_sendable>108</subscribed_sendable>
             <unconfirmed_sendable>0</unconfirmed_sendable>
         </status>
     </data>
     <error>0</error>
     <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
data	array of objects	Массив полученных данных по подпискам сегмента
error	int	Код ошибки
error_text	string	Текст ошибки