Разработчикам

Для получения доступа к API обратитесь в поддержку support@zenstat.ru.

Все запросы к API необходимо направлять на адрес: https://zenstat.ru. Каждый запрос должен сопровождаться заголовком Authorization.

GET /api/v1/channels/?description=еда&subscribers_max=1000 HTTP/1.1
Host: zenstat.ru
Authorization: {key}

Пример успешного запроса:

{
    "status": true,
    "request_id": "2fc340e9-8037-4008-945a-e8cee380a4c5",
    "response": {}
}

Пример ошибки:

{
    "status": false,
    "request_id": "f90ca5bf-3aa4-4c21-9a71-3d41cde2b533",
    "response": {
        "errors": [
            {
                "field": "limit",
                "msg": "This field must be int"
            }
        ]
    }
}

Доступные методы:

packages - Список активных API пакетов;
channels - Поиск каналов;
channel - Получение общей информации о канале;
channel posts - Получение публикаций канала;
channel stat - Получение статистики канала;
posts - Поиск публикаций;

Метод packages

Возвращает список активных API пакетов.

GET https://zenstat.ru/api/v1/profile/packages/

Ответ:

{
    "status": true,
    "request_id": "726d69c7-dc38-431e-95cc-29a48702a3a7",
    "response": {
        "packages": [
            {
                "balance": 872,
                "type": "common",
                "date_end": "2024-11-27T14:08:28.132075+03:00"
            }
        ]
    }
}

Метод channels

Осуществляет поиск по всем каналам.

GET https://zenstat.ru/api/v1/channels/

Параметры:

Имя	Обязательный	Тип	Описание	По умолчанию
sort	нет	string	Поле сортировки, допустимые значения: subscribers, title.	subscribers
order	нет	string	Направление сортировки, допустимые значения: desc, asc.	desc
limit	нет	int	Количество каналов, максимальное значение: 50.	25
title	нет	string	Поиск по названию канала.
description	нет	string	Поиск по описанию канала.
slug	нет	string	Поиск по url адресу канала.
subscribers_min	нет	int	Минимальное кол-во подписчиков.
subscribers_max	нет	int	Максимальное кол-во подписчиков.

Ответ:

{
    "status": true,
    "request_id": "726d69c7-dc38-431e-95cc-29a48702a3a7",
    "response": {
        "channels": [
            {
                "slug": "channel slug",
                "title": "Channel name",
                "logo": "https://avatars.dzeninfra.ru/get-zen-logos/1597769/xxx/xxh",
                "is_indexable": true,
                "is_verified": true,
                "subscribers": 123456,
                "reg_time": "2006-01-02"
            },
            ...
        ]
    }
}

Метод channel

Детальная информация о канале.

GET https://zenstat.ru/api/v1/channels/{channel slug}/

Ответ:

{
    "status": true,
    "request_id": "824d667a-4e1f-42f7-92ae-6407787185b8",
    "response": {
        "channel": {
            "slug": "channel slug",
            "title": "Channel name",
            "logo": "https://avatars.dzeninfra.ru/get-zen-logos/1597769/xxx/xxh",
            "description": "channel description",
            "is_indexable": true,
            "is_verified": true,
            "links": [
                "https://www.youtube.com/channel/xxx",
                "https://t.me/xxx"
            ],
            "subscribers": 100000,
            "subscribers_30days": 400,
            "publications_30days": 15,
            "views_30days": 1679351,
            "mentions_30days": 47,
            "likes_30days": 68846,
            "comments_30days": 1824,
            "er_30days": 0.04,
            "views_monthly": 252218,
            "likes_monthly": 20915,
            "comments_monthly": 464,
            "er_monthly": 0.08,
            "gif_30days": 9,
            "gif_views_monthly": 221835,
            "gif_er_monthly": 6.53,
            "card_30days": 4,
            "card_views_monthly": 18722,
            "card_er_monthly": 26.65,
            "brief_30days": 2,
            "brief_views_monthly": 11661,
            "brief_er_monthly": 16.3,
            "reg_time": "2006-01-02",
            "topics": ["food"]
        }
    }
}

Метод channel posts

Получение публикаций канала.

GET https://zenstat.ru/api/v1/channels/{channel slug}/posts/

Параметры и пример ответа см. в основном разделе posts.

Метод channel stat

Получение статистики канала.

GET https://zenstat.ru/api/v1/channels/{channel slug}/stat/

Параметры:

Имя	Обязательный	Тип	Описание	По умолчанию
date_min	да	string	Начало диапазона дат. Формат: YYYY-mm-dd.
date_max	да	string	Конец диапазона дат. Формат: YYYY-mm-dd.

Ответ:

{
    "status": true,
    "request_id": "95452694-fc2b-4f4a-81c5-ca3c86a38231",
    "response": {
        "stat": [
            {
                "subscribers": 123456,
                "date": "2006-01-02"
            },
            ...
        ]
    }
}

Метод posts

Поиск публикаций.

GET https://zenstat.ru/api/v1/posts/

Параметры:

Имя	Обязательный	Тип	Описание	По умолчанию
limit	нет	int	Количество публикаций, максимальное кол-во 100.	25
offset	нет	int	Количество пропускаемых элементов.	0
sort	нет	string	Поле сортировки, допустимые значения: title, views, views_till_end, views_till_end_percent, views_time, avg_views_time, date_publish.	views
order	нет	string	Направление сортировки, допустимые значения: desc, asc.	desc
title	нет	string	Поиск по названию публикации.
type_post	нет	string	Тип публикации, допустимые значения: card, gif, gallery, brief.
views_min	нет	int	Минимальное кол-во просмотров.
views_max	нет	int	Максимальное кол-во просмотров.
views_till_end_min	нет	int	Минимальное кол-во просмотров до конца.
views_till_end_max	нет	int	Максимальное кол-во просмотров до конца.
links	нет	array	Поиск публикаций с указанными ссылками. Пример: ['link1', 'link2'].
links_operator_i	нет	int	Учитывать все ссылки.
date_publish_min	да	string	Начало диапазона даты публикации. Формат: YYYY-mm-dd.
date_publish_max	да	string	Конец диапазона даты публикации. Формат: YYYY-mm-dd.
publication_id	нет	string	Уникальный идентификатор публикации.

Ответ:

{
    "status": true,
    "request_id": "2fc340e9-8037-4008-945a-e8cee380a4c5",
    "response": {
        "count": 61,
        "posts": [
            {
                "channel_slug": "channel slug",
                "channel_title": "Channel title",
                "channel_subscribers": 12345,
                "publication_id": "66aab86a231a476171eb6406",
                "title": "Post title",
                "type_post": "gif",
                "views": 123,
                "views_time": 123,
                "views_till_end": 12345,
                "avg_views_time": 12345,
                "views_till_end_percent": 100,
                "likes": 13,
                "comments": 3,
                "url": "https://dzen.ru/video/watch/xxx",
                "links": [],
                "date_publish": "2006-01-02T11:23:49Z"
            },
            ...
        ]
    }
}

Если вы не нашли нужный метод или у вас остались вопросы, напишите нам support@zenstat.ru.