用量统计 OpenAPI（SaaS）

本文档提供应用或集团级别，天粒度或月粒度的事件量、DAU、MAU的用量统计。

Context-path: /datafinder
Body:

{
    "org_id": null,
    "app_ids": [164314],
    "start_time": 1643644800, # 2022年2月1日
    "end_time": 1645977600 # 2022年2月28日
}

支持直接对集团级别生效，比如获取org_id=66的集团级别的用量统计：

{
    "org_id": 66,
    "app_ids": [],
    "start_time": 1643644800, # 2022年2月1日
    "end_time": 1645977600 # 2022年2月28日
}

Response:

{
        "code": 200,
        "data": xxx,
        "message": "success"
}

• code 状态码，200 表示成功，其他非失败

• message 成功或失败信息

• data 结果数据，具体结构参考具体的 API 描述

3.1 API 定义

Path：/openapi/v1/usage_amount
Method: POST
Content-type: application/json
Body: 参考公共参数说明

Response:

{
    "code": 200,
    "message": "success",
    "data": {
        "usage_amount": {
            "${app_id}": {
                "month_usage_amount": {
                    "{month}": {
                        "days": xx,
                        "mau": xx,
                        "dau": xxx,
                        "events_num": xxx
                    }
                },
                "app_info": {
                    "app_name": xx,
                    "app_en_name": xx
                }
            }
        }
    }
}

字段含义说明
数据格式为data.usage_amount.${app_id}.month_usage_amount.${month}: {具体的内容}。
mount的格式为 yyyyMM

3.2 OpenAPI SDK 使用样例

bc 为创建的 RangersClient, 其初始化请参考 “OpenAPI SDK 使用说明”， 各语言的 SDK 都提供了类似的接口

调用(Python)：

body={
    "org_id": null,
    "app_ids": [164314],
    "start_time": 1643644800, # 2022年2月1日
    "end_time": 1645977600 # 2022年2月28日
}
res = bc.data_finder('/openapi/v1/usage_amount/daily', body={body})
print(res.content)

返回结果：

{
    "code": 200,
    "message": "success",
    "data": {
        "usage_amount": {
            "164314": {
                "month_usage_amount": {
                    "202202": {
                        "days": 28,
                        "mau": 100000,
                        "dau": 100,
                        "events_num": 100000000
                    }
                },
                 "app_info": {
                    "app_name": "rangers_164314_ceshi",
                    "app_en_name": "rangers_164314_ceshi"
                }
            }
        }
    }
}

4.1 API 定义

Path：/openapi/v1/usage_amount/daily
Method: POST
Content-type: application/json
Body: 参考公共参数说明

Response:

{
    "code": 200,
    "message": "success",
    "data": {
        "${app_id}": {
            "day_usage_amount": {
                "{day}": {
                    "dau": 1,
                    "events_num": 1
                },
            "app_info": {
                    "app_name": xx,
                    "app_en_name": xx
                }
        }
    }
}

数据格式为data.${app_id}.day_usage_amount.${day}: {具体的内容}。
mont的格式为 yyyyMMdd

4.2 OpenAPI SDK 样例

bc 为创建的 RangersClient, 其初始化请参考 “OpenAPI SDK 使用说明”， 各语言的 SDK 都提供了类似的接口

调用(Python)：：

body={
    "org_id": null,
    "app_ids": [164314],
    "start_time": 1643644800, # 2022年2月1日
    "end_time": 1645977600 # 2022年2月28日
}
res = bc.data_finder('/openapi/v1/usage_amount/daily', body={body})
print(res.content)

返回结果：

{
    "code": 200,
    "message": "success",
    "data": {
        "164314": {
            "day_usage_amount": {
                "20220201": {
                    "dau": 1,
                    "events_num": 1
                },
                "20220202": {
                    "dau": 1,
                    "events_num": 1
                },
                "20220203": {
                    "dau": 1,
                    "events_num": 1
                },
                ...
                ...
                ...
                "20220228": {
                    "dau": 1,
                    "events_num": 1
                }
            },
            "app_info": {
                    "app_name": "rangers_164314_ceshi",
                    "app_en_name": "rangers_164314_ceshi"
                }
        }
    }
}