Report Schedules
List report runners
Returns report runners for the calling client, filtered and ordered by the supplied query parameters. Report runners are scheduled report execution definitions that run a report type on a recurring schedule and deliver output to a configured destination (e.g. SFTP). Use GET /v7/report-runners/template to retrieve the available runner templates.
get/v7/report-runners
Request
- Base URLhttps://api.extole.io
- Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
typestring
report_typestring
display_namestring
user_idsstring[]
having_any_tagsstring
having_all_tagsstring
exclude_having_any_tagsstring
exclude_having_all_tagsstring
search_querystring
pause_statusstring
aggregation_statusstring
offsetstring
limitstring
order_bystring
orderstring
report_type_namestring
Response
Successful response
Example response
[
{
"created_date": "2025-10-24T02:00:00-07:00",
"pause_info": {
"updated_date": "2025-10-24T09:00:00.000Z"
},
"paused": {
"updated_date": "2025-10-24T09:00:00.000Z"
},
"report_name_pattern": "handlebars@runtime:{{reportNamePattern}}",
"sftp_report_name_pattern": "handlebars@runtime:{{sftpReportNamePattern}}",
"updated_date": "2025-10-24T02:00:00-07:00"
}
]Changes
No recorded changes to this operation across all 1 revision of this API.