Общие сведения

Внимание!

1. Установлено ограничение на количество обращений к API:
   • не больше 30 обращений в минуту.

• Тип запроса: GET
• Тип данных ответа: JSON
• Язык ответа определяется в первую очередь из строки запроса language. Если не задан, то из заголовка запроса Accept-Language. Если оба значения не заданы, то выбирается английский. Язык, в котором вернулся ответ, будет записан в заголовок ответа Accept-Language
• Авторизационный токен определяется в первую очередь из строки запроса cdnauthtoken. Если не задан, то из заголовка запроса cdn-auth-token. Если оба не заданы, то вернется ошибка
• Значение даты (start, end) использует стандарт ISO8601 в формате UTC с нулевыми секундами. Например, 2020-08-01T00:00:00Z или 2020-08-01T00:00:00
• Для указания времени в запросе должен быть задан start и end
• Значения country и region являются кодами. Если они присутствуют в ответе, то вместе с ним передается значения country_name и region_name, которые возвращают названия страны и региона в читаемом виде в языке, который был выбран
• Для фильтра по региону необходимо указать страну
• Для фильтра по потоку необходимо указать аккаунт
• Аргумент offset можно указать только вместе с limit
• С помощью параметра sort можно задать объект и способ сортировки. Параметр sort имеет вид: [+-]{field} (например, сортировка по убыванию уникальных пользователей -users)
• Разбиение (granularity) имеет формат ISO 8601. Доступные значения: PT1M, PT5M, PT15M, PT1H, P1D, P1W, P1M, P1Y
• Локаль представлена в возвращаемом заголовке Accept-Language и соответствует спецификации RFC 7231. Состоит из двухбуквенного основного языкового тега. Возможные значения: en и ru
• В процессе просмотра на устройство пользователя загружаются элементы потока (сегменты). Статистика подсчитывается на основе анализа этих загрузок
• User (пользователь) определяется как комбинация (IP-адрес, User-Agent)
• Просмотром потока считается наличие одного или нескольких запросов к узлам CDN на загрузку элементов потока. Если интервалы между запросами не превышают 1 минуту, то это считается одним просмотром

Описание заголовков запроса:

Возможные коды ответа:

Описание параметров ответа:

Суммарные данные

URL: https://apicdn.rcloud.ru/app/streamstat/v2/

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&fields=views,users,views_max&account=account'

Пример успешного ответа

{
    "views": 631185,
    "users": 59337,
    "views_max": 9426,
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z"
}

Группировка данных

Потоки

URL: https://apicdn.rcloud.ru/app/streamstat/v2/streams

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/streams?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&account=account'

Пример успешного ответа

