API Reference

Print Mail

Reports

Exports

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Report Export

GET/print-mail/v1/reports/{reportID}/exports/{exportID}

Retrieve the status and details of a specific report export job. Check the outputURL property for the download link once generation is complete.

Path ParametersExpand Collapse

reportID: string

exportID: string

ReturnsExpand Collapse

ReportExport = object { id, createdAt, live, 11 more }

Represents a report export job and its results.

id: string

Unique identifier for the report export.

createdAt: string

Timestamp when the export was created.

formatdate-time

live: boolean

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

object: "report_export"

Always report_export.

report: object { id, sqlQuery }

Details of the report this export was generated from.

id: string

The ID of the report.

sqlQuery: string

The SQL query used for this export (snapshotted at creation time).

updatedAt: string

Timestamp when the export was last updated (e.g., finished generation).

formatdate-time

description: optional string

An optional user-friendly description for the export.

failureMessage: optional string

If export generation failed, this contains the error message.

metadata: optional map[string]

Optional key-value metadata associated with the export.

outputURL: optional string

A signed URL to download the exported data (CSV format). Available when generation is complete and successful.

formaturi

params: optional array of string

Optional parameters to bind to the SQL query of the associated report.

rowCount: optional number

The number of rows in the exported data.

formatint64

sizeInBytes: optional number

The size of the generated export file in bytes.

formatint64

truncatedToBytes: optional number

If the output was truncated, indicates the byte limit reached.

formatint64

Get Report Export

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/reports/$REPORT_ID/exports/$EXPORT_ID \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

200 example

{
  "id": "report_export_123",
  "object": "report_export",
  "live": false,
  "report": {
    "id": "report_123",
    "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?"
  },
  "params": [
    "2023-10-01T00:00:00Z"
  ],
  "description": "October Orders Export",
  "outputURL": "https://s3.amazonaws.com/...",
  "sizeInBytes": 1024,
  "rowCount": 50,
  "createdAt": "2023-10-27T11:00:00Z",
  "updatedAt": "2023-10-27T11:05:00Z"
}

Returns Examples

200 example

{
  "id": "report_export_123",
  "object": "report_export",
  "live": false,
  "report": {
    "id": "report_123",
    "sqlQuery": "SELECT id, status FROM orders WHERE created_at > ?"
  },
  "params": [
    "2023-10-01T00:00:00Z"
  ],
  "description": "October Orders Export",
  "outputURL": "https://s3.amazonaws.com/...",
  "sizeInBytes": 1024,
  "rowCount": 50,
  "createdAt": "2023-10-27T11:00:00Z",
  "updatedAt": "2023-10-27T11:05:00Z"
}