菜单

渠道管理API

获取渠道链接查询列表

API 服务地址及请求地址

  • /api/v3/analytics/v1/channel/links/list
  • POST

请求参数说明

参数名

含义

规则说明

数据类型

是否必须

缺省值

page_num 分页页码 分页页码,0 代表第一页 Integer 可选 0
page_size 每页条数 每页条数,单页最大 1000 条 Integer 可选 20
sort_type 排序类型

支持按照创建时间、更新时间进行升降排序

1 :按照创建时间升序排序

-1:按照创建时间降序排序

2:按照更新时间升序排序

-2:按照更新时间降序排序

Integer 可选

1

默认 按照创建时间升序排序

campaign_filters 活动名称筛选 按照活动名称筛选 Array<String> 可选
device_type_filters 设备类型筛选 按照设备类型筛选,支持的枚举值【通用、iOS、Android】 Array<String> 可选
channel_type_filters 渠道类型筛选

按照渠道类型筛选,支持的枚举值【app_normal、app_deeplink、web_normal、mina_normal、alipay_mini_track】

枚举值对应关系:

app_normal:APP 通用渠道

app_deeplink:APP 通用渠道(包含 Deeplink 能力)

web_normal:网页通用渠道

mina_normal:微信小程序通用渠道

alipay_mini_track:支付宝小程序通用渠道

     
global_filters 全局筛选 全局筛选,按照渠道链接名称、渠道推广链接、渠道链接 id 进行筛选 Array<String> 可选
channel_application_name_filters deeplink 应用的应用名称筛选 根据应用名称筛选,可以筛选出对用的 APP 通用渠道(包含 Deeplink 能力)渠道链接 Array<String> 可选

完整请求参数示例

请求参数

{
    "page_num": 0,
    "page_size": 50,
    "sort_type": "-1",
    "campaign_filters": [
        "test%%+++活动"
    ],
    "device_type_filters": [
        "通用",
        "iOS",
        "Android"
    ],
    "channel_type_filters": [
        "app_normal",
        "app_deeplink",
        "web_normal",
        "mina_normal",
        "alipay_mini_track"
    ],
    "global_filters": [
        "全局筛选"
    ],
    "channel_application_name_filters": [
        "测试应用"
    ]
}
 

 

接口响应参数说明

参数名

含义

规则说明

数据类型 是否必须
code

当前查询是否成功标识

查询成功:SUCCESS,其他情况为查询失败

String
request_id 本次查询的trace ID 方便后续的问题跟踪 String
data 本次查询的具体数据   JSON
----> total_rows 总条数 返回渠道链接数据总条数

long

----> total_page 总页数 返回渠道链接数据总页数 Integer
----> page_num 当前分页页码 当前分页页码,0 代表第一页 Integer
----> page_size 每页条数 每页条数 Integer
----> detail_results 渠道链接列表明细结果 返回渠道链接明细结果列表 Json
----> ----> id 渠道链接主键 id 渠道链接主键 id Integer
----> ----> name 渠道链接名称 渠道链接名称 String
----> ----> channel_type 渠道类型 渠道类型 String
----> ----> device_type 设备类型 设备类型,枚举值(通用、iOS、Android) String
----> ----> short_url 短链地址 短链地址 String
----> ----> app_address APP 链接地址 APP 链接地址 String
----> ----> parameters 自定义渠道信息 自定义渠道信息 Map<String,String>
----> ---->
project_id
项目 Id 项目 Id,对应项目 Id Integer
----> ---->
create_time
渠道链接创建时间 渠道链接创建时间 String
----> ---->
update_time
渠道链接更新时间 渠道链接更新时间 String
----> ----> short_url_id 短链 Id 短链 Id Integer
----> ----> channel_track_key 渠道唯一标识 Key 渠道唯一标识 Key String
----> ----> is_show_whole_url 是否展示 whole_url 是否展示 whole_url Integer
----> ----> whole_url 完整 url 链接地址 完整 url 链接地址 String
----> ----> web_landing_page 网页落地页 网页落地页,如果唤醒 App 失败,需要进入哪个网页,需要以 http:// 或者 https:// 为开头 String
----> ----> application_name 渠道应用名称 渠道应用名称 String
----> ----> application_info_id 渠道应用信息 id 渠道应用信息 id String

