查询时序用量指标

更新时间不可用

按小时或天的时间粒度获取指定时间范围内的用量指标,包括通话人数、通话人次、频道数、同时在线频道数、同时在线人数。

GET
https://api.sd-rtn.com/beta/insight/usage/by_time

鉴权

Authorization

使用声网 RESTful API 的凭证。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成一个使用 Base64 算法编码的凭证,并填入 HTTP 请求头部的 Authorization 字段。详见使用 HTTP 认证。

查询参数

startTsnumber
必填

查询的时间范围起点,Unix 时间戳(秒)。响应中会包含起点所在的时间窗口。

endTsnumber
必填

查询的时间范围终点,Unix 时间戳(秒)。响应中不会包含终点所在的时间窗口。

appidstring
必填

你的项目使用的 App ID。

metricstring
必填

要查询的指标,支持设为以下值:

  • userCount:通话人数,一个用户 ID 在一个频道中计为一人,在多个频道中计为多人。
  • sessionCount:通话进出人次,用户每加入一次频道计为一个通话人次。
  • channelCount:频道数,从有用户加入频道到所有用户离开频道计为一个通话频道。
  • peakConcurrentChannels:最大同时在线频道数。
  • peakConcurrentUsers:最大同时在线人数。
  • totalDuration:音视频通话时长(分钟)。
  • totalVideoDuration:视频通话时长(分钟)。
  • totalAudioDuration:音频通话时长(分钟)。
aggregateGranularitystring
必填

返回数据的粒度,支持设为以下值:

  • 1d:按天。此时返回查询时间范围内以 UTC 时间为零点起始的一整天的数据。
  • 1h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。

响应

OK

响应 Body

字段
codenumber

响应状态码。200 表示请求成功,详见响应状态码。

messagestring

错误消息。

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/beta/insight/usage/by_time?startTs=1631837410&endTs=1631837470&appid=string&metric=string&aggregateGranularity=string" \
  --header 'Authorization: Basic <credentials>'

响应示例

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "userCount": 42,
      "ts": 1625155200
    },
    {
      "userCount": 37,
      "ts": 1625241600
    }
  ]
}