TGStat API Docs

# Получение показателя ERR24 для канала в динамике

Описание

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

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

# Запрос

# URL запроса

GET

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

# Параметры

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

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

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

# Ответ

# Структура

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

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

{
    "status": "ok",
    "response": [
        {
            "period": "2021-11-26",
            "err24": 41
        },
        {
            "period": "2021-11-25",
            "err24": 41.4
        },
        {
            "period": "2021-11-24",
            "err24": 40.9
        },
        ...
    ]
}

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

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

"Y-m-d"         # для group=day
"Y-W"           # для group=week
"Y-m"           # для group=month

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

← Добавление канала →