How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0, 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.2.0
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), ReportTypeParameterDetailsResponse (8 properties), ReportTypeParameterDetailsRequestBase (8 properties). Each schema is shown below with its type and property counts.

StaticReportTypeParameterDetailsRequest
object
8 required
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
SqlReportTypeResponse
object
21 required
ReportTypeCreateRequestBase
object
12 properties
DashboardReportTypeUpdateRequest
object
2 required
SparkReportTypeResponse
object
17 required
ReportTypeParameterDetailsResponse
object
Declared parameters (static + dynamic) the report type accepts.
8 properties
ReportTypeParameterDetailsRequest
DashboardReportTypeResponse
object
17 required
ComponentReferenceResponse
object
2 properties
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…
ReportParameterTypeResponse
object
3 properties
ComponentReferenceRequest
object
2 properties
ReportTypeParameterDetailsRequestBase
object
8 properties
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
ConfiguredReportTypeUpdateRequest
object
11 required
SqlReportTypeCreateRequest
object
12 required
SqlReportTypeUpdateRequest
object
12 required
ConfiguredReportTypeCreateRequest
object
12 required
ReportTypeUpdateRequestBase
object
4 properties
ReportTypeTagRequest
object
2 properties
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
Instant
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) UTC date-time with a Z suffix. Precision up to milliseconds.
ReportTypeColumnResponse
object
Column metadata for the report type's preview output.
3 properties
ReportTypeResponse
Report type definition. Polymorphic on type: SQL, SPARK, DASHBOARD, and CONFIGURED share the common metadata below (display name, description, scopes, paramete…
17 required
ReportTypeResponseBase
object
17 properties
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
ReportTypeTagResponse
object
Tags attached to the report type, used for filtering and grouping.
2 properties
ConfiguredReportTypeResponse
object
19 required
SparkReportTypeUpdateRequest
object
2 required
DynamicReportTypeParameterDetailsRequest
object
10 required

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
Where this information came from

This is an independent, third-party profile of Extole Report Types API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.