Create a report type
Creates a new report-type definition (SQL- or CONFIGURED-shaped). Returns the persisted report type with its server-assigned id and any defaulted fields. Marked expert: report-type definitions are typically managed by Extole staff.
Authorizations
Body
- CONFIGURED
- SQL
Body of POST /v6/report-types. Polymorphic on type: SQL- and CONFIGURED-shaped report types share the metadata fields below and add their own type-specific fields.
CLIENT_ADMIN, CLIENT_SUPERUSER, CONSUMER_PUBLIC CSV, HEADLESS_CSV, HEADLESS_PSV, JSON, JSONL, PSV, XLSX CLIENT_ADMIN, CLIENT_SUPERUSER, CONSUMER_PUBLIC CONFIGURED EXTOLE_ONLY, PRIVATE, PUBLIC - DYNAMIC
- STATIC
Response
Report type definition including display metadata, parameters, formats, scopes, visibility, tags, and component references.
- CONFIGURED
- DASHBOARD
- SPARK
- SQL
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.
Scopes the report type may be configured for. Superset of scopes.
Scopes the report type may be configured for. Superset of scopes.
CLIENT_ADMIN, CLIENT_SUPERUSER, CONSUMER_PUBLIC Categories used to group report types in the dashboard report builder.
Categories used to group report types in the dashboard report builder.
Underlying data sources the report type reads from.
Underlying data sources the report type reads from.
AUDIT_EMAIL, BATCH, CLIENT, CLIENT_CHANGE, CONSUMER, CONSUMER_PROFILE, DASHBOARD, DATA_INTELLIGENCE, MESSAGE, NOTIFICATION, PROFILE, REWARD, REWARD_COMMAND, WEBHOOK, WEBHOOK_DISPATCH_RESULT 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.
^\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])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
Short description shown alongside the report type in the dashboard.
Human-readable name shown in the dashboard.
Engine that executes the report (e.g. SQL, Spark).
DASHBOARD, SPARK, SQL Output formats the report type can produce (e.g. CSV, JSON).
Output formats the report type can produce (e.g. CSV, JSON).
CSV, HEADLESS_CSV, HEADLESS_PSV, JSON, JSONL, PSV, XLSX Stable internal name. Use display_name for UI; name for programmatic lookup.
Declared parameters (static + dynamic) the report type accepts.
Column metadata for the report type's preview output.
Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).
Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN).
CLIENT_ADMIN, CLIENT_SUPERUSER, CONSUMER_PUBLIC Tags attached to the report type, used for filtering and grouping.
Discriminator selecting the report-type shape.
CONFIGURED Whether the report type is PUBLIC, PRIVATE, or restricted.
EXTOLE_ONLY, PRIVATE, PUBLIC 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.
^\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])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
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.
^\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])(\[[^\]]+\])?$"2025-10-24T02:00:00-07:00"
