文档首页> 视频直播 Live> API参考> 数据统计分析> 查询播放画像信息接口
更新时间:2022-04-11 GMT+08:00
分享

查询播放画像信息接口

功能介绍

查询播放画像信息。

最大查询跨度1天,最大查询周期31天。

不统计协议为HLS的播放时长(play_duration)信息。

接口约束

该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/stats/stream-portraits

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

play_domain

String

播放域名。

stream

String

流名。

time

String

统计日期,日期格式按照ISO8601表示法,格式:YYYYMMDD,如20200904。可以查询过去31天的数据(不含当天)。

请求参数

表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参数

参数

参数类型

描述

stream_portraits

Array of StreamPortrait objects

播放画像信息列表。

表6 StreamPortrait

参数

参数类型

描述

time

String

统计日期,日期格式按照ISO8601表示法,格式:YYYYMMDD,如20200904。统计该统计日期00:00-23:59时段的播放画像信息。

flow

Long

累计流量,单位为byte。

play_duration

Long

累计播放时长,单位为秒。

request_count

Long

累计请求次数。

user_count

Long

累计观看人数,根据IP去重。

peak_user_count

Long

峰值观看人数,flv/rtmp协议是统计Session会话ID,其它协议统计IP,1分钟的采样数据。

peak_bandwidth

Long

峰值带宽,单位bps,5分钟的采样数据。

push_duration

Long

累计直播(推流)时长,单位为秒。

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v2/{project_id}/stats/stream-portraits?play_domain=example.huawei.com&stream=stream-000&time=20200904

响应示例

状态码: 200

处理成功返回。

{
  "play_info_list" : [ {
    "time" : 20200812,
    "flow" : 10,
    "play_duration" : 10,
    "request_count" : 10,
    "user_count" : 10,
    "peak_user_count" : 10,
    "peak_bandwidth" : 10,
    "push_duration" : 10
  } ]
}

状态码: 400

参数错误。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: play_domain"
}

状态码

状态码

描述

200

处理成功返回。

400

参数错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读