{
    "result": [
        {
            "account": "account",
            "views": 6737,
            "users": 5382,
            "views_max": 356,
            "stream": "stream_name1"
        },
        {
            "account": "account",
            "views": 6438,
            "users": 5145,
            "views_max": 343,
            "stream": "stream_name2"
        }
    ],
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Аккаунты

URL: https://apicdn.rcloud.ru/app/streamstat/v2/accounts

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/accounts?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max'

Пример успешного ответа

{
    "result": [
        {
            "views": 281509,
            "users": 28160,
            "views_max": 56359,
            "account": "account1"
        },
        {
            "views": 75720,
            "users": 29770,
            "views_max": 12300,
            "account": "account2"
        }
    ],
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}   

Браузеры

URL: https://apicdn.rcloud.ru/app/streamstat/v2/browsers

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/browsers?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&account=account'

Пример успешного ответа

{
    "result": [
        {
            "views": 477309,
            "users": 16346,
            "views_max": 8057,
            "browser": "AndroidBrowser"
        },
        {
            "views": 145386,
            "users": 41285,
            "views_max": 1287,
            "browser": "TV"
        }
    ],
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Платформы

URL: https://apicdn.rcloud.ru/app/streamstat/v2/platforms

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/platforms?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&account=account'

Пример успешного ответа

{
    "result": [
        {
            "views": 772199,
            "users": 20384,
            "views_max": 9229,
            "platform": "Android"
        },
        {
            "views": 235102,
            "users": 63074,
            "views_max": 1439,
            "platform": "iOS"
        }
    ],
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Страны

URL: https://apicdn.rcloud.ru/app/streamstat/v2/countries

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/countries?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&account=account'

Пример успешного ответа

{
    "result": [
        {
            "views": 1032159,
            "users": 84212,
            "views_max": 10871,
            "country": "RU",
            "country_name": "Russia"
        },
        {
            "views": 7,
            "users": 2,
            "views_max": 7,
            "country": "GB",
            "country_name": "United Kingdom"
        }
    ],
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Регионы

URL: https://apicdn.rcloud.ru/app/streamstat/v2/regions

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/regions?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&account=account'

Пример успешного ответа

{
    "result": [
        {
            "views": 250940,
            "users": 28756,
            "views_max": 3911,
            "country": "RU",
            "region": "48",
            "country_name": "Russia",
            "region_name": "Moscow"
        },
        {
            "views": 88396,
            "users": 9042,
            "views_max": 1559,
            "country": "RU",
            "region": "71",
            "country_name": "Russia",
            "region_name": "Sverdlovsk"
        }
    ],
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Интервалы времени

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H&account=account'

Пример успешного ответа

{
    "result": [
        {
            "views": 96352,
            "users": 10483,
            "views_max": 9426,
            "start": "2020-08-01T15:00:00Z",
            "end": "2020-08-01T16:00:00Z"
        },
        {
            "views": 92464,
            "users": 9573,
            "views_max": 9009,
            "start": "2020-08-01T14:00:00Z",
            "end": "2020-08-01T15:00:00Z"
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Группировка данных с учетом времени

Потоки

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times/streams

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times/streams?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H&account=account'

Пример успешного ответа

{
    "result": [
        {
            "start": "2020-08-01T15:00:00Z",
            "end": "2020-08-01T16:00:00Z",
            "result": [
                {
                    "account": "account",
                    "views": 1576,
                    "users": 1396,
                    "views_max": 272,
                    "stream": "stream_name1"
                },
                {
                    "account": "account",
                    "views": 1558,
                    "users": 1374,
                    "views_max": 260,
                    "stream": "stream_name2"
                }
            ]
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
} 

Аккаунты

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times/accounts

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times/accounts?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H'

Пример успешного ответа

{
    "result": [
        {
            "start": "2020-08-01T19:00:00Z",
            "end": "2020-08-01T20:00:00Z",
            "result": [
                {
                    "views": 56359,
                    "users": 11171,
                    "views_max": 56359,
                    "account": "account1"
                }
            ]
        },
        {
            "start": "2020-08-01T16:00:00Z",
            "end": "2020-08-01T17:00:00Z",
            "result": [
                {
                    "views": 49772,
                    "users": 10646,
                    "views_max": 49772,
                    "account": "account2"
                }
            ]
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Браузеры

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times/browsers

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times/browsers?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H&account=account'

Пример успешного ответа

{
    "result": [
        {
            "start": "2020-08-01T15:00:00Z",
            "end": "2020-08-01T16:00:00Z",
            "result": [
                {
                    "views": 74535,
                    "users": 3931,
                    "views_max": 8057,
                    "browser": "AndroidBrowser"
                }
            ]
        },
        {
            "start": "2020-08-01T14:00:00Z",
            "end": "2020-08-01T15:00:00Z",
            "result": [
                {
                    "views": 72059,
                    "users": 3868,
                    "views_max": 7893,
                    "browser": "AndroidBrowser"
                }
            ]
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Платформы

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times/platforms

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times/platforms?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H&account=account'

Пример успешного ответа

{
    "result": [
        {
            "start": "2020-08-01T16:00:00Z",
            "end": "2020-08-01T17:00:00Z",
            "result": [
                {
                    "views": 80156,
                    "users": 4379,
                    "views_max": 9163,
                    "platform": "Android"
                }
            ]
        },
        {
            "start": "2020-08-01T19:00:00Z",
            "end": "2020-08-01T20:00:00Z",
            "result": [
                {
                    "views": 75559,
                    "users": 4203,
                    "views_max": 9229,
                    "platform": "Android"
                }
            ]
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Страны

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times/countries

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times/countries?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H&account=account'

Пример успешного ответа

{
    "result": [
        {
            "start": "2020-08-01T16:00:00Z",
            "end": "2020-08-01T17:00:00Z",
            "result": [
                {
                    "views": 105294,
                    "users": 12113,
                    "views_max": 10764,
                    "country": "RU",
                    "country_name": "Russia"
                }
            ]
        },
        {
            "start": "2020-08-01T19:00:00Z",
            "end": "2020-08-01T20:00:00Z",
            "result": [
                {
                    "views": 98352,
                    "users": 10583,
                    "views_max": 10871,
                    "country": "RU",
                    "country_name": "Russia"
                }
            ]
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}

Регионы

URL: https://apicdn.rcloud.ru/app/streamstat/v2/times/regions

Описание параметров запроса:

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" 'https://apicdn.rcloud.ru/app/streamstat/v2/times/regions?start=2020-08-01T00:00:00Z&end=2020-08-02T00:00:00Z&sort=-views&limit=2&fields=views,users,views_max&granularity=PT1H&account=account'

Пример успешного ответа

{
    "result": [
        {
            "start": "2020-08-01T19:00:00Z",
            "end": "2020-08-01T20:00:00Z",
            "result": [
                {
                    "views": 45884,
                    "users": 5163,
                    "views_max": 5134,
                    "country": "RU",
                    "region": "48",
                    "country_name": "Russia",
                    "region_name": "Moscow"
                }
            ]
        },
        {
            "start": "2020-08-01T16:00:00Z",
            "end": "2020-08-01T17:00:00Z",
            "result": [
                {
                    "views": 42318,
                    "users": 5825,
                    "views_max": 4060,
                    "country": "RU",
                    "region": "48",
                    "country_name": "Russia",
                    "region_name": "Moscow"
                }
            ]
        }
    ],
    "granularity": "PT1H",
    "start": "2020-08-01T00:00:00Z",
    "fields": [
        "views",
        "users",
        "views_max"
    ],
    "account": "account",
    "end": "2020-08-02T00:00:00Z",
    "limit": 2,
    "sort": "-views"
}