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

The Report Schedules API from Extole — 14 operation(s) for report schedules.

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.2.0, at version 1.0.

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

17 operations 14 paths 42 schemas 2 DELETE10 GET4 POST1 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 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.

Report Schedules 17
GET
/v6/report-runners-tags
List report runner tags
listReportRunnerTags 2 params → 200400401402403415429
GET
/v6/report-runners/views/detailed
Gets a filtered list of report runner views
getReportRunners 16 params → 200400401402403415429
GET
/v6/report-runners/{reportRunnerId}/accumulating-reports
Gets a list of accumulating reports
getAccumulatingReports 4 params → 200400401402403415429
GET
/v6/report-runners/{reportRunnerId}/latest
Get the latest report for a report runner
getLatestReportForRunner 1 param → 200400401402403415429
GET
/v6/report-runners/{reportRunnerId}/latest/download{format}
Download the latest report for a report runner
downloadLatestReportForRunner 6 params → 200400401402403415429
GET
/v6/report-runners/{reportRunnerId}/reports
Gets a filtered list of reports executed by the report runner.Results are sorted by schedule date in descending order.
getReports 5 params → 200400401402403415429
GET
/v6/report-runners/{reportRunnerId}/views/detailed
Get report runner view for the specified id.
getReportRunner 1 param → 200400401402403415429
POST
/v6/report-runners/scheduled/{reportRunnerId}/generate-missing-reports
Generate missing reports for a scheduled report runner
generateMissingReports 3 params → 200400401402403415429
POST
/v6/report-runners/{reportRunnerId}/run
Execute report runner for the specified id. Will return existing report if there is any currently in progress or generate a new one otherwise.
run_2 1 param body → 200400401402403415429
DELETE
/v6/report-runners/scheduled/{reportRunnerId}/reports
Delete reports belonging to the specified report runner id
deleteReports 2 params → 200400401402403415429
GET
/v7/report-runners
List report runners
listReportRunners 16 params → 200400401402403415429
POST
/v7/report-runners
Create a report runner
createReportRunner body → 200400401402403415429
GET
/v7/report-runners/template
List report runner templates
listReportRunnerTemplates → 200400401402403415429
GET
/v7/report-runners/{reportRunnerId}
Get a report runner
getReportRunner 1 param → 200400401402403404415429
PUT
/v7/report-runners/{reportRunnerId}
Update a report runner
updateReportRunner 1 param body → 200400401402403404415429
DELETE
/v7/report-runners/{reportRunnerId}
Delete a report runner
deleteReportRunner 1 param → 200400401402403404415429
POST
/v7/report-runners/{reportRunnerId}/duplicate
Duplicate a report runner
duplicateReportRunner 2 params body → 200400401402403404415429

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ReportRunnerResponseBase (23 properties), ReportRunnerCreateRequestBase (17 properties), ReportRunnerUpdateRequestBase (17 properties), ReportRunnerViewResponseBase (16 properties). Each schema is shown below with its type and property counts.

ReportRunnerViewResponse
16 required
RefreshingReportRunnerResponse
object
24 required
ReportRunnerResponse
23 required
PauseInfoRequest
object
2 properties
ReportRunnerCreateRequestBase
object
17 properties
ReportRunnerUpdateRequest
Body of a PUT /v7/report-runners/{reportRunnerId} request.
1 required
IndividualReportRunnerReportResponse
object
22 required
SftpReportNamePatternInReportRunnerResponseBase
The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
PauseInfoResponse
object
3 properties
ReportNamePatternInReportRunnerCreateRequestBase
Choose between static or dynamic report name pattern
ReportResponse
object
8 properties 8 required
MergingConfigurationRequest
object
4 properties
ComponentReferenceResponse
object
2 properties
NotExecutedReportRunnerReportResponse
object
7 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…
ReportParameterTypeResponse
object
3 properties
RefreshingReportRunnerUpdateRequest
object
1 required
ComponentReferenceRequest
object
2 properties
ReportRunnerViewResponseBase
object
16 properties
BaseReportRunnerReportResponse
7 required
RefreshingReportRunnerCreateRequest
object
3 required
ScheduledReportRunnerViewResponse
object
19 required
ReportNamePatternInReportRunnerResponseBase
The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
ReportParameterDetailsResponse
object
6 properties
ReportRunnerUpdateRequestBase
object
17 properties
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
ReportRunnerCreateRequest
Body of a POST /v7/report-runners request.
3 required
ReportNamePatternInReportRunnerUpdateRequestBase
Choose between static or dynamic report name pattern
Instant
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) UTC date-time with a Z suffix. Precision up to milliseconds.
BaseReportRunnerReportResponseBase
object
7 properties
RefreshingReportRunnerViewResponse
object
17 required
ReportRunnerResponseBase
object
23 properties
ReportRunnerSlotsRequest
object
1 property 1 required
SftpReportNamePatternInReportRunnerCreateRequestBase
Choose between static or dynamic sftp report name pattern
ScheduledReportRunnerResponse
object
26 required
NewEntriesOnlyReportRunnerReportResponse
object
22 required
SftpReportNamePatternInReportRunnerUpdateRequestBase
Choose between static or dynamic sftp report name pattern
MergingConfigurationResponse
object
4 properties
ReportParameterResponse
object
2 properties
AccumulatingReportRunnerReportResponse
object
22 required
ScheduledReportRunnerUpdateRequest
object
1 required
ScheduledReportRunnerCreateRequest
object
4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-report-schedules-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 Schedules 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.