探马OpenAPI

获取渠道活码分析数据

POST

/api/v3/channelcode/analyse

信息

渠道活码累计数据

注意

接口限制频率 200次/分钟

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

channelcodes

array[number]

活码

必需

最多支持1000个

startTime

string

可选

开始时间，当天0点之后的数据 yyyy-MM-dd 最大支持查询一个月的数据

endTime

string

可选

结束时间，当天24点之前的数据 yyyy-MM-dd 最大支持查询一个月的数据

示例

{
    "channelcodes": [2436119,2436120,2436234]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v3/channelcode/analyse' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channelcodes": [2436119,2436120,2436234]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

channelcode

number

活码ID

必需

newContactCnt

number

累计新增好友数

必需

lostContactCnt

number

累计流失好友数

必需

retainCnt

number

累计留存好友数

必需

retainRate

number

总留存率

必需

保留4位，超出小数位截断

示例

成功示例异常示例

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "channelcode": 2436119,
            "newContactCnt": 2,
            "lostContactCnt": 1,
            "retainCnt": 1,
            "retainRate": 0.5000
        }
    ]
}

获取渠道活码列表

获取渠道活码分组-按部门查询