Skip to main content

Get App Resource Usage Statistics API

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:

  • daily_automation_exec :daily Automations Pro executions

  • daily_attachment_upload :daily attachment upload volume

v3

2026-10-12

Added two response fields:

  • items[].group_no :app group ID

  • items[].app_group_name :app group name


API Call

Rate Limit: 1 request/second

Method: POST

Request Parameters:

Parameter

Type

Required

Description

date

String

No

The statistics date in yyyy-MM-dd format. If omitted or set to an empty string, the API queries statistics for the previous day, namely T-1.

app_ids

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.

skip

Number

No

The pagination offset. Default: 0.

limit

Number

No

The page size. Default: 20. Maximum: 100.

Notes:

  1. 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.

  2. This API does not return total. Use has_next to determine whether more pages are available.

  3. date is based on UTC+8 by default.

    1. 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.

    2. 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.

  4. 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

date

The statistics date.

has_next

Indicates whether more pages are available.

items

The list of app usage statistics.

items[].app_id

The app ID.

items[].app_name

The app name.

items[].group_no

The ID of the app group to which the app belongs.

items[].app_group_name

The name of the app group to which the app belongs.

items[].creator

Basic information about the creator.

items[].created_at

The creation time.

items[].last_edit_at

The last edited time.

items[].last_visit_at

The last visited time.

items[].metrics

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       }     }   ] }
Did this answer your question?