Introduction
Retrieves an overview of platform resource usage for the current organization on a specified date.
Note: This API only returns aggregated metrics at the organization level. It does not return app-level or member-level details.
Plan Description
This is a paid advanced feature. For details, contact our Sales Team.
API Version
API Version | Updated On | Description |
v1 | 2026-05-28 | Initial release |
API Call
Rate Limit: 1 request/second
Method: POST
Request Parameters:
Parameter | Type | Required | Description |
| String | No | The statistics date in |
Notes:
When date is specified, it must not be later than the previous day, namely T-1.
When date is specified, the API supports querying data from the last 180 days only.
date is based on UTC+8 by default.
For example, if the local date in the United States is 2026-05-28 and the date in China is 2026-05-27, passing 2026-05-28 as date will not return the corresponding data.
This is because date is interpreted in UTC+8. In this case, the UTC+8 date is 2026-05-27, and date must not be later than the previous day. Therefore, only data for 2026-05-26 or earlier can be queried.
Before using this API, make sure that the Admin Console > Management Tools > Usage Statistics feature has been enabled and used. Otherwise, the related data cannot be retrieved, and the metric fields will return 0.
Request Example:
{
"date": "2026-05-08"
}
Response Parameters:
Parameter | Description |
| The statistics date. |
| Organization usage metrics. The metric fields are listed below.
|
Response Example：
{
"date": "2026-05-08",
"metrics": {
"app": 10,
"form_coop": 120,
"form_workflow": 20,
"dash": 15,
"etl": 5,
"aggregate": 3,
"public_link": 30,
"data_trigger": 8,
"automation": 6,
"bpa": 2,
"data": 50000
}
}