/js/highslide/graphics/
API列表>指标通用说明

API在调用过程中,涉及到几个关键的通用概念:鉴权签名、错误码返回、接口id;如下将分别详细说明下:

通用配置

接口域名 data.xfyun.cn

协议 Http

请求方式 GET

数据协议 Json

访问频次限制 暂无

鉴权签名

以接口21001,PHP语言为例

1.定义参数和secret_key的值

$param['secret_key'] = 'secret_key';
$param['app_id'] = base64_encode('app_id');
$param['api_id'] = '21001';
$param['start_date'] = "2016-4-5";
$param['end_date'] = "2016-5-4";
$param['channel'] = 'QQ阅读';
$param['version'] = '2.0.1087';
$param['stamp'] = time();

2.将以上参数按字典顺序排序

ksort($param);

3.将排序后的参数值合并成为一个字符串

implode($param) 得到: 21001YXBwX2lkQQ阅读2016-5-4secret_key14627679502016-4-52.0.1087

4.计算字符串的 sha1 散列值

$sign = sha1(implode($param));

统一返回码说明

提供统一返回码字典,接口返回信息参照这里翻译

7001     提交的get数据为空
7002     必须参数不完整
7003     时间格式不正确
7004     时间区间不正确
7005     请求的api_id不存在
7006     应用不存在或未开通统计服务
7007     数字签名验证失败
7008     应用数据为空
7009     url时间戳失效
7000     返回成功
7500     服务器内部错误
7201     参数datetype值不存在
7200     请求自定义事件id不存在
                                                

返回值举例:

{
  "state": "success",
  "code": "7000",
  "data": {
    "2016-04-18": {
      "new_user": 1000
    },
    "2016-04-19": {
      "new_user": 1000
    }
  }
}
                                            

统一指标说明

获取关键数据接口:

接口ID 接口名称(英文) 接口名称(中文)
21001 getNewUser 获取新增用户
21002 getActiveUser 获取活跃用户
21003 getSumUser 获取累计用户
21004 getUseTimes 获取启动次数
21005 getEachDur 获取次均时长
21006 getManDur 获取人均时长
21007 getAllBasicData 获取全部关键数据

获取终端属性数据接口

接口ID 接口名称(英文) 接口名称(中文)
31001 getChinaSpread 中国分布
31002 getWorldSpread 海外分布
31003 getDeviceSpread 机型分布
31004 getOsSpread 操作系统分布
31005 getDpiSpread 分辨率分布
31006 getOperatorSpread 运行商分布
31007 getNetSpread 联网方式分布

获取行为分析数据接口

接口ID 接口名称(英文) 接口名称(中文)
41001 getDurByUseTimes 按使用次数分布的使用时长
41002 getDurByActiveUser 按活跃用户分布的使用时长
41003 getUseFrequency 使用频率分布
41004 getUseInterval 使用间隔分布
41005 getAccessDepth 访问深度分布
41006 getAccessPages 访问页面分布
41007 getLifePeriod 生命周期分布

获取自定义事件信息

接口ID 接口名称(英文) 接口名称(中文)
51001 getEventList 获取事件列表
51002 getEventDetail 获取事件详细信息

/

SDK下载

您还没有应用,创建应用后方可进行下载
选择已有应用绑定下载