# 获取直播大屏数据

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：getlivedata

获取直播大屏数据

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/livedashboard/getlivedata?access_token=ACCESS_TOKEN

# 云调用

本接口不支持云调用

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：176
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
export_id	string	是	直播唯一ID

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	示例	说明
errcode	number		错误码
errmsg	string		错误信息
trace_id	string		追踪ID，报bug带
live_dashboard_data	object		直播大屏基础数据json，对应实体 LiveDashboardData
live_comparison_index	object	在播时，字段 ended 为空；关播后，字段 on_air 为空。例子: { "is_living": true, "on_air": { "recommend_effective_new_watch_2_uv_over_impression_uv": { "n": 10, "last_n_mins_value": 187, "last_2n_to_n_mins_value": 161, "last_n_mins_percentile": 40, "value": 134, "percentile": 20 }, "average_watch_seconds": { "n": 10, "last_n_mins_value": 51, "last_2n_to_n_mins_value": 48, "last_n_mins_percentile": 30, "value": 60, "percentile": 40 }, "comment_uv_over_new_watch_uv": { "n": 10, "last_n_mins_value": 103, "last_2n_to_n_mins_value": 68, "last_n_mins_percentile": 40, "value": 61, "percentile": 20 }, "like_uv_over_new_watch_uv": { "n": 10, "last_n_mins_value": 12, "last_2n_to_n_mins_value": 36, "last_n_mins_percentile": 60, "value": 38, "percentile": 30 } } }	内容力数据json，对应实体 LiveComparisonIndex
live_ec_data_summary	object	注意，文档未列出的指标是未定义。例子: { "total_gmv": 16564600, "total_pay_uv": 537, "total_pay_pv": 553, "total_create_uv": 590, "total_create_pv": 612, "refund_amount": 717600 } Li	电商数据概要数据json，对应实体 LiveEcDataSummary
live_ec_conversion_metric	object		电商转化力数据json，对应实体 LiveEcConversionMetric
live_ec_profile	object		电商画像数据json，对应实体 LiveEcProfile
live_distribution_channel	object		电商渠道分布json，对应实体 LiveDistributionChannel
single_live_ec_spu_data_page_v2	object		电商商品数据json，对应实体 SingleLiveEcSpuDataPageV2

# Res.live_dashboard_data `Object Payload`

直播大屏基础数据json，对应实体 LiveDashboardData

参数名	类型	说明
LiveDashboardData2	object	LiveDashboardData2

# Res.live_comparison_index `Object Payload`

内容力数据json，对应实体 LiveComparisonIndex

参数名	类型	说明
is_living	boolean	是否正在直播
on_air.recommend_effective_new_watch_2_uv_over_impression_uv	LiveComparisonIndex_OnAirIndexItem	曝光有效CTR（万分比）
on_air.average_watch_seconds	LiveComparisonIndex_OnAirIndexItem	人均看播时长
on_air.comment_uv_over_new_watch_uv	LiveComparisonIndex_OnAirIndexItem	评论率（万分比）
on_air.like_uv_over_new_watch_uv	LiveComparisonIndex_OnAirIndexItem	点赞率（万分比）
ended.recommend_effective_new_watch_2_uv_over_impression_uv	LiveComparisonIndex_EndedIndexItem	曝光有效CTR（万分比）
ended.average_watch_seconds	LiveComparisonIndex_EndedIndexItem	人均看播时长
ended.comment_uv_over_new_watch_uv	LiveComparisonIndex_EndedIndexItem	评论率（万分比）
ended.like_uv_over_new_watch_uv	LiveComparisonIndex_EndedIndexItem	点赞率（万分比）

# Res.live_ec_data_summary `Object Payload`

电商数据概要数据json，对应实体 LiveEcDataSummary

参数名	类型	说明
total_gmv	number	成交金额（单位：分）
total_pay_pv	number	成交次数
total_pay_uv	number	成交人数
total_create_pv	number	订单创建次数
total_create_uv	number	订单创建人数
refund_amount	number	退款金额（单位：分）

# Res.live_ec_conversion_metric `Object Payload`

电商转化力数据json，对应实体 LiveEcConversionMetric

参数名	类型	说明
recent_10_min_conversion	LiveEcConversionMetric_ConversionMetric	近10分钟转化率数据
whole_live_conversion	LiveEcConversionMetric_ConversionMetric	整场直播转化率数据