完整的响应报文示例

响应报文

{
    "code":"SUCCESS",
    "request_id":"09511615f0f14802af19fada2c95ba37",
    "data":{
        "total_rows":"5",
        "total_page":5,
        "page_num":0,
        "detail_results":[
            {
                "id":1,
                "name":"APP 通用渠道_测试活动_20230203_4996",
                "channel_type":"app_normal",
                "device_type":"通用",
                "short_url":"http://{hostname}:{port}/r/U",
                "app_address":"http://{hostname}:{post}/sa/channel_sa/link_manage?project=default&utm_source=%E6%B5%8B%E8%AF%95%E6%9D%A5%E6%BA%90&utm_campaign=%E6%B5%8B%E8%AF%95%E7%9A%84%E6%B4%BB%E5%8A%A8%25%25&test=%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7&_channel_track_key=U9itljXH",
                "parameters":{
                    "utm_campaign":"测试活动"
                },
                "project_id":1,
                "create_time":"2023-02-03 16:19:57",
                "update_time":"2023-02-03 16:19:57",
                "short_url_id":0,
                "channel_track_key":"U9itljXH",
                "is_show_whole_url":1
            },
            {
                "id":2,
                "name":"App Deeplink 通用渠道_测试应用_20230112_5511",
                "channel_type":"app_deeplink",
                "device_type":"通用",
                "short_url":"https://{hostname}:{port}/sd/xfA/A/W1uy30",
                "app_address":"",
                "parameters":{
                    "utm_campaign":"测试活动"
                },
                "project_id":1,
                "create_time":"2023-01-12 18:11:40",
                "update_time":"2023-01-12 18:11:40",
                "short_url_id":0,
                "channel_track_key":"9jTlm9Gh",
                "is_show_whole_url":1,
                "web_landing_page":"http://www.test.com",
                "application_name":"测试应用"
            },
            {
                "id":3,
                "name":"网页通用渠道_测试的活动%%_20230203_4983",
                "channel_type":"web_normal",
                "device_type":"通用",
                "short_url":"http://{hostname}:{port}/t/E",
                "app_address":"",
                "parameters":{
                    "utm_campaign":"测试活动"
                },
                "project_id":1,
                "create_time":"2023-02-03 17:04:09",
                "update_time":"2023-02-03 17:04:09",
                "short_url_id":0,
                "channel_track_key":"BlCeGScT",
                "is_show_whole_url":1,
                "whole_url":"http://www.test.com?utm_campaign=%E6%B5%8B%E8%AF%95%E7%9A%84%E6%B4%BB%E5%8A%A8%25%25&_channel_track_key=BlCeGScT"
            },
            {
                "id":4,
                "name":"微信小程序通用渠道_测试活动_20230209_2179",
                "channel_type":"mina_normal",
                "device_type":"通用",
                "parameters":{
                    "utm_campaign":"测试活动"
                },
                "project_id":1,
                "create_time":"2023-02-09 15:44:08",
                "update_time":"2023-02-09 15:44:08",
                "short_url_id":0,
                "channel_track_key":"FlnXUZQe",
                "is_show_whole_url":1,
                "whole_url":"pages/details/index?id=2323323&sa_utm=j"
            },
            {
                "id":5,
                "name":"支付宝小程序通用渠道_测试活动_20230203_3007",
                "channel_type":"alipay_mini_track",
                "device_type":"通用",
                "app_address":"",
                "parameters":{
                    "utm_campaign":"测试活动"
                },
                "project_id":1,
                "create_time":"2023-02-03 17:05:09",
                "update_time":"2023-02-03 17:05:09",
                "short_url_id":0,
                "channel_track_key":"l7dkBwWi",
                "is_show_whole_url":1,
                "whole_url":"https://ds.alipay.com/?scheme=alipays%3A%2F%2Fplatformapi%2Fstartapp%3FappId%3D907%26page%3Dpage%2Fcommon%2Fsrch%2Fsech%26qry%3Dsa_utm%253Ds"
            }
        ],
        "page_size":1
    }
}
 

