# 获取电商概览数据

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

接口英文名:getfinderoverall

通过该接口可获取电商概览数据。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/compass/finder/overall/get

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:176

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

参数名类型必填示例说明
dsstring20240520日期,格式YYYYMMDD

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
errcodenumber0错误码
errmsgstringok错误信息
dataobjectdata

# Res.data Object Payload

data

参数名类型说明
pay_gmvnumber成交金额,单位分
live_pay_gmvnumber直播成交金额,单位分
feed_pay_gmvnumber短视频成交金额,单位分
window_pay_gmvnumber橱窗成交金额,单位分
product_pay_gmvnumber商品分享支付金额,单位分
other_pay_gmvnumber其他渠道成交金额,单位分

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "ds": "20240520"
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "pay_gmv": 0,
        "live_pay_gmv": 0,
        "feed_pay_gmv": 0,
        "window_pay_gmv": 0,
        "product_pay_gmv": 0,
        "other_pay_gmv": 0
    }
}

# 6. 错误码

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

错误码错误描述
48001接口权限未开启,需前往视频号助手- 开放能力-开放场景 打开开关
10021069请求参数日期格式有误

# 7. 适用范围

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