# Res.live_ec_profile `Object Payload`

电商画像数据json，对应实体 LiveEcProfile

参数名	类型	说明
profiles	array[LiveEcProfile_DataNodeThirdList]	包含不同用户群体的统计数据
totals	array[LiveEcProfile_DataNodeList]	总体数据统计信息

# Res.live_distribution_channel `Object Payload`

电商渠道分布json，对应实体 LiveDistributionChannel

参数名	类型	示例	说明
live_dist_channel_source_by_scene_stats	object	例子: { "scene_type": 1, "dist_flow_type_stats": [ { "live_dst_channel_type": 1, "metric_value": 5285, "channel_source_stats": [], "metric_value_ratio": 0.041437655342203686 }, { "live_dst_channel_type": 2, "metric_value": 14758, "channel_source_stats": [], "metric_value_ratio": 0.11571181031981873 }, { "live_dst_channel_type": 3, "metric_value": 107498, "channel_source_stats": [], "metric_value_ratio": 0.8428505343379776 } ], "metric_value_total": 127541 }	按场景划分的渠道分析统计值
live_dist_channel_source_stats	object		按照流量类型、渠道层级划分的渠道分析统计数据

# Res.single_live_ec_spu_data_page_v2 `Object Payload`

电商商品数据json，对应实体 SingleLiveEcSpuDataPageV2

参数名	类型	说明
spu_data_list	object	商品明细数据
total_cnt	number	spu_data_list 的总长度

# Res.live_dashboard_data.LiveDashboardData2 `Object Payload`

LiveDashboardData2

参数名	类型	说明
summary	object	直播基础数据
source	object	直播流量渠道
portrait	object	直播观众画像

# Res.live_dashboard_data.LiveDashboardData2.summary `Object Payload`

直播基础数据

参数名	类型	说明
new_watch_uv	number	观看人数
max_online_watch_uv	number	最大在线人数
impression_uv	number	曝光人数
average_watch_seconds_per_audience	number	平均观看时长（秒）
new_follow_uv	number	新增关注人数
new_fans_club_uv	number	新增粉丝团人数
comment_uv	number	评论人数
reward_uv	number	打赏人数
sharing_uv	number	分享直播间人数
hot_quota	number	热度

# Res.live_dashboard_data.LiveDashboardData2.source `Object Payload`

直播流量渠道

参数名	类型	说明
new_watch_uv	object	观看人数的渠道分布。 new_watch_uv 的维度组合有两种： 1、16 2、16, 1, 7 枚举值参考下文DimensionType

# Res.live_dashboard_data.LiveDashboardData2.portrait `Object Payload`

直播观众画像

参数名	类型	说明
online_watch_uv	object	在线人数的画像。对于 online_watch_uv 里的所有时间戳字段无意义，毋须理解。online_watch_uv 里的数据仅在直播中时有效，直播结束后该字段的值无意义。
new_watch_uv	object	观看人数的画像。 online_watch_uv 和 new_watch_uv 的维度组合有八种： 1、2 2、3 3、5 4、9 5、10 6、11 7、12 8、13 这八种维度组合都是由单个维度构成。枚举值参考下文DimensionType

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats `Object Payload`

按场景划分的渠道分析统计值

参数名	类型	说明
scene_type	LiveDistributionChannel_LiveDistributionSceneType	场景类型
dist_flow_type_stats	object	该场景下的渠道分析统计值
metric_value_total	number	指标值总数
gmv	number	GMV总值（单位：分）
uv	number	UV总值
gmv_per_uv	number	千次看播成交（单位：分）
metric_value	number	指标值
metric_value_ratio	number	在该渠道下的统计值比率
pv	number	pv

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats.dist_flow_type_stats `Object Payload`

该场景下的渠道分析统计值

