Skip to navigation
API ReferenceScheduled Reports

Read Scheduled Report

Deprecated
Available by Request

Info for a specific scheduledReport

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

scheduledReportIdstringRequired
The id of the scheduled report

Query parameters

formatenumOptional

format of the download. Providing this here changes the Content-Dispostion head to invoke a download

Allowed values:

Response

Expected response to a valid request
startdatetime
enddatetime
filterstringOptional
fieldsstringOptional
sortstringOptional
requestedBystringOptional
reportIdstringOptional
emailAddressesstringOptional
frequencystringOptional
idstringOptionalformat: "uuid"
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
organizationIdstringOptionalformat: "uuid"
organizationobjectOptional