nimeet 文档中心
English

水晶球（数据分析）

构建时从公开 REST 接口定义的 `analytics` 标签生成：方法、路径、参数、请求体、响应与 curl。

由公开 REST 接口定义生成

版本 v1.1.0 · 更新于 2026-10-26 · 修订 1

分组概览

本页由公开 REST 接口定义在构建时生成：标签 analytics，共 7 个操作（全量 189 个）。鉴权、信封与分页约定见 REST API 总览.

方法路径摘要
GET/v1/analytics/callsCall search
GET/v1/analytics/calls/{channelName}Call inspector
GET/v1/analytics/data-insightData insights by dimension
GET/v1/analytics/qualityQuality overview (rates + diagnosis)
POST/v1/analytics/qualityIngest SDK quality samples
GET/v1/analytics/realtimeReal-time monitoring (last 30 min, 1-min buckets)
GET/v1/analytics/usageUsage overview

操作详情

GET /v1/analytics/calls

Call search

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
fromquerystringformat date-time
toquerystringformat date-time
channelNamequerystring

响应

状态码说明 / schema
200call sessions in the range, newest first — object{ from, to, granularity, total, calls }

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/analytics/calls?from=%24FROM&to=%24TO&channelName=weekly-sync" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v1/analytics/calls/{channelName}

Call inspector

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
channelNamepath是string长度 0..128
fromquerystringformat date-time
toquerystringformat date-time

响应

状态码说明 / schema
200one call session with per-user metrics and the timeline — AnalyticsCallSession

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/analytics/calls/weekly-sync?from=%24FROM&to=%24TO" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v1/analytics/data-insight

Data insights by dimension

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
fromquerystringformat date-time
toquerystringformat date-time
granularityqueryenum(minute | hour | day)默认 "hour"
metricqueryenum(videoFreezeRate | audioFreezeRate | networkDelayRate | loginSuccessRate | login5sSuccessRate)
dimensionqueryenum(region | networkType | osType | sdkVersion | deviceType | channelSize)

响应

状态码说明 / schema
200one metric over time plus its breakdown by the requested dimension — object{ metric, dimension, series, breakdown }

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/analytics/data-insight?from=%24FROM&to=%24TO&granularity=hour&metric=videoFreezeRate&dimension=region" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v1/analytics/quality

Quality overview (rates + diagnosis)

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
fromquerystringformat date-time
toquerystringformat date-time
granularityqueryenum(minute | hour | day)默认 "hour"
productqueryenum(native | web)默认 "native"

响应

状态码说明 / schema
200quality buckets for the range plus the range totals — object{ from, to, granularity, product, buckets, totals }

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/analytics/quality?from=%24FROM&to=%24TO&granularity=hour&product=native" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

POST /v1/analytics/quality

Ingest SDK quality samples

鉴权：项目凭证（customerId:customerSecret 的 Base64）

请求体

字段类型必填说明
samplesarray<object>是最多 5000 项
json
{
  "samples": [
    {
      "channelName": "weekly-sync",
      "uid": 10001,
      "bucketStart": "$BUCKET_START",
      "videoFreezeMs": 0,
      "videoDurationMs": 60000,
      "audioFreezeMs": 0,
      "audioDurationMs": 60000,
      "networkDelayMs": 0,
      "networkDelayDurationMs": 60000,
      "joinAttempt": true,
      "joinSuccess": true,
      "joinDelayMs": 320,
      "dimensions": {
        "region": "cn-shanghai",
        "networkType": "wifi",
        "osType": "web",
        "sdkVersion": "1.0.0"
      }
    }
  ]
}

响应

状态码说明 / schema
202how many quality samples were accepted / rejected — object{ accepted, rejected }

调用示例

bash
curl -s -X POST "$NIMEET_API_BASE/v1/analytics/quality" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC" \
  -H "Content-Type: application/json" \
  -d '{"samples":[{"channelName":"weekly-sync","uid":10001,"bucketStart":"$BUCKET_START","videoFreezeMs":0,"videoDurationMs":60000,"audioFreezeMs":0,"audioDurationMs":60000,"networkDelayMs":0,"networkDelayDurationMs":60000,"joinAttempt":true,"joinSuccess":true,"joinDelayMs":320,"dimensions":{"region":"cn-shanghai","networkType":"wifi","osType":"web","sdkVersion":"1.0.0"}}]}'

GET /v1/analytics/realtime

Real-time monitoring (last 30 min, 1-min buckets)

鉴权：项目凭证（customerId:customerSecret 的 Base64）

响应

状态码说明 / schema
200minute buckets for the realtime window plus the latest bucket and any active alarm — object{ windowMinutes, buckets, latest, alarm }

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/analytics/realtime" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

GET /v1/analytics/usage

Usage overview

鉴权：项目凭证（customerId:customerSecret 的 Base64）

参数

名称位置必填类型说明
fromquerystringformat date-time
toquerystringformat date-time
granularityqueryenum(minute | hour | day)默认 "hour"

响应

状态码说明 / schema
200usage summary for the range plus a 7-day forecast — object

调用示例

bash
curl -s -X GET "$NIMEET_API_BASE/v1/analytics/usage?from=%24FROM&to=%24TO&granularity=hour" \
  -H "Authorization: Basic $NIMEET_CUSTOMER_BASIC"

本分组用到的 Schema

AnalyticsCallEvent — object{ ts, kind, uid, detail }
字段类型必填说明
tsstring是format date-time
kindenum(join | leave | network | video-send | audio-send)是
uidinteger是
detailstring
AnalyticsCallSession — object
字段类型必填说明
projectIdstring是
channelNamestring是
startedAtstring是format date-time
endedAtstring | null是format date-time
peakUsersinteger是
usersarray<object>是
eventsarray<object{ ts, kind, uid, detail }>是
AnalyticsCallUser — object
字段类型必填说明
uidinteger是
userIdstring | null是
roleenum(host | audience)是
platforminteger是Agora platform code (0 iOS, 1 Android, 2 Windows, 5 Web, 6 macOS, 7 Linux, 8 Other)
joinedAtstring是format date-time
leftAtstring | null是format date-time
durationSecondsnumber是
audioFreezeRatenumber是
videoFreezeRatenumber是
networkDelayRatenumber是
AnalyticsDiagnosis — object{ video, audio, network }
字段类型必填说明
videoenum(good | warn | bad)是
audioenum(good | warn | bad)是
networkenum(good | warn | bad)是
AnalyticsQualityBucket — object
字段类型必填说明
bucketStartstring是format date-time
averageLoginTimeMsnumber是
audioFreezeRatenumber是
videoFreezeRatenumber是
networkDelayRatenumber是
inCallUsersinteger是
inCallChannelsinteger是
joinAttemptsinteger是
joinSuccessesinteger是
joinWithin5sinteger是
AnalyticsUsageBucket — object{ bucket, type, minutes, channels, users }
字段类型必填说明
bucketstring是
typeenum(audio | video | recording | streaming | transcoding)是
minutesnumber是
channelsinteger是
usersinteger是

本页由文档构建流水线生成 · 2026-10-31 01:24:02 UTC · 文档中心 v1.1.0.

内容依据公开 API 定义.

ni-meet 是自建 RTC PaaS，媒体面基于 LiveKit（Apache-2.0），并与声网 API 兼容。