/basicOpen/multiplatform/ads/shopee/campaign/report/list{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/shopee/campaign/report/list"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/shopee/campaign/report/list?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"page\": {\n \"page\": 1,\n \"length\": 20,\n \"orderField\": \"cost\",\n \"orderType\": \"desc\"\n },\n \"period\": {\n \"startDate\": \"2026-03-01\",\n \"endDate\": \"2026-03-17\"\n },\n \"filter\": {\n \"shopIds\": [10001,10002],\n \"campaignIds\": [20001,20002],\n \"campaignName\": \"春季大促\",\n \"statusCodes\": [\"ongoing\",\"paused\"],\n \"placementCategories\": [\"search\",\"discovery\"],\n \"itemIds\": [30001,30002]\n }\n}'",
"responseExample": {
"code": 0,
"message": "success",
"error_details": [],
"request_id": "ccafcc7d9a72484fac5a3889b5db2986.231.17611516492143035",
"response_time": "2025-10-23 00:47:29",
"data": {
"total": 128,
"page": 1,
"length": 20,
"list": [
{
"dimension": "campaign-20001",
"itemIds": [
"30001",
"30002"
],
"currencyCode": "USD",
"campaignId": 20001,
"campaignName": "Shopee 春季大促",
"storeId": 10001,
"shopId": 900001,
"lxName": "Shopee-SG-001",
"statusCode": "ongoing",
"statusDisplayName": "进行中",
"startTime": "2026-03-01 00:00:00",
"endTime": "2026-03-31 23:59:59",
"targetType": "manual",
"targetTypeDisplayName": "手动",
"biddingType": "auto",
"biddingTypeDisplayName": "自动",
"placementCategory": "search",
"placementCategoryDisplayName": "搜索",
"campaignBudget": 1000.5,
"roasTarget": 2.5,
"dailyDiscoverStatus": "active",
"dailyDiscoverBid": 0.3,
"youMayAlsoLikeStatus": "inactive",
"youMayAlsoLikeBid": 0.25,
"impression": 15000,
"clicks": 850,
"cost": 320.5,
"directOrder": 35,
"broadOrder": 12,
"directItemSold": 42,
"broadItemSold": 16,
"directGmv": 980.6,
"broadGmv": 210.4,
"clickPercent": 12.36,
"ctr": 5.67,
"cpc": 0.38,
"directCvr": 4.12,
"broadCvr": 1.41,
"directCpa": 9.16,
"broadCpa": 26.71,
"directRoas": 3.06,
"broadRoas": 0.66,
"directAcos": 32.68,
"broadAcos": 152.33
}
]
}
}
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | page | 分页参数对象 | object | — | Required | 分页参数对象 |
| 1.1 | page | 当前页码 | number | — | Required | 当前页码,从 1 开始 |
| 1.2 | length | 每页大小 | number | — | Required | 每页大小 |
| 1.3 | orderField | 排序字段 | string | — | Required | 排序字段,按返回字段名称排序 |
| 1.4 | orderType | 排序类型 | string | — | Required | 排序类型: asc 升序 desc 降序 |
| 2 | period | 时间范围对象 | object | — | Required | 时间范围对象 |
| 2.1 | startDate | 开始日期 | string | — | Required | 开始日期,格式:yyyy-MM-dd |
| 2.2 | endDate | 结束日期 | string | — | Required | 结束日期,格式:yyyy-MM-dd |
| 3 | filter | 筛选条件对象 | object | — | Optional | 筛选条件对象 |
| 3.1 | shopIds | 店铺ID列表(复选 | array<any> | — | Optional | 店铺ID列表(复选,为空则代表全部) |
| 3.2 | campaignIds | 广告活动ID列表(复选 | array<any> | — | Optional | 广告活动ID列表(复选,为空则代表全部) |
| 3.3 | campaignName | 广告活动名称(模糊搜索) | string | — | Optional | 广告活动名称(模糊搜索) |
| 3.4 | statusCodes | 广告活动状态列表(复选 | array<any> | — | Optional | 广告活动状态列表(复选,为空时为全部): ongoing 进行中 scheduled 已计划 ended 已结束 paused 已暂停 deleted 已删除 closed 已关闭 |
| 3.5 | placementCategories | 广告位类别列表(复选 | array<any> | — | Optional | 广告位类别列表(复选,为空时为全部): search 搜索 discovery 展示 all 全部 |
| 3.6 | itemIds | 商品ID列表(复选 | array<any> | — | Optional | 商品ID列表(复选,为空则代表全部) |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 状态码 | number | 0 | Required | 状态码,0:成功 |
| 2 | message | 消息提示 | string | success | Required | 消息提示 |
| 3 | error_details | 数据校验失败时的错误详情 | array<any> | [] | Required | 数据校验失败时的错误详情 |
| 4 | request_id | 请求链路id | string | ccafcc7d9a72484fac5a3889b5db2986.231.17611516492143035 | Required | 请求链路id |
| 5 | response_time | 响应时间 | string | 2025-10-23 00:47:29 | Required | 响应时间 |
| 6 | data | 响应数据 | object | — | Required | 响应数据 |
| 6.1 | total | 总记录数 | number | 128 | Required | 总记录数 |
| 6.2 | page | 当前页码 | number | 1 | Required | 当前页码 |
| 6.3 | length | 每页大小 | number | 20 | Required | 每页大小 |
| 6.4 | list | 数据列表 | array<object> | — | Required | 数据列表 |
| 6.4.1 | dimension | 唯一标识 | string | campaign-20001 | Optional | 唯一标识 |
| 6.4.2 | itemIds | 商品ID列表 | array<any> | ["30001","30002"] | Required | 商品ID列表 |
| 6.4.3 | currencyCode | 币种代码 | string | USD | Optional | 币种代码 |
| 6.4.4 | campaignId | 广告活动ID | number | 20001 | Optional | 广告活动ID |
| 6.4.5 | campaignName | 广告活动名称 | string | Shopee 春季大促 | Optional | 广告活动名称 |
| 6.4.6 | storeId | 店铺ID | number | 10001 | Optional | 店铺ID |
| 6.4.7 | shopId | Shopee 店铺ID | number | 900001 | Optional | Shopee 店铺ID |
| 6.4.8 | lxName | 店铺展示名称 | string | Shopee-SG-001 | Optional | 店铺展示名称 |
| 6.4.9 | statusCode | 广告活动状态编码 | string | ongoing | Optional | 广告活动状态编码: ongoing 进行中 scheduled 已计划 ended 已结束 paused 已暂停 deleted 已删除 closed 已关闭 |
| 6.4.10 | statusDisplayName | 状态显示名称(国际化) | string | 进行中 | Optional | 状态显示名称(国际化) |
| 6.4.11 | startTime | 广告活动开始时间 | string | 2026-03-01 00:00:00 | Optional | 广告活动开始时间 |
| 6.4.12 | endTime | 广告活动结束时间 | string | 2026-03-31 23:59:59 | Optional | 广告活动结束时间 |
| 6.4.13 | targetType | 预算类型 | string | manual | Optional | 预算类型: auto 自动 manual 手动 |
| 6.4.14 | targetTypeDisplayName | 预算类型显示名称(国际化) | string | 手动 | Optional | 预算类型显示名称(国际化) |
| 6.4.15 | biddingType | 竞价类型 | string | auto | Optional | 竞价类型: auto 自动 manual 手动 |
| 6.4.16 | biddingTypeDisplayName | 竞价类型显示名称(国际化) | string | 自动 | Optional | 竞价类型显示名称(国际化) |
| 6.4.17 | placementCategory | 广告位类别 | string | search | Optional | 广告位类别: search 搜索 discovery 展示 all 全部 |
| 6.4.18 | placementCategoryDisplayName | 广告位类别显示名称(国际化) | string | 搜索 | Optional | 广告位类别显示名称(国际化) |
| 6.4.19 | campaignBudget | 广告活动预算 | number | 1000.5 | Optional | 广告活动预算 |
| 6.4.20 | roasTarget | 目标ROAS | number | 2.5 | Optional | 目标ROAS |
| 6.4.21 | dailyDiscoverStatus | 每日发现广告位状态 | string | active | Optional | 每日发现广告位状态: active 启用 inactive 停用 |
| 6.4.22 | dailyDiscoverBid | 每日发现广告位竞价 | number | 0.3 | Optional | 每日发现广告位竞价 |
| 6.4.23 | youMayAlsoLikeStatus | 猜你喜欢广告位状态 | string | inactive | Optional | 猜你喜欢广告位状态: active 启用 inactive 停用 |
| 6.4.24 | youMayAlsoLikeBid | 猜你喜欢广告位竞价 | number | 0.25 | Optional | 猜你喜欢广告位竞价 |
| 6.4.25 | impression | 曝光量 | number | 15000 | Optional | 曝光量 |
| 6.4.26 | clicks | 点击量 | number | 850 | Optional | 点击量 |
| 6.4.27 | cost | 广告花费 | number | 320.5 | Optional | 广告花费 |
| 6.4.28 | directOrder | 广告订单(直接订单) | number | 35 | Optional | 广告订单(直接订单) |
| 6.4.29 | broadOrder | 间接订单 | number | 12 | Optional | 间接订单 |
| 6.4.30 | directItemSold | 广告销量(直接售出商品数) | number | 42 | Optional | 广告销量(直接售出商品数) |
| 6.4.31 | broadItemSold | 间接销量(间接售出商品数) | number | 16 | Optional | 间接销量(间接售出商品数) |
| 6.4.32 | directGmv | 广告GMV(直接GMV) | number | 980.6 | Optional | 广告GMV(直接GMV) |
| 6.4.33 | broadGmv | 间接GMV | number | 210.4 | Optional | 间接GMV |
| 6.4.34 | clickPercent | 点击百分比(点击量占查询结果总点击量的百分比) | number | 12.36 | Optional | 点击百分比(点击量占查询结果总点击量的百分比) |
| 6.4.35 | ctr | ctr | number | 5.67 | Optional | CTR - 点击率(点击量/曝光量 * 100%) |
| 6.4.36 | cpc | CPC - 每次点击成本(广告花费/点击量) | number | 0.38 | Optional | CPC - 每次点击成本(广告花费/点击量) |
| 6.4.37 | directCvr | directCvr | number | 4.12 | Optional | CVR - 转化率(广告订单/点击量 * 100%) |
| 6.4.38 | broadCvr | broadCvr | number | 1.41 | Optional | 间接CVR - 间接转化率(间接订单/点击量 * 100%) |
| 6.4.39 | directCpa | CPA - 每笔订单花费(广告花费/广告订单) | number | 9.16 | Optional | CPA - 每笔订单花费(广告花费/广告订单) |
| 6.4.40 | broadCpa | broadCpa | number | 26.71 | Optional | 间接CPA - 每笔间接订单花费(广告花费/间接订单) |
| 6.4.41 | directRoas | directRoas | number | 3.06 | Optional | 广告ROAS - 广告支出回报率(广告GMV/广告花费) |
| 6.4.42 | broadRoas | broadRoas | number | 0.66 | Optional | 间接ROAS - 间接广告支出回报率(间接GMV/广告花费) |
| 6.4.43 | directAcos | directAcos | number | 32.68 | Optional | 广告ACoS - 广告销售成本(广告花费/广告GMV * 100%) |
| 6.4.44 | broadAcos | broadAcos | number | 152.33 | Optional | 间接ACoS - 间接广告销售成本(广告花费/间接GMV * 100%) |
The 分页查询广告活动报告列表 API (/basicOpen/multiplatform/ads/shopee/campaign/report/list) of 领星ERP is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 领星ERP version updates.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.