Sign in

v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB
Reports

Sample a Saved Report

Run the query associated with a saved report and get a sample of the results. This allows getting up to 1000 rows of resutls but the runtime of the query is limited to 30 seconds. If you need more rows or longer runtime, you should create an export from this report.

post/print-mail/v1/reports/{id}/samples

Path parameters

idstring required

The ID of the saved report to sample.

Request body

paramsstring[]

Optional parameters to bind to the SQL query (e.g., for placeholders like ? or $1).

limitinteger

Maximum number of rows to return in the sample.

Response

A sample of the query results for the specified report.

idstring required

Unique identifier for the sample query result.

reportstring nullable required

The ID of the report this sample was generated from, or null for ad-hoc samples.

recordsReportRecord[] required

The actual data records returned by the sample query.