signature(签名)生成方法:
1. 所有请求参数(不包括signature), 加入平台密钥secret=xxx, 根据参数名称进行字典递增排序(按照第一个字符的键值ASCII码递增排序, 如果遇到相同字符则按照第二个字符的键值ASCII码递增排序, 以此类推)
2. 将排序后的参数与其对应值, 组合成"参数=参数值"的形式, 然后用'&'字符连接起来, 作为待签名字符串(待签名字符串中可能包含中文, 请使用utf-8编码)
3. 将待签名字符串使用SHA1算法处理, 结果作为signature(签名)的值
secret只在待签名字符串中使用。请求接口时,请勿带上secret参数
Version information
Version : 1.0.0
URI scheme
Host : dataapi.tuzhanai.com
BasePath : /opendata
Schemes : HTTPS
Produces
application/json
Paths
统计量(非实时): 浏览量(pv),访客量(uv),微信分享量,表单量
GET /opendata/basicinfo/{fields}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | fields required | pv: 浏览量 uv: 访客量 share: 微信分享量 form: 表单量 同时查询多项数据,使用英文逗号','分隔 | < enum (pv, uv, share, form) > array(csv) |
Query | opfid optional | 开放平台id | string |
Query | enterpriseid required | 企业id | string |
Query | appid required | 作品id | string |
Query | cnl optional | 渠道id | string |
Query | startTime optional | 起始时间,格式yyyy-MM-dd HH:mm:ss,例如2018-01-01 00:00:00 返回大于等于此时间的数据 | string |
Query | endTime optional | 终止时间,格式yyyy-MM-dd HH:mm:ss,例如2018-02-01 00:00:00 返回小于此时间的数据 | string |
Query | nonce required | 随机字符串,可取大小写字母和数字,至少6位 | string |
Query | timestamp required | unix时间戳(毫秒) | string |
Query | signature required | 签名字符串 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | 正常响应 | object |
Example HTTP request
Request path
/opendata/basicinfo/string?enterpriseid=string&appid=string&nonce=string×tamp=string&signature=string
Example HTTP response
Response 200
{
"status": 0, //status为200返回数据data,status为其他时返回错误消息errMsg
"data":
,
"errMsg": "string"
}
按时间分段统计量: 浏览量(pv),访客量(uv),微信分享量,表单量
GET /opendata/groupinfo/{fields}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | fields required | pv: 浏览量,groupby=dt且无cnl参数返回实时数据 uv: 访客量,无实时数据 share: 微信分享量,groupby=dt且无cnl参数返回实时数据 form: 表单量,无实时数据 同时查询多项数据,使用英文逗号','分隔 | < enum (pv, uv, share, form) > array(csv) |
Query | opfid optional | 开放平台id | string |
Query | enterpriseid required | 企业id | string |
Query | appid required | 作品id | string |
Query | cnl optional | 渠道id | string |
Query | startTime optional | 起始时间,格式yyyy-MM-dd HH:mm:ss,例如2018-01-01 00:00:00 返回大于等于此时间的数据 | string |
Query | endTime optional | 终止时间,格式yyyy-MM-dd HH:mm:ss,例如2018-02-01 00:00:00 返回小于此时间的数据 | string |
Query | groupby required | 聚合方式 dt: 日期 dt,hr: 日期和小时 | enum (dt, dt,hr) |
Query | nonce required | 随机字符串,可取大小写字母和数字,至少6位 | string |
Query | timestamp required | unix时间戳(毫秒) | string |
Query | signature required | 签名字符串 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | 正常响应 | object |
Example HTTP request
Request path
/opendata/groupinfo/string?enterpriseid=string&appid=string&groupby=string&nonce=string×tamp=string&signature=string
Example HTTP response
Response 200
{
"status": 0, //status为200返回数据data,status为其他时返回错误消息errMsg
"data": {
"pv": [
],
"uv": [
],
"share": [
],
"form": [
]
},
"errMsg": "string"
}
表单获取(实时)
GET /opendata/formInfos/fetch
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | opfid optional | 开放平台id | string |
Query | enterpriseid required | 企业id | string |
Query | appid required | 作品id | string |
Query | channelid optional | 渠道id | string |
Query | startTime optional | 起始时间,格式yyyy-MM-dd HH:mm:ss,例如2018-01-01 00:00:00 返回大于等于此时间的数据 | string |
Query | endTime optional | 终止时间,格式yyyy-MM-dd HH:mm:ss,例如2018-02-01 00:00:00 返回小于此时间的数据 | string |
Query | page required | 页码,从1开始 | integer |
Query | pageSize required | 每页条数,如果只关心返回的表单总条数(total)字段,可以传0 | integer |
Query | nonce required | 随机字符串,可取大小写字母和数字,至少6位 | string |
Query | timestamp required | unix时间戳(毫秒) | string |
Query | signature required | 签名字符串 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | 正常响应 | object |
Example HTTP request
Request path
/opendata/formInfos/fetch?enterpriseid=string&appid=string&page=0&pageSize=0&nonce=string×tamp=string&signature=string
Example HTTP response
Response 200
{
"status": 0, //status为200返回数据data,status为其他时返回错误消息errMsg
"data": {
"pageNum": 0, //页码
"pageSize": 0, //请求的每页条数
"startRow": 0, //数据开始行数
"endRow": 0, //数据结束行数
"total": 0, //数据总条数
"pages": 0, //数据总页数
"result": [
{
"channelid": "string",
"time": "string",
"form": {} //表单详情
}
]
},
"errMsg": "string"
}
按钮点击事件统计(非实时)
GET /opendata/pageInfo/curves/linkClickSum
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query | opfid optional | 开放平台id | string |
Query | enterpriseid required | 企业id | string |
Query | appid required | 作品id | string |
Query | channelid optional | 渠道id | string |
Query | startTime optional | 起始时间,格式yyyy-MM-dd HH:mm:ss,例如2018-01-01 00:00:00 返回大于等于此时间的数据 | string |
Query | endTime optional | 终止时间,格式yyyy-MM-dd HH:mm:ss,例如2018-02-01 00:00:00 返回小于此时间的数据 | string |
Query | nonce required | 随机字符串,可取大小写字母和数字,至少6位 | string |
Query | timestamp required | unix时间戳(毫秒) | string |
Query | signature required | 签名字符串 | string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 | 正常响应 | object |
Example HTTP request
Request path
/opendata/pageInfo/curves/linkClickSum?enterpriseid=string&appid=string&nonce=string×tamp=string&signature=string
Example HTTP response
Response 200
{
"status": 0, //status为200返回数据data,status为其他时返回错误消息errMsg
"data": {
"linkClickSum": [
]
},
"errMsg": "string"
}