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 Reports API

The Reports API from Extole — 14 operation(s) for reports.

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

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

This API exposes 17 operations across 14 paths, and defines 15 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.

17 operations 14 paths 15 schemas 1 DELETE11 GET4 POST1 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 Reports 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 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 11 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Reports 17
GET
/v4/reports
List reports
listReports 14 params → 200400401402403415429
POST
/v4/reports
Create a report
createReport body → 200400401402403415429
GET
/v4/reports-tags
List report tags
listReportTags 2 params → 200400401402403415429
GET
/v4/reports/latest
Get the latest report
getLatestReport 6 params → 200400401402403415429
GET
/v4/reports/latest/download{format}
Download the latest report
downloadLatestReport 11 params → 200400401402403415429
GET
/v4/reports/recommendations
List report recommendations
listReportRecommendations 2 params → 200400401402403415429
GET
/v4/reports/{reportId}
Get a report
getReport 1 param → 200400401402403415429
PUT
/v4/reports/{reportId}
Update a report
updateReport 1 param body → 200400401402403415429
DELETE
/v4/reports/{reportId}
Delete a report
deleteReport 1 param → 200400401402403415429
GET
/v4/reports/{reportId}/debug
Get report debug info
getReportDebug 1 param → 200400401402403415429
GET
/v4/reports/{reportId}/download{format}
Download a report
downloadReport 6 params → 200400401402403415429
GET
/v4/reports/{reportId}/info
Get report info
getReportInfo 1 param → 200400401402403415429
GET
/v4/reports/{reportId}/info/{format}
Get report format info
getReportInfoByFormat 2 params → 200400401402403415429
GET
/v4/reports/{reportId}/views/public
Get public view of a report
getPublicReportView 1 param → 200400401402403415429
POST
/v4/reports/{reportId}/cancel
Cancel a report
cancelReport 1 param → 200400401402403415429
POST
/v4/reports/{reportId}/retry
Retry a report
retryReport 1 param → 200400401402403415429
POST
/v4/reports/{reportId}/sharedToken
Create a shared token for a report
createReportSharedToken 1 param body → 200400401402403415429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PublicReportResponse (12 properties), CreateReportRequest (11 properties), ReportResponse (8 properties), ReportParameterDetailsResponse (6 properties). Each schema is shown below with its type and property counts.

ReportSharedTokenCreateRequest
object
Body of a POST /v4/reports/{reportId}/sharedToken request.
1 property
ReportSharedTokenResponse
object
2 properties 2 required
ReportParameterDetailsResponse
object
6 properties
FormatReportInfoResponse
object
2 properties 2 required
UpdateReportRequest
object
4 properties
ReportInfoResponse
object
1 property 1 required
CreateReportRequest
object
11 properties 11 required
ReportDebugResponse
object
5 properties 5 required
PublicReportResponse
object
12 properties 12 required
ReportParameterResponse
object
2 properties
ReportResponse
object
8 properties 8 required
ReportParameterTypeResponse
object
3 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…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
PublicReportResultResponse
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-reports-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