---
title: "List report types"
method: GET
path: "/v6/report-types"
tags: ["Report Types"]
---

# List report types

`GET /v6/report-types`

Returns the report types visible to the calling client, filtered and ordered by the supplied query parameters. Supports paging via `limit` / `offset` and ordering via `order_by` / `order`. Use this to populate report-builder pickers and to discover the available `parameters`, `formats`, and `scopes` for each report type.

## Query parameters

- `report_type_id` string
- `display_name` string
- `description` string
- `visibility` 'EXTOLE_ONLY' | 'PRIVATE' | 'PUBLIC'
- `tags` string
- `exclude_tags` string
- `search_query` string
- `limit` integer
- `offset` integer
- `order_by` 'DISPLAY_NAME' | 'ID' | 'TYPE' | 'VISIBILITY'
- `order` 'ASCENDING' | 'DESCENDING'

## Response `200`

Successful response

- ReportTypeResponse[]
  - union — Report type definition. Polymorphic on `type`: SQL, SPARK, DASHBOARD, and CONFIGURED share the common metadata below (display name, description, scopes, parameters, formats, tags, data sources) and add their own type-specific fields.
    - object
      - `allowed_scopes` string[], required — Scopes the report type may be configured for. Superset of `scopes`.
      - `categories` string[], required — Categories used to group report types in the dashboard report builder.
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `data_sources` string[], required — Underlying data sources the report type reads from.
      - `data_start` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `description` string, required — Short description shown alongside the report type in the dashboard.
      - `display_name` string, required — Human-readable name shown in the dashboard.
      - `executor_type` 'DASHBOARD' | 'SPARK' | 'SQL', required — Engine that executes the report (e.g. SQL, Spark).
      - `formats` string[], required — Output formats the report type can produce (e.g. CSV, JSON).
      - `name` string, required — Stable internal name. Use `display_name` for UI; `name` for programmatic lookup.
      - `parameters` ReportTypeParameterDetailsResponse[], required — Declared parameters (static + dynamic) the report type accepts.
        - `category` string, nullable
        - `default_value` string, nullable
        - `description` string
        - `display_name` string
        - `is_required` boolean
        - `name` string
        - `order` integer
        - `type` ReportParameterTypeResponse
          - `name` 'AUDIENCE_ID' | 'AUDIENCE_IDS' | 'AUDIENCE_MEMBERSHIPS_METRIC_MAPPING' | 'AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS' | 'AUDIENCE_MEMBERS_ROW_MAPPINGS' | 'BOOLEAN' | 'CAMPAIGN_ID' | 'CAMPAIGN_IDS' | 'CHANNEL_MAPPING' | 'CLIENT_EVENT_METRIC_MAPPINGS' | 'CLIENT_ID' | 'CLIENT_IDS' | 'DATE' | 'DATE_RANGE' | 'DECIMAL' | 'EMAIL_NAMES' | 'ENUM' | 'ENUM_LIST' | 'EQUALITY' | 'FILTER_MAPPINGS' | 'FLOWS' | 'FLOW_FILTER' | 'GRANULAR_TIME_RANGE' | 'ID' | 'IDS' | 'INPUT_RECORD_METRIC_MAPPING' | 'INPUT_RECORD_ROW_MAPPINGS' | 'INTEGER' | 'LONG' | 'MESSAGE_SUMMARY_METRIC_MAPPINGS' | 'METRIC_MAPPINGS' | 'MODEL_CONFIGURATION_METRIC_MAPPING' | 'NORMALIZED_EMAIL' | 'NOT_ARCHIVED_CAMPAIGN_ID' | 'PERSON_DIMENSION_MAPPINGS' | 'PERSON_MAPPINGS' | 'PROGRAM_LABEL' | 'PROGRAM_LABELS' | 'REGEX' | 'REWARD_EVENT_METRIC_MAPPINGS' | 'REWARD_ROW_MAPPINGS' | 'REWARD_SUPPLIER_DISPLAY_TYPES' | 'REWARD_SUPPLIER_IDS' | 'REWARD_SUPPLIER_TYPES' | 'ROW_MAPPINGS' | 'SORT_ORDER_MAPPINGS' | 'SORT_ORDER_MAPPINGS_ON_STEPS' | 'STEP' | 'STEPS' | 'STEP_COLUMN_LIST' | 'STRING' | 'STRING_LIST' | 'TIERS' | 'TIME' | 'TIME_RANGE' | 'WEBHOOK_DISPATCH_METRIC_MAPPING' | 'WEBHOOK_DISPATCH_ROW_MAPPINGS' | 'WEBHOOK_METRIC_MAPPING' | 'WEBHOOK_ROW_MAPPINGS'
          - `value_type` 'DYNAMIC' | 'STATIC', nullable
          - `values` string[], nullable
      - `preview_columns` ReportTypeColumnResponse[], required — Column metadata for the report type's preview output.
        - `name` string
        - `note` string, nullable
        - `sample_value` string, nullable
      - `scopes` string[], required — Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).
      - `tags` ReportTypeTagResponse[], required — Tags attached to the report type, used for filtering and grouping.
        - `name` string
        - `type` 'GLOBAL' | 'PRIVATE'
      - `type` 'CONFIGURED', required — Discriminator selecting the report-type shape.
      - `visibility` 'EXTOLE_ONLY' | 'PRIVATE' | 'PUBLIC', required — Whether the report type is PUBLIC, PRIVATE, or restricted.
      - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - object
      - `allowed_scopes` string[], required — Scopes the report type may be configured for. Superset of `scopes`.
      - `categories` string[], required — Categories used to group report types in the dashboard report builder.
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `data_sources` string[], required — Underlying data sources the report type reads from.
      - `data_start` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `description` string, required — Short description shown alongside the report type in the dashboard.
      - `display_name` string, required — Human-readable name shown in the dashboard.
      - `executor_type` 'DASHBOARD' | 'SPARK' | 'SQL', required — Engine that executes the report (e.g. SQL, Spark).
      - `formats` string[], required — Output formats the report type can produce (e.g. CSV, JSON).
      - `name` string, required — Stable internal name. Use `display_name` for UI; `name` for programmatic lookup.
      - `parameters` ReportTypeParameterDetailsResponse[], required — Declared parameters (static + dynamic) the report type accepts.
        - `category` string, nullable
        - `default_value` string, nullable
        - `description` string
        - `display_name` string
        - `is_required` boolean
        - `name` string
        - `order` integer
        - `type` ReportParameterTypeResponse
          - `name` 'AUDIENCE_ID' | 'AUDIENCE_IDS' | 'AUDIENCE_MEMBERSHIPS_METRIC_MAPPING' | 'AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS' | 'AUDIENCE_MEMBERS_ROW_MAPPINGS' | 'BOOLEAN' | 'CAMPAIGN_ID' | 'CAMPAIGN_IDS' | 'CHANNEL_MAPPING' | 'CLIENT_EVENT_METRIC_MAPPINGS' | 'CLIENT_ID' | 'CLIENT_IDS' | 'DATE' | 'DATE_RANGE' | 'DECIMAL' | 'EMAIL_NAMES' | 'ENUM' | 'ENUM_LIST' | 'EQUALITY' | 'FILTER_MAPPINGS' | 'FLOWS' | 'FLOW_FILTER' | 'GRANULAR_TIME_RANGE' | 'ID' | 'IDS' | 'INPUT_RECORD_METRIC_MAPPING' | 'INPUT_RECORD_ROW_MAPPINGS' | 'INTEGER' | 'LONG' | 'MESSAGE_SUMMARY_METRIC_MAPPINGS' | 'METRIC_MAPPINGS' | 'MODEL_CONFIGURATION_METRIC_MAPPING' | 'NORMALIZED_EMAIL' | 'NOT_ARCHIVED_CAMPAIGN_ID' | 'PERSON_DIMENSION_MAPPINGS' | 'PERSON_MAPPINGS' | 'PROGRAM_LABEL' | 'PROGRAM_LABELS' | 'REGEX' | 'REWARD_EVENT_METRIC_MAPPINGS' | 'REWARD_ROW_MAPPINGS' | 'REWARD_SUPPLIER_DISPLAY_TYPES' | 'REWARD_SUPPLIER_IDS' | 'REWARD_SUPPLIER_TYPES' | 'ROW_MAPPINGS' | 'SORT_ORDER_MAPPINGS' | 'SORT_ORDER_MAPPINGS_ON_STEPS' | 'STEP' | 'STEPS' | 'STEP_COLUMN_LIST' | 'STRING' | 'STRING_LIST' | 'TIERS' | 'TIME' | 'TIME_RANGE' | 'WEBHOOK_DISPATCH_METRIC_MAPPING' | 'WEBHOOK_DISPATCH_ROW_MAPPINGS' | 'WEBHOOK_METRIC_MAPPING' | 'WEBHOOK_ROW_MAPPINGS'
          - `value_type` 'DYNAMIC' | 'STATIC', nullable
          - `values` string[], nullable
      - `preview_columns` ReportTypeColumnResponse[], required — Column metadata for the report type's preview output.
        - `name` string
        - `note` string, nullable
        - `sample_value` string, nullable
      - `scopes` string[], required — Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).
      - `tags` ReportTypeTagResponse[], required — Tags attached to the report type, used for filtering and grouping.
        - `name` string
        - `type` 'GLOBAL' | 'PRIVATE'
      - `type` 'DASHBOARD', required — Discriminator selecting the report-type shape.
      - `visibility` 'EXTOLE_ONLY' | 'PRIVATE' | 'PUBLIC', required — Whether the report type is PUBLIC, PRIVATE, or restricted.
    - object
      - `allowed_scopes` string[], required — Scopes the report type may be configured for. Superset of `scopes`.
      - `categories` string[], required — Categories used to group report types in the dashboard report builder.
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `data_sources` string[], required — Underlying data sources the report type reads from.
      - `data_start` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `description` string, required — Short description shown alongside the report type in the dashboard.
      - `display_name` string, required — Human-readable name shown in the dashboard.
      - `executor_type` 'DASHBOARD' | 'SPARK' | 'SQL', required — Engine that executes the report (e.g. SQL, Spark).
      - `formats` string[], required — Output formats the report type can produce (e.g. CSV, JSON).
      - `name` string, required — Stable internal name. Use `display_name` for UI; `name` for programmatic lookup.
      - `parameters` ReportTypeParameterDetailsResponse[], required — Declared parameters (static + dynamic) the report type accepts.
        - `category` string, nullable
        - `default_value` string, nullable
        - `description` string
        - `display_name` string
        - `is_required` boolean
        - `name` string
        - `order` integer
        - `type` ReportParameterTypeResponse
          - `name` 'AUDIENCE_ID' | 'AUDIENCE_IDS' | 'AUDIENCE_MEMBERSHIPS_METRIC_MAPPING' | 'AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS' | 'AUDIENCE_MEMBERS_ROW_MAPPINGS' | 'BOOLEAN' | 'CAMPAIGN_ID' | 'CAMPAIGN_IDS' | 'CHANNEL_MAPPING' | 'CLIENT_EVENT_METRIC_MAPPINGS' | 'CLIENT_ID' | 'CLIENT_IDS' | 'DATE' | 'DATE_RANGE' | 'DECIMAL' | 'EMAIL_NAMES' | 'ENUM' | 'ENUM_LIST' | 'EQUALITY' | 'FILTER_MAPPINGS' | 'FLOWS' | 'FLOW_FILTER' | 'GRANULAR_TIME_RANGE' | 'ID' | 'IDS' | 'INPUT_RECORD_METRIC_MAPPING' | 'INPUT_RECORD_ROW_MAPPINGS' | 'INTEGER' | 'LONG' | 'MESSAGE_SUMMARY_METRIC_MAPPINGS' | 'METRIC_MAPPINGS' | 'MODEL_CONFIGURATION_METRIC_MAPPING' | 'NORMALIZED_EMAIL' | 'NOT_ARCHIVED_CAMPAIGN_ID' | 'PERSON_DIMENSION_MAPPINGS' | 'PERSON_MAPPINGS' | 'PROGRAM_LABEL' | 'PROGRAM_LABELS' | 'REGEX' | 'REWARD_EVENT_METRIC_MAPPINGS' | 'REWARD_ROW_MAPPINGS' | 'REWARD_SUPPLIER_DISPLAY_TYPES' | 'REWARD_SUPPLIER_IDS' | 'REWARD_SUPPLIER_TYPES' | 'ROW_MAPPINGS' | 'SORT_ORDER_MAPPINGS' | 'SORT_ORDER_MAPPINGS_ON_STEPS' | 'STEP' | 'STEPS' | 'STEP_COLUMN_LIST' | 'STRING' | 'STRING_LIST' | 'TIERS' | 'TIME' | 'TIME_RANGE' | 'WEBHOOK_DISPATCH_METRIC_MAPPING' | 'WEBHOOK_DISPATCH_ROW_MAPPINGS' | 'WEBHOOK_METRIC_MAPPING' | 'WEBHOOK_ROW_MAPPINGS'
          - `value_type` 'DYNAMIC' | 'STATIC', nullable
          - `values` string[], nullable
      - `preview_columns` ReportTypeColumnResponse[], required — Column metadata for the report type's preview output.
        - `name` string
        - `note` string, nullable
        - `sample_value` string, nullable
      - `scopes` string[], required — Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).
      - `tags` ReportTypeTagResponse[], required — Tags attached to the report type, used for filtering and grouping.
        - `name` string
        - `type` 'GLOBAL' | 'PRIVATE'
      - `type` 'SPARK', required — Discriminator selecting the report-type shape.
      - `visibility` 'EXTOLE_ONLY' | 'PRIVATE' | 'PUBLIC', required — Whether the report type is PUBLIC, PRIVATE, or restricted.
    - object
      - `allowed_scopes` string[], required — Scopes the report type may be configured for. Superset of `scopes`.
      - `categories` string[], required — Categories used to group report types in the dashboard report builder.
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `data_sources` string[], required — Underlying data sources the report type reads from.
      - `data_start` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `description` string, required — Short description shown alongside the report type in the dashboard.
      - `display_name` string, required — Human-readable name shown in the dashboard.
      - `executor_type` 'DASHBOARD' | 'SPARK' | 'SQL', required — Engine that executes the report (e.g. SQL, Spark).
      - `formats` string[], required — Output formats the report type can produce (e.g. CSV, JSON).
      - `name` string, required — Stable internal name. Use `display_name` for UI; `name` for programmatic lookup.
      - `parameters` ReportTypeParameterDetailsResponse[], required — Declared parameters (static + dynamic) the report type accepts.
        - `category` string, nullable
        - `default_value` string, nullable
        - `description` string
        - `display_name` string
        - `is_required` boolean
        - `name` string
        - `order` integer
        - `type` ReportParameterTypeResponse
          - `name` 'AUDIENCE_ID' | 'AUDIENCE_IDS' | 'AUDIENCE_MEMBERSHIPS_METRIC_MAPPING' | 'AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS' | 'AUDIENCE_MEMBERS_ROW_MAPPINGS' | 'BOOLEAN' | 'CAMPAIGN_ID' | 'CAMPAIGN_IDS' | 'CHANNEL_MAPPING' | 'CLIENT_EVENT_METRIC_MAPPINGS' | 'CLIENT_ID' | 'CLIENT_IDS' | 'DATE' | 'DATE_RANGE' | 'DECIMAL' | 'EMAIL_NAMES' | 'ENUM' | 'ENUM_LIST' | 'EQUALITY' | 'FILTER_MAPPINGS' | 'FLOWS' | 'FLOW_FILTER' | 'GRANULAR_TIME_RANGE' | 'ID' | 'IDS' | 'INPUT_RECORD_METRIC_MAPPING' | 'INPUT_RECORD_ROW_MAPPINGS' | 'INTEGER' | 'LONG' | 'MESSAGE_SUMMARY_METRIC_MAPPINGS' | 'METRIC_MAPPINGS' | 'MODEL_CONFIGURATION_METRIC_MAPPING' | 'NORMALIZED_EMAIL' | 'NOT_ARCHIVED_CAMPAIGN_ID' | 'PERSON_DIMENSION_MAPPINGS' | 'PERSON_MAPPINGS' | 'PROGRAM_LABEL' | 'PROGRAM_LABELS' | 'REGEX' | 'REWARD_EVENT_METRIC_MAPPINGS' | 'REWARD_ROW_MAPPINGS' | 'REWARD_SUPPLIER_DISPLAY_TYPES' | 'REWARD_SUPPLIER_IDS' | 'REWARD_SUPPLIER_TYPES' | 'ROW_MAPPINGS' | 'SORT_ORDER_MAPPINGS' | 'SORT_ORDER_MAPPINGS_ON_STEPS' | 'STEP' | 'STEPS' | 'STEP_COLUMN_LIST' | 'STRING' | 'STRING_LIST' | 'TIERS' | 'TIME' | 'TIME_RANGE' | 'WEBHOOK_DISPATCH_METRIC_MAPPING' | 'WEBHOOK_DISPATCH_ROW_MAPPINGS' | 'WEBHOOK_METRIC_MAPPING' | 'WEBHOOK_ROW_MAPPINGS'
          - `value_type` 'DYNAMIC' | 'STATIC', nullable
          - `values` string[], nullable
      - `preview_columns` ReportTypeColumnResponse[], required — Column metadata for the report type's preview output.
        - `name` string
        - `note` string, nullable
        - `sample_value` string, nullable
      - `scopes` string[], required — Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).
      - `tags` ReportTypeTagResponse[], required — Tags attached to the report type, used for filtering and grouping.
        - `name` string
        - `type` 'GLOBAL' | 'PRIVATE'
      - `type` 'SQL', required — Discriminator selecting the report-type shape.
      - `visibility` 'EXTOLE_ONLY' | 'PRIVATE' | 'PUBLIC', required — Whether the report type is PUBLIC, PRIVATE, or restricted.
      - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `database` 'ANALYTICS' | 'CUSTOMER_PORTAL' | 'INCENTIVES' | 'LABS' | 'OPTOUT', required
      - `query` string, required
      - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.dev/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.dev/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/revisions/c16e62e66755/schema)