Skip to main content
GET
Get report type

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The Extole unique report type identifier.

Response

Report type definition including display metadata, parameters, formats, scopes, visibility, tags, and component references.

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.

allowed_scopes
enum<string>[]
required

Scopes the report type may be configured for. Superset of scopes.

Scopes the report type may be configured for. Superset of scopes.

Available options:
CLIENT_ADMIN,
CLIENT_SUPERUSER,
CONSUMER_PUBLIC
categories
string[]
required

Categories used to group report types in the dashboard report builder.

Categories used to group report types in the dashboard report builder.

component_ids
string[]
required
component_references
object[]
required
data_sources
enum<string>[]
required

Underlying data sources the report type reads from.

Underlying data sources the report type reads from.

Available options:
AUDIT_EMAIL,
BATCH,
CLIENT,
CLIENT_CHANGE,
CONSUMER,
CONSUMER_PROFILE,
DASHBOARD,
DATA_INTELLIGENCE,
MESSAGE,
NOTIFICATION,
PROFILE,
REWARD,
REWARD_COMMAND,
WEBHOOK,
WEBHOOK_DISPATCH_RESULT
data_start
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

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
enum<string>
required

Engine that executes the report (e.g. SQL, Spark).

Available options:
DASHBOARD,
SPARK,
SQL
formats
enum<string>[]
required

Output formats the report type can produce (e.g. CSV, JSON).

Output formats the report type can produce (e.g. CSV, JSON).

Available options:
CSV,
HEADLESS_CSV,
HEADLESS_PSV,
JSON,
JSONL,
PSV,
XLSX
name
string
required

Stable internal name. Use display_name for UI; name for programmatic lookup.

parameters
object[]
required

Declared parameters (static + dynamic) the report type accepts.

preview_columns
object[]
required

Column metadata for the report type's preview output.

scopes
enum<string>[]
required

Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).

Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).

Available options:
CLIENT_ADMIN,
CLIENT_SUPERUSER,
CONSUMER_PUBLIC
tags
object[]
required

Tags attached to the report type, used for filtering and grouping.

type
enum<string>
required

Discriminator selecting the report-type shape.

Available options:
CONFIGURED
visibility
enum<string>
required

Whether the report type is PUBLIC, PRIVATE, or restricted.

Available options:
EXTOLE_ONLY,
PRIVATE,
PUBLIC
created_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

updated_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"