runTableAggregation
Calculate aggregate statistics like sum, average, or count on table data in Tulip manufacturing platform. Apply filters, sorting, and limits to analyze specific datasets for operational insights.
Instructions
Runs an aggregate function on a table field. Corresponds to GET /tables/{tableId}/runAggregation. Requires tables:read scope. [READ-ONLY]
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tableId | Yes | The ID of the table | |
| function | Yes | Aggregate function name. Valid values: [ "sum", "count", "avg", "min", "max", "mode", "uniqueValues" ] | |
| fieldId | Yes | The field to aggregate on. | |
| limit | Yes | The maximum number of table records to evaluate. Minimum 1, Maximum 100000. | |
| sortOptions | No | Sorting allows to define which records are considered if there are more than the specified limit. Sort priority is determined by the order or options. Example: [{"sortBy": "field1", "sortDir": "asc"}] | |
| filters | No | An optional array of filter expressions to filter the Table records by. Example: [{"field": "field1", "functionType": "equal", "arg": "value1"}] | |
| filterAggregator | No | How to combine filters, 'all' or 'any'. Default is 'all'. |