Extole Report Schedules 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 Schedules. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
17 operations
across 14 paths,
and defines 42 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 operations14 paths42 schemas2 DELETE10 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 Report Schedules 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 — 2 DELETE, 10 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ReportRunnerResponseBase (23 properties), ReportRunnerUpdateRequestBase (17 properties), ReportRunnerCreateRequestBase (17 properties), ReportRunnerViewResponseBase (16 properties). Each schema is shown below with its type and property counts.
Choose between static or dynamic sftp report name pattern
ReportRunnerResponse
23 required
ReportResponse
object
8 properties8 required
ReportRunnerUpdateRequest
Body of a PUT /v7/report-runners/{reportRunnerId} request.
1 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 properties5 required
ScheduledReportRunnerUpdateRequest
object
1 required
NewEntriesOnlyReportRunnerReportResponse
object
22 required
ComponentReferenceResponse
object
2 properties
ScheduledReportRunnerResponse
object
26 required
ReportNamePatternInReportRunnerResponseBase
The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
ComponentReferenceRequest
object
2 properties
BaseReportRunnerReportResponse
7 required
ReportRunnerViewResponseBase
object
16 properties
ScheduledReportRunnerViewResponse
object
19 required
RefreshingReportRunnerViewResponse
object
17 required
MergingConfigurationResponse
object
4 properties
MergingConfigurationRequest
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
