# Получение кол-ва подписчиков в динамике

Описание

Метод позволяет получить количество подписчиков канала в динамике по часам, дням, неделям, месяцам.

Метод доступен в "API Stat" (на тарифах S и выше)

# Запрос


# URL запроса

GET

https://api.tgstat.ru/channels/subscribers

# Параметры

Параметр Описание Значение по умолчанию Обязательно
token Ваш токен Не задан Да
channelId Идентификатор канала (@username, t.me/username, t.me/joinchat/AAAAABbbbbcccc... или ID канала в TGStat) Не задан Да
startDate Дата с (timestamp) Не задан Нет
endDate Дата по (timestamp) Не задан Нет
group Группировка результатов (hour, day, week, month) day Нет

Для группировки group=day будет возвращено количество подписчиков по состоянию на конец суток.

Для группировок group=week и group=month будет возвращено количество подписчиков на конец последних суток периода (недели или месяца).

# Ответ


# Структура

{ 
    "status": "ok",
    "response": {
        "items": [      # Массив данных по часам, дням, неделям или месяцам 
            ...
        ]
    }
}

# Пример ответа с группировкой по дням

{
    "status": "ok",
    "response": {
        "items": [
            {
                "period": "2018-11-04",             # 4 ноября 2018
                "participants_count": 1156          # кол-во подписчиков по состоянию на 23:59 4 ноября 2018
            },
            {
                "period": "2018-11-03",
                "participants_count": 1150
            },
            {
                "period": "2018-11-02",
                "participants_count": 1107
            },
            ...
        ]
    }
}

# Пример ответа с группировкой по часам

{
    "status": "ok",
    "response": [
        {
            "period": "2020-03-11 10:00",           # 11 марта 2020, 10:00
            "participants_count": 1518              # кол-во подписчиков по состоянию на 10:00 11 марта 2020
        },
        {
            "period": "2020-03-11 09:00",
            "participants_count": 1407
        },
        {
            "period": "2020-03-11 08:00",
            "participants_count": 1391
        },
        {
            "period": "2020-03-11 07:00",
            "participants_count": 1370
        },
        {
            "period": "2020-03-11 06:00",
            "participants_count": 1338
        },
        ...
    ]
}

По умолчанию вернется результат за 10 последних дней. Однако, вы можете указать необходимый период с помощью параметров startDate и endDate, соблюдая при этом ограничения на вашем тарифе.

В зависимости от запрошенного типа группировки group - поле period будет принимать один из форматов:

"Y-m-d H:00"    # для group=hour
"Y-m-d"         # для group=day
"Y-W"           # для group=week
"Y-m"           # для group=month

Y - Порядковый номер года, 4 цифры
m - Порядковый номер месяца с ведущим нулём
d - День месяца, 2 цифры с ведущим нулём 
H - Час в 24-часовом формате с ведущим нулём
W - Порядковый номер недели года в соответствии со стандартом ISO-8601; недели начинаются с понедельника
 
# Подробнее о форматах даты http://php.net/manual/ru/function.date.php