Reports

List supported filters for a metric route

Returns the filter attribute IDs supported by the selected metric and optional grouping route.

POST

/v2/reports/filter-capabilities

curl --request POST \
  --url https://do.featurebase.app/v2/reports/filter-capabilities \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupBy": "<string>",
  "metricId": "<string>",
  "segmentBy": "<string>"
}
'

{
  "object": "report_metric_filter_capabilities",
  "supportedFilterAttributeIds": [
    "<string>"
  ]
}

Use this operation before constructing metric-level filters. It applies the same routing rules as the dashboard and prevents clients from offering filters that the selected metric, group, or segment path cannot execute.

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer, and only for workspaces with the Reports product enabled (404 otherwise).

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Body

groupBystring

Required string length: 1 - 512

metricIdstringrequired

Required string length: 1 - 512

segmentBystring

Required string length: 1 - 512

Response

Success

objectenum<string>required

Available options: report_metric_filter_capabilities

supportedFilterAttributeIdsstring[]required

Still need help? Ask the team