渠道链接 - 新建渠道链接

API 服务地址及请求方式

  • /api/v3/analytics/v1/channel/links/create
  • POST

请求参数说明

参数名 含义 规则说明 数据类型 是否必须 缺省值
channel_urls
批量创建渠道链接列表 同一批次渠道类型要相同,批量创建链接最多创建 800 个 Array<Json>
---->
channel_type
渠道类型 app_normal:APP 通用渠道;app_deeplink:APP 通用渠道(包含 Deeplink 能力);web_normal:网页通用渠道;mina_normal:微信小程序通用渠道;alipay_mini_track:支付宝小程序通用渠道 String
---->
device_type
设备类型 枚举值类型,支持【通用、iOS、Android】 String 通用
---->
target_url
目标地址 网址必须以 http:// 或 https:// 开头 String
---->
app_address
推广页面地址 比如 Android 或 iOS 的下载地址、应用宝微下载地址、中间跳转URL,这网址必须以 http:// 或 https:// 开头 String
---->
parameters
自定义渠道属性   Map<String,String>
---->
app_inner_info
应用内参数 APP 通用渠道 可以使用这个参数跳转至指定页面,或者展示相应的弹框等,需要和贵方客户端研发约定好 String
---->
web_landing_page
网页落地页 网页落地页,需要以 http:// 或 https:// 开头 String
---->
application_name
Deeplink 应用创建的应用名称 APP 通用渠道(包含 Deeplink 能力),需要先在页面上创建 Deeplink 应用 String APP 通用渠道(包含 Deeplink 能力)必传
---->
custom_properties
自定义参数 开启强校验后,自定义属性字段,需要创建 Array<Json> 否,强校验时必填
----> ----> name 自定义属性英文名 自定义属性英文名,强校验时必传 String
----> ----> cname 自定义属性中文名 自定义属性中文名,强校验时必传 Sting
---->
app_id
小程序 appId 微信小程序永久有效链接(LINK_LONG)、常规码(GENERAL)、超长码(EFFICIENCY),支付宝小程序必填字段 String
---->
app_secret
小程序 secret 微信小程序永久有效链接(LINK_LONG)、常规码(GENERAL)、超长码(EFFICIENCY),必填字段 String
---->
mina_type
投放物料类型 微信小程序通用渠道【页面路径(NONE)、永久有效链接(LINK_LONG)、常规码(GENERAL)、超长码(EFFICIENCY)】;支付宝小程序通用渠道【全局参数(ALIPAY_SCHEME)、页面参数(ALIPAY_PAGE)】 String

完整请求参数示例:

请求参数

