Create a Report Schedule
Creates a new report schedule for generating various types of reports.
It requires the reportSchedules:Create permission in the API key.
Please check our detailed reporting guide including best practices integration and other considerations here.
The date range for the report is based on the trigger configuration and uses the standard UTC format for all times and timestamps. However, to ensure completeness, the report schedule may execute with a slight delay. This delay allows the system to capture any last-minute records and ensure accurate and comprehensive data.
Once the report schedule is executed, a new report will be created, and can be retrieved by calling the List Reports or Get Report endpoint.
To be notified of the creation of these reports, you can subscribe to the reports events using the eventSource https://silverflow.com/reports on POST /v1/eventSubscriptions.
When a scheduled report is completed, if it has one of more related distribution objects, it will trigger the distribution to the specified targets.
Request
- Base URLhttps://eu-west-1.api.silverflow.com/v1
- Auth
- HTTP basic
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"distributions": [
"dst-1e1dAHhgstYTUhlphPzZ"
]
}Response
The newly created report schedule object
Example response
{
"key": "rsk-1e1dAHhgstYTUhlphPzZ",
"agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
"distributions": [
"dst-1e1dAHhgstYTUhlphPzZ"
]
}Changes
No recorded changes to this operation across all 1 revision of this API.