Reports

List report datasets

Returns the reporting catalog: every dataset available to your workspace with its metrics and attributes.

GET

/v2/reports/datasets

curl --request GET \
  --url https://do.featurebase.app/v2/reports/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

{
  "data": [
    {
      "attributes": [
        {
          "allowedOperators": [
            "in"
          ],
          "category": "conversation",
          "description": "<string>",
          "id": "conversation.channel",
          "multiValue": true,
          "name": "Channel",
          "semantics": "current_state",
          "staticOptions": [
            {
              "label": "<string>",
              "presentation": {
                "color": "<string>",
                "icon": "<any>",
                "iconSvg": "<string>",
                "imageUrl": "<string>",
                "kind": "brand",
                "secondaryLabel": "<string>"
              },
              "value": "<string>"
            }
          ],
          "supportsFilter": true,
          "supportsGroupBy": true,
          "supportsValueLookup": true,
          "valueType": "string"
        }
      ],
      "description": "<string>",
      "id": "conversations",
      "metrics": [
        {
          "algebra": {
            "kind": "direct_aggregate"
          },
          "allowedAggregations": [
            "count"
          ],
          "availabilityReason": "<string>",
          "dataAvailableFromIso": "2026-07-14",
          "definitionVersion": 123,
          "description": "<string>",
          "executionKind": "pipe_aggregate",
          "id": "new_conversations",
          "isDefaultVariant": true,
          "name": "New conversations",
          "presentationFamily": "count",
          "qualifiers": [
            "<string>"
          ],
          "releaseState": "available",
          "searchAliases": [
            "<string>"
          ],
          "supportedFilterAttributeIds": [
            "<string>"
          ],
          "supportedGroupByDimensions": [
            "<string>"
          ],
          "supportedViews": [
            "standard"
          ],
          "supportsOfficeHours": true,
          "supportsPeriodComparison": true,
          "type": "count",
          "unit": "count",
          "variantGroupId": "new_conversations",
          "variantId": "started_at",
          "variantLabel": "Started at"
        }
      ],
      "name": "Conversations"
    }

This is the discovery endpoint for the reporting API — read it before building query payloads:

Metrics carry the metric IDs accepted by POST /v2/reports/query, plus each metric's allowedAggregations, unit, and whether it supports office-hours restriction and period comparison.
Attributes carry the fieldIds accepted in filter rules and the attribute IDs accepted as groupBy / segmentBy, plus each attribute's allowedOperators and value type. Attributes with staticOptions list their full value set inline; other filterable attributes resolve values via POST /v2/reports/filter-values.

The catalog includes your workspace's custom conversation/ticket attributes where applicable, so it can differ between workspaces.

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

Response

Success

dataobject[]required

Show child attributes

objectenum<string>required

Available options: list

Still need help? Ask the team