参数名	类型	示例	说明
live_dst_channel_type	LiveDistributionChannel_LiveDistributionFlowType		渠道流量类型
j	object	指标渠道来源统计分析统计数据。例子： { "level": 1, "source_channel_id": 3, "sub_channel_source_stats": [ { "level": 2, "source_channel_id": 3, "gmv": 0, "uv": 0, "gmv_ratio": 0.0, "uv_ratio": 0.0, "source_channel_name": "朋友圈" }, { "level": 2, "source_channel_id": 4, "gmv": 269100, "uv": 8, "gmv_ratio": 1.0, "uv_ratio": 1.0, "source_channel_name": "聊天页" }, { "level": 2, "source_channel_id": 5, "gmv": 0, "uv": 0, "gmv_ratio": 0.0, "uv_ratio": 0.0, "source_channel_name": "其他" } ], "gmv": 269100, "uv": 8, "gmv_ratio": 0.125, "uv_ratio": 0.11764705882352941, "source_channel_name": "分享" }	一级类目渠道来源指标划分
gmv	number		GMV总值（单位：分）
uv	number		UV总值
gmv_per_uv	number		千次看播成交（单位：分）(GPV)
pv	number		PV总值
pv_ratio	number		当前层级pv占总pv的比例
uv_ratio	number		uv占比

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats.dist_flow_type_stats.j `Object Payload`

一级类目渠道来源指标划分

参数名	类型	说明
level	number	渠道层级
source_channel_id	number	来源渠道ID
sub_channel_source_stats	object	流量来源子渠道指标数据统计值，指标渠道来源统计分析统计数据（二级）。
gmv	number	GMV总值（单位：分）
uv	number	UV总值
gmv_per_uv	number	千次看播成交（单位：分）(GPV)
gmv_ratio	number	gmv占比
uv_ratio	number	uv占比
source_channel_name	string	渠道名称
pv_ratio	number	当前层级pv占总pv的比例

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats.dist_flow_type_stats.j.sub_channel_source_stats `Object Payload`

流量来源子渠道指标数据统计值，指标渠道来源统计分析统计数据（二级）。

参数名	类型	说明
level	number	渠道层级
source_channel_id	number	来源渠道ID
metric_value	number	在该渠道下的统计值
gmv	number	GMV总值（单位：分）
uv	number	UV总值
gmv_per_uv	number	千次看播成交（单位：分）
gmv_ratio	number	gmv占比
uv_ratio	number	uv占比
metric_value_ratio	number	在该渠道下的统计值比率
source_channel_name	string	渠道名称
pv	number	pv
pv_ratio	number	pv在该渠道下的统计值比率

# Res.live_distribution_channel.live_dist_channel_source_stats `Object Payload`

按照流量类型、渠道层级划分的渠道分析统计数据

参数名	类型	示例	说明
live_dst_channel_type	LiveDistributionChannel_LiveDistributionFlowType		渠道流量类型
j	object	指标渠道来源统计分析统计数据。例子： { "level": 1, "source_channel_id": 3, "sub_channel_source_stats": [ { "level": 2, "source_channel_id": 3, "gmv": 0, "uv": 0, "gmv_ratio": 0.0, "uv_ratio": 0.0, "source_channel_name": "朋友圈" }, { "level": 2, "source_channel_id": 4, "gmv": 269100, "uv": 8, "gmv_ratio": 1.0, "uv_ratio": 1.0, "source_channel_name": "聊天页" }, { "level": 2, "source_channel_id": 5, "gmv": 0, "uv": 0, "gmv_ratio": 0.0, "uv_ratio": 0.0, "source_channel_name": "其他" } ], "gmv": 269100, "uv": 8, "gmv_ratio": 0.125, "uv_ratio": 0.11764705882352941, "source_channel_name": "分享" }	一级类目渠道来源指标划分
gmv	number		GMV总值（单位：分）
uv	number		UV总值
gmv_per_uv	number		千次看播成交（单位：分）(GPV)
pv	number		PV总值
pv_ratio	number		当前层级pv占总pv的比例
uv_ratio	number		uv占比

# Res.live_distribution_channel.live_dist_channel_source_stats.j `Object Payload`

一级类目渠道来源指标划分

参数名	类型	说明
level	number	渠道层级
source_channel_id	number	来源渠道ID
sub_channel_source_stats	object	流量来源子渠道指标数据统计值，指标渠道来源统计分析统计数据（二级）。
gmv	number	GMV总值（单位：分）
uv	number	UV总值
gmv_per_uv	number	千次看播成交（单位：分）(GPV)
gmv_ratio	number	gmv占比
uv_ratio	number	uv占比
source_channel_name	string	渠道名称
pv_ratio	number	当前层级pv占总pv的比例

# Res.live_distribution_channel.live_dist_channel_source_stats.j.sub_channel_source_stats `Object Payload`

流量来源子渠道指标数据统计值，指标渠道来源统计分析统计数据（二级）。

