You need to enable JavaScript to run this app.
导航
获取直播间基础数据
最近更新时间:2024.09.04 17:24:26首次发布时间:2022.03.29 22:10:12

您可通过此接口获取指定直播间观看的 PV、UV、页面访问总时长、人均页面访问时长和次数。数据 5 分钟更新一次。

说明

该接口已经不再维护,建议调用 GetPageWatchDataAPIV2 接口获取直播间的基础数据。

请求说明

  • 接口名称:GetPageWatchDataAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=GetPageWatchDataAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 1000 次/分钟

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt64直播间 ID。您可通过ListActivityAPI 接口查询 ID

Source

Int32

根据页面访问来源进行筛选。支持以下六种取值,默认取值为 0

  • -1:查询所有;
  • 0:查询默认来源;
  • 1:查询来源 A;
  • 2:查询来源 B;
  • 3:查询来源 C;
  • 4:查询来源 D。

PlayStatus

Int32

根据直播状态进行筛选。支持以下五种取值,默认取值为 10

  • 1:直播观看;
  • 2:预告观看;
  • 3:回放观看;
  • 10:页面访问(页面停留);
  • 11:总观看。

返回参数

参数类型描述
ActivityIdInt64直播间 ID
PageClicksArray of PageClicks直播间基础数据

PageClicks

参数类型描述
PVInt直播间 PV
UVInt直播间 UV
TotalTimeInt直播间页面的访问总时长,单位分钟
AvgTimeFloat直播间页面的人均访问时长,单位分钟
AvgNumberFloat直播间页面的人均访问次数
PcuInt直播间页面访问的峰值人数

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetPageWatchDataAPI&Version=2020-06-01&ActivityId=1231231231&Source=0&PlayStatus=11

正常返回示例

{
		"ResponseMetadata":{
				"RequestId":"202201201826170101501312091D1C09D2",
				"Action":"GetPageWatchDataAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132
		},
		"Result":{
				"ActivityId":1693175001558040,	
				"PageClicks":{	
						"PV":111,
						"UV":111,	
						"TotalTime":111,	
						"AvgTime":1.2,	
						"AvgNumber":1.2,		
						"Pcu":123		
				}
		}
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"GetPageWatchDataAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
    }
}

错误码

访问公共错误码获取详细信息。