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

print_mail.reports.exports.retrieve(strexport_id, ExportRetrieveParams**kwargs) -> ReportExport

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.

ParametersExpand Collapse

report_id: str

export_id: str

ReturnsExpand Collapse

class ReportExport: …

Represents a report export job and its results.

id: str

Unique identifier for the report export.

created_at: datetime

Timestamp when the export was created.

formatdate-time

live: bool

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

object: Literal["report_export"]

Always report_export.

report: Report

Details of the report this export was generated from.

id: str

The ID of the report.

sql_query: str

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

updated_at: datetime

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

formatdate-time

description: Optional[str]

An optional user-friendly description for the export.

failure_message: Optional[str]

If export generation failed, this contains the error message.

metadata: Optional[Dict[str, str]]

Optional key-value metadata associated with the export.

output_url: Optional[str]

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

formaturi

params: Optional[List[str]]

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

row_count: Optional[int]

The number of rows in the exported data.

formatint64

size_in_bytes: Optional[int]

The size of the generated export file in bytes.

formatint64

truncated_to_bytes: Optional[int]

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

formatint64

Get Report Export

Python

HTTP

TypeScript

Python

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
report_export = client.print_mail.reports.exports.retrieve(
    export_id="exportID",
    report_id="reportID",
)
print(report_export.id)

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"
}