{
    "channel_urls":[
        {
            "channel_type":"app_normal",
            "app_address":"http://{hostname}:{post}/sa/channel_sa/link_manage?project=default",
            "parameters":{
                "utm_source":"广告来源",
                "utm_medium":"广告媒介",
                "utm_term":"关键词",
                "utm_content":"广告内容",
                "utm_campaign":"活动"
            },
            "custom_properties":[
 
            ],
            "device_type":"通用"
        },
        {
            "channel_type":"app_deeplink",
            "parameters":{
                "utm_source":"广告来源",
                "utm_medium":"广告媒介",
                "utm_term":"关键词",
                "utm_content":"广告内容",
                "utm_campaign":"活动"
            },
            "custom_properties":[
 
            ],
            "application_name":"测试应用",
            "web_landing_page":"http://www.test.com",
            "app_inner_info":"t=test",
            "device_type":"通用"
        },
        {
            "channel_type":"web_normal",
            "target_url":"http://www.test.com",
            "parameters":{
                "utm_source":"广告来源",
                "utm_medium":"广告媒介",
                "utm_term":"关键词",
                "utm_content":"广告内容",
                "utm_campaign":"活动"
            },
            "custom_properties":[
 
            ],
            "device_type":"通用"
        },
        {
            "channel_type":"mina_normal",
            "target_url":"pages/index?id=asdfas",
            "mina_type":"EFFICIENCY",
            "app_id":"wx123423423",
            "app_secret":"123asdfasdfq12342314",
            "parameters":{
                "utm_source":"广告来源",
                "utm_medium":"广告媒介",
                "utm_term":"关键词",
                "utm_content":"广告内容",
                "utm_campaign":"活动"
            },
            "custom_properties":[
 
            ],
            "device_type":"通用"
        },
        {
            "channel_type":"alipay_mini_track",
            "mina_type":"ALIPAY_PAGE",
            "target_url":"page/common/search/search",
            "app_id":"23234211234",
            "parameters":{
                "utm_source":"广告来源",
                "utm_medium":"广告媒介",
                "utm_term":"关键词",
                "utm_content":"广告内容",
                "utm_campaign":"活动"
            },
            "custom_properties":[
 
            ],
            "device_type":"通用"
        }
    ]
}
 

接口响应参数说明:

参数名 含义 规则说明 数据类型 是否必填
status
创建状态 渠道链接创建状态 String
created
总条数  包含:成功 + 失败 + 重复 Integer
duplicated
重复条数
重复条数 Integer
failed
失败条数 创建失败条数 Integer
image_base64
图片 base64 编码 批量创建微信小程序通用渠道,返回第一个图片 base64 编码 String
error
报错信息 单条创建报错信息 Json
---->
error_code
报错码 微信小程序渠道创建,微信返回错误码 String
---->
error_msg
报错描述 微信小程序渠道创建,微信返回错误描述 String
channel_urls
渠道链接创建结果列表   Arrays<Json>
---->
id
渠道链接主键 Id 数据自增主键 id Integer
---->
name
渠道链接名称 渠道链接生成名称 String
---->
app_address
推广页面地址 推广页面地址 String
---->
short_url
短链地址 短链地址 String
---->
whole_url
完整链接地址 完整链接地址 String
---->
is_duplicate
是否重复创建 根据 target_url 、渠道参数信息、所属项目名称,判断是否是相同的短链

Boolean

---->
error_msg
错误信息 创建失败的报错信息 String
---->
resource_base64
base 64 图片编码 微信小程序常规码和超长码生成图片的 base 64 编码 String
---->
application_name
应用名称 Deeplink 应用创建的应用 String
---->
web_landing_page
网页落地页 需要以 http:// 或 https:// 开头 String

完整的响应报文示例:

响应报文

{
    "duplicated":0,
    "image_base64":"",
    "created":1,
    "channel_urls":[
        {
            "id":872,
            "name":"APP 通用渠道_活动_20230213_6758",
            "app_address":"推广页面地址",
            "short_url":"短链地址",
            "whole_url":"",
            "is_duplicate":false,
            "error_msg":"",
            "resource_base64":"",
            "application_name":"",
            "web_landing_page":""
        }
    ],
    "failed":0,
    "status":"success"
}
 

渠道链接 - 更新渠道链接

API 服务地址及请求方式

  • /api/v3/analytics/v1/channel/links/update
  • POST

请求参数说明:

 

参数名 含义 规则说明 数据类型 是否必须 缺省值
channel_urls 批量修改链接列表内容 批量修改渠道链接列表,批量创建链接最多创建 800 个 Array<Json>
----> id 修改渠道的主键 Id 可以通过获取渠道链接列表,获取对应渠道的主键 Id Integer
----> name 修改渠道名称 修改后的渠道名称 Integer

 

完整请求参数示例:

请求参数

