查询券模板发放统计数据

更新时间 2024-07-24 02:58:49

我的收藏

该接口用于查询券模板下主播/接口发券活动的数据表现情况。

使用限制

无。

接口说明

使用该接口查询券模板整体的发放数据统计，可以通过指定主播信息或接口发券活动的信息查询特定活动主体的发放数据。

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/promotion/v1/coupon/get_coupon_meta_statistics
HTTP Method	POST
Scope	promotion.coupon.admin
权限要求	需要申请权限。路径： •小程序：抖音开放平台控制台 > 应用详情 > 能力 > 能力实验室 > 小程序券

请求头

参数	描述
content-type	`application/json`
access-token	调用`/oauth/client_token/`生成的 token，此 token 不需要用户授权。示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******

请求参数

Body

名称	类型	是否必填	描述	示例值
coupon_meta_id	string	是	已创建的抖音开平券模板id	721807xxxxxx5644204
app_id	string	是	小程序appid	ttec789ac573xxxxxx01
activity_id	string	否	开平接口发券活动ID	702345xxxxxxx
talent_account	string	否	主播抖音号	7932234
talent_open_id	string	否	主播open_id（主播在开发者小程序内的open_id）， talent_open_id、talent_account 两个字段只需填写一个，若全部填写以talent_account为准。	Cv4PoJXaTPn63rNu

请求示例

js复制
curl --location 'https://open.douyin.com/api/promotion/v1/coupon/get_coupon_meta_statistics' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data '{
    "app_id":"ttcfdbb96650e33350",
    "coupon_meta_id":"7241832741367447613"
}'

响应参数

名称				类型	是否必填	描述	示例值
err_no				int32	是	0表示成功	0
err_msg				string	是	err_no非0时对应的错误信息文案提示，成功时为空字符串	“”
log_id				string	是	标识请求的唯一id	202008121419360101980821035705926A
data				object	是
	talent_stats			array	否
		-		object	是
			talent_account	string	是	主播抖音号	7932234
			talent_open_id	string	是	主播open_id（主播在开发者小程序内的open_id）	Cv4PoJXaTPn63rNu
			exposed_num	int64	是	主播发券期间对应券模板的曝光数	1234
			received_num	int64	是	主播发券期间对应券模板的领取数	449
			consumed_num	int64	是	通过主播领取对应券模板的核销数量	322
	activity_stats			array	否
		-		object	是
			activity_id	string	是	接口发券活动id	702345xxxxxxx
			received_num	int64	是	接口发券对应券模板的领取数	3042
			consumed_num	int64	是	通过接口发券获得对应券模板的核销数量	2435

响应示例

正常示例

json复制
{
  "err_no": 0,
  "err_msg": "",
  "log_id": "202306081640346D6CE7AD7121F504D69E",
  "data": {
      "activity_stats": [
        {
          "activity_id": "7242154741227077690",
          "consumed_num": 0,
          "received_num": 1
        }
      ],
      "talent_stats": [
        {
          "talent_account": "7932234",
          "talent_open_id": "Cv4PoJXaTPn63rNu",
          "exposed_num": 1234,
          "received_num": 812,
          "consumed_num": 764
        }
      ]
  }
}

异常示例

json复制
{
  "err_no": 29005026,
  "err_msg": "无效券活动",
  "log_id": "20230602111931B8431F7C63978600E24C",
  "data": {}
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	0	success	接口请求成功，无需排查
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001007	参数不合法	根据报错内容排查请求参数是否填写正常