参数名	类型	说明
level	number	渠道层级
source_channel_id	number	来源渠道ID
metric_value	number	在该渠道下的统计值
gmv	number	GMV总值（单位：分）
uv	number	UV总值
gmv_per_uv	number	千次看播成交（单位：分）
gmv_ratio	number	gmv占比
uv_ratio	number	uv占比
metric_value_ratio	number	在该渠道下的统计值比率
source_channel_name	string	渠道名称
pv	number	pv
pv_ratio	number	pv在该渠道下的统计值比率

# Res.single_live_ec_spu_data_page_v2.spu_data_list `Object Payload`

商品明细数据

参数名	类型	说明
base_data.src_spu_id	string	商品id
base_data.src	number	店铺名称
base_data.spu_name	string	商品名称
exp_uv	number	商品曝光人数
clk_uv	number	商品点击人数
share_uv	number	商品分享人数
clk_pv	number	商品点击次数
exp_clk_ratio	number	商品曝光点击率
clk_pay_ratio	number	商品点击成交率
gmv	number	商品成交金额（单位：分）
pay_pv	number	商品成交订单数
refund_amount	number	商品退款金额（单位：分）
refund_pv	number	商品退款订单数

# 4. 注意事项

DimensionType枚举值

枚举值	含义
1	一级渠道
2	年龄段
3	性别
5	关注关系
7	二级渠道
9	策略人群
10	省级行政区
11	地级行政区
12	消费者商品类目偏好
13	客单价区间
15	关注关系
16	流量类型（自然流量、直播加热、广告投流）

LiveDistributionChannel_LiveDistributionSceneType

枚举值	含义
6	商品曝光
7	直播间曝光次数
8	商品点击次数
9	创建订单数按渠道统计
10	成交订单数按渠道统计

LiveDistributionChannel_LiveDistributionFlowType

枚举值	含义
0	无效值
1	自然流量
2	加热流量
3	广告流量
4	公域流量
5	私域流量

# 5. 代码示例

请求示例

{
    "export_id": "export/UzFf*****************************************************************************************64V"
}

返回示例

