Портал Rcloud
Дерево страниц
Перейти к концу метаданных
Переход к началу метаданных

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

Данный API используется для получения информации о просмотрах потоков в текущий момент времени.

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

Имя заголовкаОписаниеОбязательный
CDN-AUTH-TOKENАвторизационный токенДа


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

Имя параметраОписаниеОбязательный
accountИмя аккаунтаДа
fieldsПоля, значения которых нужно вернуть (views, views_by_type, detail)Нет


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

Имя параметраОписание
statusСтатус ответа (Completed, Unauthorized, Forbidden, Error)
descriptionОписание статуса ответа
resultОсновная информация ответа
accountИмя аккаунта
streamПоток
viewsКоличество зрителей
views_by_typeКоличество зрителей в разбивке по типам просмотра
detailДетальная информация по зрителям
IpAddressIP адрес зрителя
UserAgentUseragent зрителя
UserIdID зрителя
ViewTypeТип просмотра


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

Код ответаОписание
200OK
400Неверный запрос
401Не авторизован
403Доступ запрещен
500Внутренняя ошибка сервера
503Сервис недоступен


Общая статистика

Данный вызов используется для получения общей информации о просмотрах потоков в текущий момент времени.

URL: https://apicdn.rcloud.ru/app/activesessions/v1/streams

  • Тип запроса: GET
  • Заголовки: CDN-AUTH-TOKEN
  • Тип данных ответа: JSON Object

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
'https://apicdn.rcloud.ru/app/activesessions/v1/streams?account=testaccount'

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

{
  "status": "Completed",
  "description": "Success",
  "account": [
    "testaccount"
  ],
  "fields": [
    "account",
    "stream",
    "views",
    "views_by_type"
  ],
  "result": [
    {
      "account": "testaccount",
      "stream": "test/_definst_/360p_test.sdp",
      "views_by_type": {
        "HLS": 8
      },
      "views": 8
    },
    {
      "account": "testaccount",
      "stream": "test/_definst_/720p_test.sdp",
      "views_by_type": {
        "HLS": 7
      },
      "views": 7
    }
  ]
}

Детальная статистика

Данный вызов используется для получения детальной информации о просмотрах потоков в текущий момент времени.

URL: https://apicdn.rcloud.ru/app/activesessions/v1/streams?account=<your_account_name>&fields=detail

  • Тип запроса: GET
  • Заголовки: CDN-AUTH-TOKEN
  • Тип данных ответа: JSON Object

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

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
'https://apicdn.rcloud.ru/app/activesessions/v1/streams?account=testaccount&fields=detail'

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

{
  "status": "Completed",
  "description": "Success",
  "account": [
    "testaccount"
  ],
  "fields": [
    "account",
    "detail",
    "stream"
  ],
  "result": [
    {
      "account": "testaccount",
      "stream": "test/_definst_/360p_test.sdp",
      "detail": [
        {
          "IpAddress": "84.142.236.203",
          "UserAgent": "samsunghas-agent/1.1",
          "UserId": "eec0c296479e296658e4d2b78ctestb0",
          "ViewType": "HLS"
        },
        {
          "IpAddress": "85.246.51.121",
          "UserAgent": "HLS Client/2.0 (compatible; LG NetCast.TV-2012)",
          "UserId": "64f3c932ebc77cdtestaada7665d657d",
          "ViewType": "HLS"
        }
      ]
    }
  ]
}
  • Нет меток