# 获取带货数据概览
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getshopfinderoverall
通过该接口可获取带货数据概览。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/compass/shop/finder/overall/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：175
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ds | string | 是 | 日期，格式YYYYMMDD |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 0 | 错误码 |
| errmsg | string | ok | 错误信息 |
| data | object | 带货数据 |
# Res.data Object Payload
带货数据
| 参数名 | 类型 | 说明 |
|---|---|---|
| pay_gmv | number | 成交金额，单位分 |
| pay_sales_finder_cnt | number | 动销达人数 |
| pay_product_id_cnt | number | 动销商品数 |
| click_to_pay_uv_ratio | number | 点击-成交转化率 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"ds": "20240520"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"pay_gmv": "0",
"pay_sales_finder_cnt": "0",
"pay_product_id_cnt": "0",
"click_to_pay_uv_ratio": 0.0
}
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10021069 | 请求参数日期格式有误 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。