Reports

Sample a Saved Report

Changed on

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

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/reports/{id}/samples
  • Auth
    API key in header X-API-Key

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.

Changes

  • c8fedcbd705eRevision changes
    • warning

      added the new internal_server_error enum value to the / response property for the response status

    • warning

      added the new not_found_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded_error enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status