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

POST/print-mail/v1/reports

Run Ad-hoc Query

POST/print-mail/v1/reports/samples

Update Report

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

List Saved Reports

GET/print-mail/v1/reports

Retrieve Saved Report

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

Delete Saved Report

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

ModelsExpand Collapse

DeletedResponse = object { id, deleted }

Generic response for delete operations.

id: string

The ID of the deleted resource.

deleted: true

Indicates the resource was successfully deleted.

Report = object { id, createdAt, live, 5 more }

Represents a saved Report definition.

id: string

Unique identifier for the report.

createdAt: string

Timestamp when the report was created.

formatdate-time

live: boolean

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

object: "report"

Always report.

sqlQuery: string

The SQL query defining the report.

updatedAt: string

Timestamp when the report was last updated.

formatdate-time

description: optional string

An optional user-friendly description for the report.

metadata: optional map[string]

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

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

ModelsExpand Collapse

ReportSample = object { id, records, report }

Represents the result of a report sample query.

id: string

Unique identifier for the sample query result.

records: array of map[unknown]

The actual data records returned by the sample query.

report: string

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

ReportSampleCreateBase = object { limit, params }

Base properties for creating a report sample.

limit: optional number

Maximum number of rows to return in the sample.

formatint32

maximum1000

params: optional array of string

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

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

Get Report Export

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

Delete Report Export

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

ModelsExpand 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