{
    "errcode": 0,
    "errmsg": "",
    "trace_id": "",
    "live_dashboard_data": {
        "LiveDashboardData2": {
            "summary": {
                "new_watch_uv": 0,
                "max_online_watch_uv": 0,
                "impression_uv": 0,
                "average_watch_seconds_per_audience": 0,
                "new_follow_uv": 0,
                "new_fans_club_uv": 0,
                "comment_uv": 0,
                "reward_uv": 0,
                "sharing_uv": 0,
                "hot_quota": 0
            },
            "source": {
                "new_watch_uv": {}
            },
            "portrait": {
                "online_watch_uv": {},
                "new_watch_uv": {}
            }
        }
    },
    "live_comparison_index": {
        "is_living": false
    },
    "live_ec_data_summary": {
        "total_gmv": 0,
        "total_pay_pv": 0,
        "total_pay_uv": 0,
        "total_create_pv": 0,
        "total_create_uv": 0,
        "refund_amount": 0
    },
    "live_ec_conversion_metric": {},
    "live_ec_profile": {},
    "live_distribution_channel": {
        "live_dist_channel_source_by_scene_stats": {
            "dist_flow_type_stats": {
                "j": {
                    "level": 0,
                    "source_channel_id": 0,
                    "sub_channel_source_stats": {
                        "level": 0,
                        "source_channel_id": 0,
                        "metric_value": 0,
                        "gmv": 0,
                        "uv": 0,
                        "gmv_per_uv": 0,
                        "gmv_ratio": 0,
                        "uv_ratio": 0,
                        "metric_value_ratio": 0,
                        "source_channel_name": "",
                        "pv": 0,
                        "pv_ratio": 0
                    },
                    "gmv": 0,
                    "uv": 0,
                    "gmv_per_uv": 0,
                    "gmv_ratio": 0,
                    "uv_ratio": 0,
                    "source_channel_name": "",
                    "pv_ratio": 0
                },
                "gmv": 0,
                "uv": 0,
                "gmv_per_uv": 0,
                "pv": 0,
                "pv_ratio": 0,
                "uv_ratio": 0
            },
            "metric_value_total": 0,
            "gmv": 0,
            "uv": 0,
            "gmv_per_uv": 0,
            "metric_value": 0,
            "metric_value_ratio": 0,
            "pv": 0
        },
        "live_dist_channel_source_stats": {
            "j": {
                "level": 0,
                "source_channel_id": 0,
                "sub_channel_source_stats": {
                    "level": 0,
                    "source_channel_id": 0,
                    "metric_value": 0,
                    "gmv": 0,
                    "uv": 0,
                    "gmv_per_uv": 0,
                    "gmv_ratio": 0,
                    "uv_ratio": 0,
                    "metric_value_ratio": 0,
                    "source_channel_name": "",
                    "pv": 0,
                    "pv_ratio": 0
                },
                "gmv": 0,
                "uv": 0,
                "gmv_per_uv": 0,
                "gmv_ratio": 0,
                "uv_ratio": 0,
                "source_channel_name": "",
                "pv_ratio": 0
            },
            "gmv": 0,
            "uv": 0,
            "gmv_per_uv": 0,
            "pv": 0,
            "pv_ratio": 0,
            "uv_ratio": 0
        }
    },
    "single_live_ec_spu_data_page_v2": {
        "spu_data_list": {
            "base_data.src_spu_id": "",
            "base_data.src": 0,
            "base_data.spu_name": "",
            "exp_uv": 0,
            "clk_uv": 0,
            "share_uv": 0,
            "clk_pv": 0,
            "exp_clk_ratio": 0,
            "clk_pay_ratio": 0,
            "gmv": 0,
            "pay_pv": 0,
            "refund_amount": 0,
            "refund_pv": 0
        },
        "total_cnt": 0
    },
    "Series": {
        "points": {
            "ts": 0,
            "value": 0
        },
        "dimensions": {
            "ux_label": ""
        },
        "step": 0,
        "begin_ts": 0,
        "end_ts": 0
    },
    "LiveComparisonIndex_OnAirIndexItem": {
        "n": 0,
        "last_n_mins_value": 0,
        "last_2n_to_n_mins_value": 0,
        "last_n_mins_percentile": 0,
        "value": 0,
        "percentile": 0
    },
    "LiveComparisonIndex_EndedIndexItem": {
        "value": 0,
        "percentile": 0,
        "median_7_days": 0
    },
    "LiveEcConversionMetric_ConversionMetric": {
        "update_time": 0,
        "shelftime": 0
    },
    "LiveEcConversionMetric_ItemConversionMetric": {
        "metric_value": 0,
        "median_to_recent_7_days": 0,
        "within_industry_percentage": 0,
        "quarterly_growth_rate.value": 0,
        "quarterly_growth_rate.is_valid": false
    },
    "LiveEcProfile_DataNodeThirdList": {
        "key": "",
        "row": {
            "key": "",
            "row": {
                "key": "",
                "row": {
                    "fields.dim_key": "",
                    "fields.dim_val": "",
                    "fields.dim_val_ratio": ""
                }
            }
        }
    }
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述
1	请求参数错误
48001	接口权限未开启，需前往视频号助手- 开放能力-开放场景打开开关

# 7. 适用范围

本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明，均不可调用。

# 获取直播大屏数据

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

# Res.live_dashboard_data Object Payload

# Res.live_comparison_index Object Payload

# Res.live_ec_data_summary Object Payload

# Res.live_ec_conversion_metric Object Payload

# Res.live_ec_profile Object Payload

# Res.live_distribution_channel Object Payload

# Res.single_live_ec_spu_data_page_v2 Object Payload

# Res.live_dashboard_data.LiveDashboardData2 Object Payload

# Res.live_dashboard_data.LiveDashboardData2.summary Object Payload

# Res.live_dashboard_data.LiveDashboardData2.source Object Payload

# Res.live_dashboard_data.LiveDashboardData2.portrait Object Payload

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats Object Payload

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats.dist_flow_type_stats Object Payload

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats.dist_flow_type_stats.j Object Payload

# Res.live_distribution_channel.live_dist_channel_source_by_scene_stats.dist_flow_type_stats.j.sub_channel_source_stats Object Payload

# Res.live_distribution_channel.live_dist_channel_source_stats Object Payload

# Res.live_distribution_channel.live_dist_channel_source_stats.j Object Payload

# Res.live_distribution_channel.live_dist_channel_source_stats.j.sub_channel_source_stats Object Payload

# Res.single_live_ec_spu_data_page_v2.spu_data_list Object Payload