POpostgrid
Reports

Retrieve Saved Report

Retrieve the details of a specific saved report by its ID.

get/print-mail/v1/reports/{id}

Request

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

Path parameters

idstring required

The ID of the report to retrieve.

Response

The requested Report object.

idstring required

Unique identifier for the report.

object'report' required

Always report.

liveboolean required

Indicates if the report is associated with the live or test environment.

sqlQuerystring required

The SQL query defining the report.

descriptionstring

An optional user-friendly description for the report.

metadataobject

Optional key-value metadata associated with the report.

createdAtstring date-time required

Timestamp when the report was created.

updatedAtstring date-time required

Timestamp when the report was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.