Query indicator
query_indicatorRead-only
Runs a pre-configured analytical indicator and returns its computed results. Call search_indicator_by_name first to get an indicator id. The result shape depends on the indicator type (KPI, series, grouped series, table) and dates are ISO 8601 (yyyy-MM-dd). Read get_documentation('indicators') for the result shapes and the filters.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The unique identifier of the indicator to query. Use 'search_indicator_by_name' to find available indicator IDs. | |
| endDate | No | End date for the query period (ISO 8601, e.g. '2025-12-31'). Optional. | |
| startDate | No | Start date for the query period (ISO 8601, e.g. '2025-01-01'). Optional. | |
| companyIds | No | Array of company IDs to filter results by specific companies. Resolve one with 'search_entity_by_name' on Company. Optional. | |
| currencyId | No | ISO 4217 currency code to convert monetary values into, such as EUR or USD. Defaults to the tenant's configured currency. | |
| divisionIds | No | Array of division IDs to filter results by specific divisions. Resolve one with 'search_entity_by_name' on CompanyDivision. Optional. | |
| pipelinesIds | No | Array of pipeline IDs to filter results by specific sales pipelines. Resolve one with 'search_entity_by_name' on Pipeline. Optional. | |
| excludeNonProductiveDivisions | No | When true, excludes non-productive divisions (e.g. support, admin) from the results. Defaults to false. |