文档首页/实时音视频 SparkRTC/API参考/数据统计分析/查询历史质量 - ListRtcHistoryQuality
更新时间：2025-11-04 GMT+08:00
查看PDF
分享

查询历史质量 - ListRtcHistoryQuality

功能介绍

查询质量指标过去每天的体验数据，可查询最近31天的数据。当天未结束，无法查询到当天的体验数据。

最大查询跨度31天。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/rtc/history/quality

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

app

是

String

应用标识

metric

是

Array of strings

查询的数据类型

  • JoinSuccessRate：加入房间成功率

  • JoinSuccess5SecsRate：5秒加入成功率

  • VideoFreezeRate：视频卡顿率

  • AudioFreezeRate：音频卡顿率

  • FirstVideoRecvTime：首帧视频接收耗时

  • FirstAudioRecvTime：首帧音频接收耗时

  • PullStreamSuccessRate：拉流成功率

  • PushStreamSuccessRate：推流成功率

  • VideoUpstreamExcellentTransRate：客户端视频上行优质传输率

  • AudioUpstreamExcellentTransRate：客户端音频上行优质传输率

  • VideoExcellentTransRate：端到端视频优质传输率

  • AudioExcellentTransRate：端到端音频优质传输率

  • VideoTransDelay：端到端视频网络时，单位为毫秒，取当天所有用户网络延迟的中位数

  • AudioTransDelay：端到端音频网络时延，单位为毫秒，取当天所有用户网络延迟的中位数

start_date

否

String

查询起始时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23，不写默认读取过去1天数据数据。

end_date

否

String

查询结束时间。UTC时间，格式：YYYY-MM-DD，如2020-04-23

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识

表5 响应Body参数

参数

参数类型

描述

quality

Array of RtcHistoryQualityTimeValue objects

时间戳及相应时间的指标数值列表

表6 RtcHistoryQualityTimeValue

参数

参数类型

描述

date

String

采样时间。日期格式按照ISO8601表示法，并使用UTC时间。格式为YYYY-MM-DD

join_success_rate

Double

加入房间成功率参数取值，取值为1代表成功率100%

join_success_in5secs_rate

Double

5s内加入房间成功率参数取值，取值为1代表成功率100%

video_freeze_rate

Double

视频卡顿率参数取值，取值为1代表卡顿率100%

audio_freeze_rate

Double

音频卡顿率参数取值，取值为1代表卡顿率100%

first_video_recv_time

Long

首帧视频接收耗时，单位毫秒

first_audio_recv_time

Long

首帧音频接收耗时，单位毫秒

pull_stream_success_rate

Double

拉流成功率参数取值，取值为1代表成功率100%

push_stream_success_rate

Double

推流成功率参数取值，取值为1代表成功率100%

video_upstream_excellent_trans_rate

Double

客户端视频上行优质传输率，取值为1代表传输率100%

audio_upstream_excellent_trans_rate

Double

客户端音频上行优质传输率，取值为1代表传输率100%

video_excellent_trans_rate

Double

端到端视频优质传输率，取值为1代表传输率100%

audio_excellent_trans_rate

Double

端到端音频优质传输率，取值为1代表传输率100%

video_trans_delay

Double

端到端视频网络时延，单位为毫秒，取当天所有用户网络延迟的中位数。

audio_trans_delay

Double

端到端音频网络时延，单位为毫秒，取当天所有用户网络延迟的中位数。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v1/{project_id}/rtc/history/quality?app=5fa682b34a974f7ad24d223b&metric=VideoFreezeRate,AudioTransDelay&start_date=2020-04-23&end_date=2020-04-26

响应示例

状态码：200

查询成功返回。

{
  "quality" : [ {
    "date" : "2020-06-04",
    "join_success_rate" : 0.99
  } ]
}

状态码：400

查询失败返回

{
  "error_code" : "DATA.100011001",
  "error_msg" : "Required String parameter 'app' is not present"
}

状态码

状态码

描述

200

查询成功返回。

400

查询失败返回

错误码

请参见错误码。

父主题：数据统计分析