Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Report Types API

The Report Types API from Extole — 9 operation(s) for report types.

Extole Report Types API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Report Types. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 9 paths, and defines 31 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

14 operations 9 paths 31 schemas 2 DELETE5 GET1 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Report Types API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 2 DELETE, 5 GET, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Report Types 14
GET
/v6/report-types/{id}/clients
List clients with access to a report type
listReportTypeClients 1 param → 200400401402403404415429
PUT
/v6/report-types/{id}/clients
Replace the report type's client access list
updateReportTypeClients 1 param body → 200400401402403404415429
DELETE
/v6/report-types/{id}/clients
Revoke client access to a report type
deleteReportTypeClients 2 params → 200400401402403404415429
POST
/v6/report-types
Create a report type
createReportType body → 200400401402403415429
GET
/v6/report-types
List report types
listReportTypes 11 params → 200400401402403415429
PUT
/v6/report-types/{id}/parameters-add
Add dynamic parameters to a report type
addReportTypeParameters 1 param body → 200400401402403404415429
PUT
/v6/report-types/{id}/parameters-delete
Remove dynamic parameters from a report type
deleteReportTypeParameters 1 param body → 200400401402403404415429
PUT
/v6/report-types/{id}/tags-add
Add tags to a report type
addReportTypeTags 1 param body → 200400401402403404415429
PUT
/v6/report-types/{id}/tags-delete
Remove tags from a report type
deleteReportTypeTags 1 param body → 200400401402403404415429
GET
/v6/report-types/clients
List report types with their associated clients
listReportTypesWithClients 11 params → 200400401402403415429
GET
/v6/report-types/recommendations
List recommended report types
listReportTypeRecommendations 1 param → 200400401402403415429
GET
/v6/report-types/{id}
Get report type
getReportType 1 param → 200400401402403404415429
PUT
/v6/report-types/{id}
Update a report type
updateReportType 1 param body → 200400401402403404415429
DELETE
/v6/report-types/{id}
Delete a report type
deleteReportType 1 param → 200400401402403404415429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ReportTypeResponseBase (17 properties), ReportTypeCreateRequestBase (12 properties), ReportTypeParameterDetailsRequestBase (8 properties), ReportTypeParameterDetailsResponse (8 properties). Each schema is shown below with its type and property counts.

ReportTypeWithClientsResponse
object
Pairs a report-type definition with the ids of clients that have access to it. Returned by GET /v6/report-types/clients.
2 properties 2 required
DashboardReportTypeResponse
object
17 required
ConfiguredReportTypeCreateRequest
object
12 required
ReportTypeResponse
Report type definition. Polymorphic on type: SQL, SPARK, DASHBOARD, and CONFIGURED share the common metadata below (display name, description, scopes, paramete…
17 required
DashboardReportTypeUpdateRequest
object
2 required
ConfiguredReportTypeUpdateRequest
object
11 required
ReportTypeCreateRequest
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 fie…
10 required
ReportTypeColumnResponse
object
Column metadata for the report type's preview output.
3 properties
ConfiguredReportTypeResponse
object
19 required
ReportTypeTagRequest
object
2 properties
Instant
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) UTC date-time with a Z suffix. Precision up to milliseconds.
ReportTypeUpdateRequest
Body of PUT /v6/report-types/{id}. Polymorphic on type: SQL, SPARK, CONFIGURED, and DASHBOARD shapes share the metadata fields below and add their own type-spe…
2 required
ReportTypeUpdateRequestBase
object
4 properties
SparkReportTypeResponse
object
17 required
ReportTypeParameterDetailsRequest
ReportParameterTypeResponse
object
3 properties
DynamicReportTypeParameterDetailsRequest
object
10 required
ReportTypeParameterDetailsResponse
object
Declared parameters (static + dynamic) the report type accepts.
8 properties
ReportTypeResponseBase
object
17 properties
ReportTypeTagResponse
object
Tags attached to the report type, used for filtering and grouping.
2 properties
ReportTypeCreateRequestBase
object
12 properties
SqlReportTypeCreateRequest
object
12 required
SparkReportTypeUpdateRequest
object
2 required
SqlReportTypeResponse
object
21 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
ComponentReferenceResponse
object
2 properties
ComponentReferenceRequest
object
2 properties
SqlReportTypeUpdateRequest
object
12 required
StaticReportTypeParameterDetailsRequest
object
8 required
ReportTypeParameterDetailsRequestBase
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-report-types-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API