Skip to main content

Aggregate Table Field Query API

Overview

This API retrieves field information for a specified Aggregate Table.


API Version

API Version

Last Updated

Version Description

V6

2026.08.13

Initial version


API Calling

This API retrieves field information for a specified Aggregate Table.

Request URL: https://api.jodoo.com/api/v6/beta/app/aggregate_view/widget/list

Request Frequency: 30 requests/second

Request Method: POST

Request Parameters:

Parameter

Type

Required

Description

app_id

String

Yes

App ID.

entry_id

String

Yes

Aggregate Table ID.

Sample Request:

{

"app_id": "59264073a2a60c0c08e20bfb",

"entry_id": "66a1f08ca83a80a53193d121"

}

Response Parameters:

Parameter

Type

Description

widgets

Array

List of Aggregate Table fields.

widgets[].name

String

Field name. Used in fields and filter.cond[].field of the Aggregate Table Data Query API.

widgets[].label

String

Field display name.

widgets[].type

String

Field type, such as text, number, datetime, user, or dept.

Sample Response:

{

"widgets": [

{

"name": "_widget_1720000000001",

"label": "Region",

"type": "text" },

{

"name": "_widget_1720000000002",

"label": "Sales",

"type": "number"

}

]

}


More to Know

Aggregate Table fields cannot be queried until the Aggregate Table has finished calculating. If the calculation is incomplete, go to the Aggregate Table and run the calculation first.

Did this answer your question?