API调用

调用格式

• API基本信息
  • API返回格式：Json格式；
  • API请求方式：Post请求；
• API入参

参数名称	数据类型	必填	说明
dateTime	String	否	业务日期。指定业务日期时，返回指定业务日期对应的数据；未指定业务日期时，返回同步的最新业务日期对应的数据
pageNo	int	否	页码。未指定时，默认为1
pageSize	Long	否	每页条数。未指定时，默认为1000
rowKeyStart	String	否	起始行。未指定时，默认为null

• API出参

参数名称	数据类型	说明
code	Long	状态返回码
messaage	String	返回信息，错误信息将包含在里面
data	Object	返回数据

• API请求示例
  • Requst URL:http(s)://调用URL
  • Headers: API-TOKEN: {API-TOKEN}
  • Body:

{
    "dateTime": [
        {
            "hbase": "20211230"
        }
    ],
    "rowKeyStart": "",
    "pageNo": 1,
    "pageSize": ""
}
JSONCopied!

tip

• V4.3.2：调整了API的调用方式，新增dateTime参数，表示调用哪个业务日期的数据，日期格式为yyyyMMdd。调用标签API、实时/动态群组API时为必填参数。
• V5.2：调用标签API、实时/动态群组API时dateTime为选填参数。

调用示例

利用Postman进行数据测试，如下：

步骤一： 进入“群组分析-我的API”查看被授权的API，进入API详情页，找到调用URL和API-TOKEN；

步骤二： 进入Postman，选择请求方式，输入调用url、API-token及body信息，并选择调用格式；

步骤三： 点击测试，返回测试结果；