Report

Manage and run reports.

📄️Download a report as CSV

Runs a saved report and returns its results as a CSV file named Report.csv.

📄️Download a report as PDF

Runs a saved report and returns its results as a PDF file named Report.pdf.

📄️Get your subscription to a report

Returns the calling user's subscription to a report, including the ID of the delivery schedule and whether the CSV and PDF files are sent. Use it to show or edit the user's current subscription.

📄️Run a report

Runs a saved report and returns its results as a table. The body sets paging, sorting and text filtering for the returned rows.

📄️List reports and report folders

Returns the folders and reports available to the calling user, including which reports the user has marked as favorites. Use it to build a report browser.

📄️Update a report subscription

Replaces the stored settings of an existing report subscription, such as whether the CSV and PDF files are sent. Send the full subscription as returned by the get subscription route, because omitted fields are reset.

📄️Get a report

Returns the saved definition of one report: its name, data source, time range and filter conditions.