nimeet Docs
中文

Analytics

Realtime, usage, quality, call search and data insight endpoints.

Generated from the public REST API definitions

Version v1.1.0 · Updated 2026-10-26 · revision 1

Group overview

Generated at build time from the public REST API definition: tag analytics, 7 operations (out of 189). For authentication, envelope and pagination conventions see REST API overview.

MethodPathSummary
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

Operation details

GET /v1/analytics/calls

Call search

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
fromquerystringformat date-time
toquerystringformat date-time
channelNamequerystring

Response

Status codesDescription / schema
200call sessions in the range, newest first — object{ from, to, granularity, total, calls }

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
channelNamepathisstringlength 0..128
fromquerystringformat date-time
toquerystringformat date-time

Response

Status codesDescription / schema
200one call session with per-user metrics and the timeline — AnalyticsCallSession

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
fromquerystringformat date-time
toquerystringformat date-time
granularityqueryenum(minute | hour | day)default "hour"
metricqueryenum(videoFreezeRate | audioFreezeRate | networkDelayRate | loginSuccessRate | login5sSuccessRate)
dimensionqueryenum(region | networkType | osType | sdkVersion | deviceType | channelSize)

Response

Status codesDescription / schema
200one metric over time plus its breakdown by the requested dimension — object{ metric, dimension, series, breakdown }

Example call

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)

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
fromquerystringformat date-time
toquerystringformat date-time
granularityqueryenum(minute | hour | day)default "hour"
productqueryenum(native | web)default "native"

Response

Status codesDescription / schema
200quality buckets for the range plus the range totals — object{ from, to, granularity, product, buckets, totals }

Example call

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

Authentication: project credentials (Base64 of customerId:customerSecret)

Request body

FieldTypeRequiredDescription
samplesarray<object>isup to 5000 items
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"
      }
    }
  ]
}

Response

Status codesDescription / schema
202how many quality samples were accepted / rejected — object{ accepted, rejected }

Example call

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)

Authentication: project credentials (Base64 of customerId:customerSecret)

Response

Status codesDescription / schema
200minute buckets for the realtime window plus the latest bucket and any active alarm — object{ windowMinutes, buckets, latest, alarm }

Example call

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

GET /v1/analytics/usage

Usage overview

Authentication: project credentials (Base64 of customerId:customerSecret)

Parameters

NameLocationRequiredTypeDescription
fromquerystringformat date-time
toquerystringformat date-time
granularityqueryenum(minute | hour | day)default "hour"

Response

Status codesDescription / schema
200usage summary for the range plus a 7-day forecast — object

Example call

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

Schemas used by this group

AnalyticsCallEvent — object{ ts, kind, uid, detail }
FieldTypeRequiredDescription
tsstringisformat date-time
kindenum(join | leave | network | video-send | audio-send)is
uidintegeris
detailstring
AnalyticsCallSession — object
FieldTypeRequiredDescription
projectIdstringis
channelNamestringis
startedAtstringisformat date-time
endedAtstring | nullisformat date-time
peakUsersintegeris
usersarray<object>is
eventsarray<object{ ts, kind, uid, detail }>is
AnalyticsCallUser — object
FieldTypeRequiredDescription
uidintegeris
userIdstring | nullis
roleenum(host | audience)is
platformintegerisAgora platform code (0 iOS, 1 Android, 2 Windows, 5 Web, 6 macOS, 7 Linux, 8 Other)
joinedAtstringisformat date-time
leftAtstring | nullisformat date-time
durationSecondsnumberis
audioFreezeRatenumberis
videoFreezeRatenumberis
networkDelayRatenumberis
AnalyticsDiagnosis — object{ video, audio, network }
FieldTypeRequiredDescription
videoenum(good | warn | bad)is
audioenum(good | warn | bad)is
networkenum(good | warn | bad)is
AnalyticsQualityBucket — object
FieldTypeRequiredDescription
bucketStartstringisformat date-time
averageLoginTimeMsnumberis
audioFreezeRatenumberis
videoFreezeRatenumberis
networkDelayRatenumberis
inCallUsersintegeris
inCallChannelsintegeris
joinAttemptsintegeris
joinSuccessesintegeris
joinWithin5sintegeris
AnalyticsUsageBucket — object{ bucket, type, minutes, channels, users }
FieldTypeRequiredDescription
bucketstringis
typeenum(audio | video | recording | streaming | transcoding)is
minutesnumberis
channelsintegeris
usersintegeris

Generated by the documentation build pipeline · 2026-10-31 01:24:02 UTC · Documentation center v1.1.0.

Content follows the public API definitions.

ni-meet is a self-hosted RTC PaaS with a LiveKit-based media plane (Apache-2.0) and an Agora-compatible API.