{
    "channel_urls":[
        {
            "name":"支付宝小程序通用渠道_测试的活批量",
            "id":26
        }
    ]
}
 

接口响应参数说明:

参数名 含义 规则说明 数据类型 是否必填
update_data_results
修改渠道链接信息返回结果 修改渠道链接信息返回结果 Array<Json>
----> id 主键 Id 修改渠道信息主键 Id Integer
----> name 修改后渠道名称 修改后渠道名称 String
----> before_name 修改前渠道名称 修改前渠道名称 String
----> fail_info 修改渠道报错信息 修改渠道信息的报错信息 String

完整的响应报文示例;

响应报文

{
    "code":"SUCCESS",
    "request_id":"762953fb704740e7a431883cde8b7b03",
    "data":{
        "update_data_results":[
            {
                "id":1,
                "name":"支付宝小程序通用渠道_测试1",
                "before_name":"支付宝小程序通用渠道_测试2",
                "fail_info":""
            }
        ]
    }
}
 

道链接 - 删除渠道链接

API 服务地址及请求方式

  • /api/v3/analytics/v1/channel/links/delete
  • POST

请求参数说明

参数名

含义

规则说明

数据类型

是否必须

缺省值

channel_link_ids
渠道链接 Id 列表 删除的渠道链接 Id 列表 Arrays<Integer>

完整请求参数示例:

请求参数

{
    "channel_link_ids":[
        1,
        2,
        3
    ]
}
 

接口响应参数说明:

参数名

含义

规则说明

数据类型

是否必填

success_channel_link_ids
删除成功的渠道链接 Id 列表 返回删除成功的渠道链接 Id 列表 Arrays<Integer>

完整的响应报文示例:

响应报文

{
    "code":"SUCCESS",
    "request_id":"8da3351a85664dadb686bbaad8b8b2f9",
    "data":{
        "success_channel_link_ids":[
            1,
            3
        ]
    }
}
 

活动管理 - 获取活动列表

API 服务地址及请求方式

  • /api/v3/analytics/v1/channel/campaigns/list
  • POST

请求参数说明:

参数名 含义 规则说明 数据类型 是否必须 缺省值
page_num
分页页码 分页页码,0 代表第一页 Integer 0
page_size
每页条数 每页条数,单页最大 1000条 Integer 20
sort_info
排序信息 排序信息 Json  
---->
sort_field
排序字段 排序字段,支持链接数量(branch_num)、最后创建时间(latest_use_time)字段排序 String 默认最后创建时间(latest_use_time)字段排序,降序排序
---->
sort_strategy
排序策略 排序策略,DESC 降序、ASC String

完整请求参数示例:

请求参数

{
    "page_num":0,
    "page_size":20,
    "sort_info":{
        "sort_field":"latest_use_time",
        "sort_strategy":"DESC"
    }
}
 

接口响应参数说明:

参数名 含义 规则说明 数据类型 是否必填
total_rows
总条数 返回活动总条数 Long
total_page
总页数 返回活动总分页数 Integer
page_num
分页页码 分页页码,0 代表第一页 Integer
page_size 每页条数 每页条数,单页最大 1000条 Integer
campaign_details
活动明细列表 返回活动明细列表 Array<Json>
---->
campaign_name
活动名称 活动名称 String
---->
branch_num
链接数量 统计活动下创建的渠道链接数 Integer
---->
latest_use_time
最后创建时间 活动聚合,最后一个渠道的创建时间 String

完整的响应报文示例:

响应报文

{
    "code":"SUCCESS",
    "request_id":"270fcef9da8f4e0ea9cc87fdf3ac9849",
    "data":{
        "campaign_details":[
            {
                "campaign_name":"测试的活动",
                "branch_num":1,
                "latest_use_time":"2023-02-09 19:19:50"
            }
        ],
        "total_rows":"6",
        "total_page":1,
        "page_num":0,
        "page_size":10
    }
}
 

 

上一个
概览管理 API
下一个
数据接入 API
最近修改: 2025-03-19