Retrieves a paginated list of available values for a specific data filter field.
Use this endpoint to populate filter dropdowns and autocomplete for report/widget filters.
Positive dataFieldId values reference standard data fields; negative values reference UDF fields (negate the udfFieldId).
Only text-type fields (dataTypeId 3, 12, 13) return values. Supports search-as-you-type via the search parameter.
Some values are conditionally filtered based on user feature flags (e.g., Total Emissions requires GHG/CarbonHub).
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| dataFieldId | Numeric identifier of the data field. Positive for standard fields, negative for UDF fields (negated udfFieldId). | integer (int32) | Required |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| search | Optional search text to filter results (case-insensitive contains match) | string | Optional |
| pageSize | The number of elements to return in a page | integer (int32) | Optional |
| pageNumber | The current page number | integer (int32) | Optional |
Response Headers
This endpoint returns pagination metadata in the response headers.
| Header | Type | Description |
|---|---|---|
| PageNumber | integer | The current page number (1-based). |
| PageSize | integer | The maximum number of items per page. |
| TotalNumberOfRecords | integer | The total number of records matching the query across all pages. |
| TotalPages | integer | The total number of pages. Increment pageNumber until it equals this value to retrieve all results. |
See the Pagination guide for iteration examples and best practices.
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
FilterDataResponse
| Property | Description | Type |
|---|---|---|
| value | The filter value text that can be used as a filter selection | string |
Example Response
[
{ "value": "string"
}
]