查询集团用量数据--增长分析 DataFinder-火山引擎

文档中心

立即注册

导航

查询集团用量数据

最近更新时间：2025.08.29 17:08:40首次发布时间：2025.08.28 15:29:54

请求说明

Path：v1/openapi/org/{org_id}/usage
Method：GET
Content-type：application/json

注意事项

当前仅SaaS-非云原生支持使用此OpenAPI。
调用此OpenAPI时，您需使用集团管理员账号AK/SK来调用。

调用说明

使用当前接口时，如果您使用DataFinder提供的SDK进行调用，您需要使用
bc.data_rangers("${path}", ...)接口，更多关于API的调用说明请参见调用方式。调用示例如下。

res = bc.data_rangers('/openapi/v1/org/**/usage', method='get', params=params, headers=headers)
print(res.content)

请求参数

Path-parameters

参数	类型	是否必选	示例值	描述
org_id	int	是	12345	集团ID（集团编号）。您可以使用集团管理员账号进入DataFinder控制台的集团设置>集团信息页面获取集团ID。设置集团ID后，后续可使用当前接口查询集团下的所有应用的用量数据。

参数

类型

是否必选

示例值

描述

org_id

int

是

12345

集团ID（集团编号）。

您可以使用集团管理员账号进入DataFinder控制台的集团设置>集团信息页面获取集团ID。
设置集团ID后，后续可使用当前接口查询集团下的所有应用的用量数据。

params

参数	类型	是否必选	示例值	描述
with_monthly_detail	int	否	1	配置查询的用量数据是否需要加上月级明细数据： 0（默认）：不带月级明细数据。 1：带月级明细数据。
product_name_list	string	是	DataFinder	配置查询的用量数据覆盖的产品范围，仅支持查询： DataFinder：除广告监测外的其他DataFinder的用量数据。 DataTracer：广告监测的用量数据。支持同时查询DataFinder和DataTracer，用逗号分隔：`DataFinder,DataTracer`。

参数

类型

是否必选

示例值

描述

with_monthly_detail

int

否

配置查询的用量数据是否需要加上月级明细数据：

0（默认）：不带月级明细数据。
1：带月级明细数据。

product_name_list

string

是

DataFinder

配置查询的用量数据覆盖的产品范围，仅支持查询：

DataFinder：除广告监测外的其他DataFinder的用量数据。
DataTracer：广告监测的用量数据。

支持同时查询DataFinder和DataTracer，用逗号分隔：DataFinder,DataTracer。

返回参数

参数名称	类型	说明
code	int	接口返回状态，200为成功
message	string	接口返回信息，成功时默认为success
data	object	集团内所有应用的用量详情，data内的参数详情参见下文。

data参数详情如下。

参数名称	类型	说明
product_name	string	查询的用量数据覆盖的产品范围。
started_at	string	合同开始时间。
expired_at	string	合同结束时间。
data_limit_desc	string	合同中用量的计费项。 EVENTS_NUM：有效事件量 MTU：以 SSID 口径统计的发生有效事件的用户。 DAU：日活用户数，当前已不再使用此种方式进行计费，少量历史用户可能存在此种计费方式。
data_limit	int	合同中的用量限额。
total_amount	int	当前合同中计费项的累计用量。
this_amount	int	查询时间内，计费项当月的用量。
last_amount	int	查询时间内，计费项上个月的用量。
current_time	string	当前时间。
statistics_time	string	统计数据截止时间。
monthly_detail	object	月级别的用量明细数据，其中会按月度为您展示各个应用的用量明细，用量明细包含： app_id：应用ID。 app_name：应用名。 amount：此应用在当前月度的用量数据。

请求示例

{
    "with_monthly_detail": 1 
}

返回示例

{
    "code": 200,
    "message": "成功",
    "data": [
        {
            "product_name": "DataFinder",
            "started_at": "2025-06-04",
            "expired_at": "2026-06-04",
            "data_limit_desc": "EVENTS_NUM",
            "data_limit": 200000000,
            "total_amount": 383983760,
            "this_amount": 221001113,
            "last_amount": 162982647,
            "current_time": "2025-08-19 22:47:15",
            "statistics_time": "2025-08-18",
            "monthly_detail": {
                "2025-07": [
                    {
                        "app_id": ****,
                        "app_name": "**发现者",
                        "amount": 82576533
                    },
                    {
                        "app_id": ****,
                        "app_name": "**漫游者",
                        "amount": 5949092
                    }
                ],
                "2025-08": [
                    ...
                ]
            }
        }
    ]
}