CyberRXN Docs
APIСправочник API

Аналитика активности пространства

GET /v1/activity

GET /v1/activity

Все операции API · OpenAPI

Нетарифицируемое чтение с правом usage:read. Фильтрует записанные тарифицируемые попытки по полуоткрытому интервалу UTC не длиннее 366 дней. Почасовые графики доступны до 31 дня. Итоги текущего и предыдущего интервалов одинаковой длительности, восемь лидирующих групп с остальными в Other и график с нулевыми пропусками используют одинаковые фильтры. Запрос ограничен пространством учётных данных. Имена участников доступны только сессиям кабинета. Неизвестное время ответа остаётся null. Расход включает текущие резервы без ошибок; чтение не меняет квоту или баланс пространства.

Доступ

Требуется bearer-авторизация. Описание операции задаёт дополнительные права, роли и ограничения для сессий кабинета. Сам по себе API-ключ их не предоставляет.

Параметры

ПолеТипОбязательноОписание
from (query)stringдаНачало интервала включительно: временная метка ISO в UTC. Длительность должна быть положительной и не превышать 366 дней.
to (query)stringдаКонец интервала не включается: временная метка ISO в UTC. Допускаются будущие календарные границы.
granularity (query)"day" ∣ "hour"нетИнтервалы по UTC. Почасовые графики доступны для периода не длиннее 31 дня.
group_by (query)"tool" ∣ "key" ∣ "member" ∣ "connection" ∣ "channel" ∣ "environment" ∣ "status"нет
tool (query)string ∣ nullнет
key_id (query)string ∣ nullнет
member_id (query)string ∣ nullнет
connection_id (query)string ∣ nullнет
channel (query)"rest" ∣ "mcp" ∣ nullнет
environment (query)"live" ∣ "test" ∣ nullнет
status (query)"reserved" ∣ "success" ∣ "error" ∣ nullнет
q (query)string ∣ nullнетПоиск буквального фрагмента ID запроса или имени инструмента.

Тело запроса

Тело запроса не требуется.

Ответы

HTTPОписаниеТип
200Успешный ответapplication/json: ActivityReport
401Требуется авторизацияapplication/problem+json: ProblemDetails
403Доступ запрещёнapplication/problem+json: ProblemDetails
404Не найденоapplication/problem+json: ProblemDetails
422Ошибка входных данныхapplication/problem+json: ProblemDetails
503Сервис недоступенapplication/problem+json: ProblemDetails

Ответ: ActivityReport

ПолеТипОбязательноОписание
fromstringда
tostringда
granularity"day" ∣ "hour"да
group_by"tool" ∣ "key" ∣ "member" ∣ "connection" ∣ "channel" ∣ "environment" ∣ "status"да
totalsActivityMetricsда
previousActivityComparisonдаНепосредственно предшествующий интервал той же длительности с теми же фильтрами.
groupsActivityGroup[]даВосемь лидирующих групп по числу запросов, затем при необходимости группа остальных Other.
bucketsActivityBucket[]даИнтервалы UTC с заполнением пропусков нулями и теми же идентификаторами, что в groups.
truncated_groupsbooleanда
Полная схема
{
  "properties": {
    "from": {
      "type": "string",
      "format": "date-time",
      "title": "From"
    },
    "to": {
      "type": "string",
      "format": "date-time",
      "title": "To"
    },
    "granularity": {
      "type": "string",
      "enum": [
        "day",
        "hour"
      ],
      "title": "Granularity"
    },
    "group_by": {
      "type": "string",
      "enum": [
        "tool",
        "key",
        "member",
        "connection",
        "channel",
        "environment",
        "status"
      ],
      "title": "Group By"
    },
    "totals": {
      "$ref": "#/components/schemas/ActivityMetrics"
    },
    "previous": {
      "$ref": "#/components/schemas/ActivityComparison",
      "description": "Immediately preceding equal-duration interval with the same filters."
    },
    "groups": {
      "items": {
        "$ref": "#/components/schemas/ActivityGroup"
      },
      "type": "array",
      "title": "Groups",
      "description": "Top eight groups by requests, followed by Other when needed."
    },
    "buckets": {
      "items": {
        "$ref": "#/components/schemas/ActivityBucket"
      },
      "type": "array",
      "title": "Buckets",
      "description": "Zero-filled UTC buckets with the same group identifiers as groups."
    },
    "truncated_groups": {
      "type": "boolean",
      "title": "Truncated Groups"
    }
  },
  "type": "object",
  "required": [
    "from",
    "to",
    "granularity",
    "group_by",
    "totals",
    "previous",
    "groups",
    "buckets",
    "truncated_groups"
  ],
  "title": "ActivityReport"
}

Эта страница генерируется из OpenAPI. Примеры показывают схемы, а не вымышленные успешные ответы.

Расход и оплата · Типизированные ошибки

На этой странице