Introduction
Retrieves app-level resource usage statistics for the current organization on a specified date.
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 |
v2 | 2026-06-29 | Added two response fields:
|
v3 | 2026-10-12 | Added two response fields:
|
API Call
Rate Limit: 1 request/second
Method: POST
Request Parameters:
Parameter | Type | Required | Description |
| String | No | The statistics date in |
| String[] | No | The list of app IDs. Up to 10 app IDs are supported. If omitted or set to an empty array, all apps are queried with pagination. |
| Number | No | The pagination offset. Default: |
| Number | No | The page size. Default: |
Notes:
When date is specified, it must not be later than the previous day, namely T-1. The API supports querying data from the last 180 days only.
This API does not return total. Use has_next to determine whether more pages are available.
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",
"app_ids": [
"65f000000000000000000001"
],
"skip": 0,
"limit": 20
}
Response Parameters:
Parameter | Description |
| The statistics date. |
| Indicates whether more pages are available. |
| The list of app usage statistics. |
| The app ID. |
| The app name. |
| The ID of the app group to which the app belongs. |
| The name of the app group to which the app belongs. |
| Basic information about the creator. |
| The creation time. |
| The last edited time. |
| The last visited time. |
| App-level resource usage metrics. The metric fields are listed below. |
Response Example:
{ "date": "2026-05-08", "has_next": false, "items": [ { "app_id": "65f000000000000000000001", "app_name": "CRM", "group_no": 2, "app_group_name": "Human Resources", "creator": { "member_id": "65f000000000000000000011", "name": "John Smith" }, "created_at": "2026-01-01T00:00:00+08:00", "last_edit_at": "2026-05-06T12:00:00+08:00", "last_visit_at": "2026-05-06T18:00:00+08:00", "metrics": { "app": 1, "form_coop": 20, "form_workflow": 3, "dash": 2, "etl": 1, "aggregate": 1, "public_link": 5, "data_trigger": 2, "automation": 1, "bpa": 0, "data": 2, "daily_attachment_upload": 0, "daily_automation_exec": 0 } } ] }