开放API接口说明文档

本文档所描述的内容属于云图的高级使用功能，涉及较多技术细节，适用于对相关功能有经验的用户参考。如果对文档内容有疑惑，请您及时咨询李永均（621955）以便获取快速协助。

1. 概述

​ 此文档为云图对外的开放API接口说明文档，以下所有接口都需要通过mactoken的认证认证获取数据，请接入同学确认是否有该应用查询权限，没有权限，请及时联系应用管理员。

2. 环境

​ 注意：环境只支持HTTPS，请不要使用HTTP！

3. API接口

​ 以下接口都需要通过Mac Token进行获取数据，且获取数据的个人账号已经添加如云图的应用中，否则会显示“无访问权限”错误。

3.1 用户项目列表

• 请求方法：GET

• 请求地址：/v1.0/apps?app_name=99游&page=1&size=37

• 请求参数：

  • page 分页参数，页数
  • size 分页参数，每页数量，最大100条，最小1条
  • app_name：应用名称模糊搜索，可不选

• 返回参数：

  • 见示例说明

• 示例：

{
    "result":true,
    "total":37,
    "rows":[
        {
            "id":613,
            "app_id":"pc_im",
            "app_name":"99游 PC",
            "logo_image":"im",
            "real_name":"99游",
            "platform":"PC",
            "status":"03",
            "quota_type":"user",
            "creator_id":"768696",
            "creator_name":"杜建强",
            "create_time":"2016-08-11 11:27:02",
            "active_user_cnt":0,
            "new_user_cnt":0,
            "sur_user_cnt":1
        },
        {
            "id":613,
            "app_id":"pc_im",
            "app_name":"99游 PC",
            "logo_image":"im",
            "real_name":"99游",
            "platform":"PC",
            "status":"03",
            "quota_type":"user",
            "creator_id":"768696",
            "creator_name":"杜建强",
            "create_time":"2016-08-11 11:27:02",
            "active_user_cnt":0,
            "new_user_cnt":0,
            "sur_user_cnt":1
        }
    ]
}

3.2 T+1历史数据 - 基本统计数据接口

• 请求方法：GET

• 请求地址：/v1.0/apps/{app_key}/kpis/{kpi_type}/basic?date=

• 请求参数：

  • app_key：应用Appkey
  • kpi_type：user 或 device，默认为user

• 返回字段

  | 序号 | 字段 | 类型 | 说明 | | ----- | ------ | ------- | ------------------------ | | 1 | result | Boolean | | | 2 | obj | Object | | | 2.1 | code | String | 编码，见附录《code字段编码字典列表》 | | 2.2 | name | String | 中文说明 | | 2.3 | value | String | 数值 |

• 示例：

{
    "result":true,
    "obj":[
        {
            "code":"K0100006",
            "name":"累计设备",
            "value":"558"
        },
        {
            "code":"K0100010",
            "name":"过去7天活跃设备",
            "value":"190"
        },
        {
            "code":"K0100011",
            "name":"过去30天活跃设备",
            "value":"417"
        },
        {
            "code":"K0200011",
            "name":"过去7天平均日使用时长/设备",
            "value":"00:00:00"
        },
        {
            "code":"K0200010/K0200012",
            "name":"启动次数",
            "value":"12121"
        },
        {
            "code":"K0100022/K0100022",
            "name":"PV数",
            "value":"452"
        }
    ]
}

• 请求示例：GET
• 备注：此接口无权限

3.3 T+1历史数据 - 整体趋势数据接口

• 请求方法：GET

• 请求地址：/v1.0/apps/{app_key}/kpis/{kpi_code}/trend?start_date={start_date}&end_date={end_date}

• 请求参数：

  • app_key：应用的Key
  • kpi_code ：指标名称，K0100005为活跃设备，K0100002为活跃用户，K0100004为新增用户
  • start_date：开始时间，格式为：20181118
  • end_date：结束时间，格式为：20181119

• 返回参数：

• 返回内容

{
    "result":true,
    "obj":[
        {
            "kpi_code":"K0100005",
            "date":"2018-10-15",
            "value":"32",
        },
        {
            "kpi_code":"K0100005",
            "date":"2018-10-16",
            "value":"32",
        }
    ]
}

• ：此接口无权限

3.4 实时数据 - 查询应用基础数据

• 请求方法：GET

• 请求地址：http://{host}/v1.0/realtime/app_keys/online_user_count?appkeys=appkey1,appkey2

• 请求参数：

  • appkeys：应用的Key，支持多个key，最多4个AppKey

• 返回参数：

  • 见示例说明

• 示例：

  示例地址：https://bd-ca-open-dataservice.sdp.101.com/v1.0/realtime/app_keys/online_user_count?appkeys=265fe3d2904946c4979719ff00692368

{
  "total_user_count":1111,  // 活跃用户
  "total_visit_count":1111,  // 访问次数(UV)
  "total_ip_count":111，// IP数
  "total_pv_count":111, // 浏览量(PV)
  "appkeys":[{
    "appkey":"appkey1",
    "total_device_count":111, // 活跃设备数（今日累计） 20200304
    "total_user_count":111, // 活跃用户数（今日累计）
    "total_user_visit_count":212，// 访问次数（今日累计）
    "online_user_count":1111,// 在线用户数（前一个小时） 
    "user_visit_count":212，   // 用户访问数（前两个小时）
    "ip_count":111，// IP数
    "pv_count":111, // 浏览量(PV)
  }]
}

​ 注意：实时数据接口必须在应用已开通实时数据的情况下才能查看到数据。

附录

1. code字段编码字典列表