API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Reports

The reports API lets you run SQL queries against a data lake with all of your PostGrid data. You can use this to run ad-hoc SQL queries or save them as reports. You can bulk export data from these reports to fit all of your reporting needs. Note that the data this API provides may be up to 2 hours behind your current PostGrid environment. Your test and live data lakes are fully segregated, so you'll need a live API key to run queries against your live data.

You can request access to this to this feature by reaching out to [email protected]

Create Saved Report

print_mail.reports.create(ReportCreateParams**kwargs) -> Report

POST/print-mail/v1/reports

Run Ad-hoc Query

print_mail.reports.sample(ReportSampleParams**kwargs) -> ReportSample

POST/print-mail/v1/reports/samples

Update Report

print_mail.reports.update(strid, ReportUpdateParams**kwargs) -> Report

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

List Saved Reports

print_mail.reports.list(ReportListParams**kwargs) -> SyncSkipLimit[Report]

GET/print-mail/v1/reports

Retrieve Saved Report

print_mail.reports.retrieve(strid) -> Report

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

Delete Saved Report

print_mail.reports.delete(strid) -> DeletedResponse

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

ModelsExpand Collapse

class DeletedResponse: …

Generic response for delete operations.

id: str

The ID of the deleted resource.

deleted: Literal[true]

Indicates the resource was successfully deleted.

class Report: …

Represents a saved Report definition.

id: str

Unique identifier for the report.

created_at: datetime

Timestamp when the report was created.

formatdate-time

live: bool

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

object: Literal["report"]

Always report.

sql_query: str

The SQL query defining the report.

updated_at: datetime

Timestamp when the report was last updated.

formatdate-time

description: Optional[str]

An optional user-friendly description for the report.

metadata: Optional[Dict[str, str]]

Optional key-value metadata associated with the report.

ReportsSamples

The reports API lets you run SQL queries against a data lake with all of your PostGrid data. You can use this to run ad-hoc SQL queries or save them as reports. You can bulk export data from these reports to fit all of your reporting needs. Note that the data this API provides may be up to 2 hours behind your current PostGrid environment. Your test and live data lakes are fully segregated, so you'll need a live API key to run queries against your live data.

You can request access to this to this feature by reaching out to [email protected]

Sample a Saved Report

print_mail.reports.samples.create(strid, SampleCreateParams**kwargs) -> ReportSample

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

ModelsExpand Collapse

class ReportSample: …

Represents the result of a report sample query.

id: str

Unique identifier for the sample query result.

records: List[Dict[str, object]]

The actual data records returned by the sample query.

report: Optional[str]

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

class ReportSampleCreateBase: …

Base properties for creating a report sample.

limit: Optional[int]

Maximum number of rows to return in the sample.

formatint32

maximum1000

params: Optional[List[str]]

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

ReportsExports

The reports API lets you run SQL queries against a data lake with all of your PostGrid data. You can use this to run ad-hoc SQL queries or save them as reports. You can bulk export data from these reports to fit all of your reporting needs. Note that the data this API provides may be up to 2 hours behind your current PostGrid environment. Your test and live data lakes are fully segregated, so you'll need a live API key to run queries against your live data.

You can request access to this to this feature by reaching out to [email protected]

Create a Report Export

print_mail.reports.exports.create(strreport_id, ExportCreateParams**kwargs) -> ReportExport

POST/print-mail/v1/reports/{reportID}/exports

Get Report Export

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

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

Delete Report Export

print_mail.reports.exports.delete(strexport_id, ExportDeleteParams**kwargs) -> DeletedResponse

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

ModelsExpand 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