API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Trackers

Create and manage Trackers.

Trackers can be used to track interactions in your orders through personalized URLs and QR codes.

As a brief introduction to using Trackers in your orders, a QR code can be generated by using the Tracker’s ID as a merge variable in your orders HTML and Templates. The following example HTML uses Trackers to generate personalized URLs (PURLs) in your orders.

See the following guide for more details: https://postgrid.readme.io/reference/trackers-1

Create Tracker

POST/print-mail/v1/trackers

List Trackers

GET/print-mail/v1/trackers

Update Tracker

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

Get Tracker

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

Delete Tracker

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

List Tracker Visits

GET/print-mail/v1/trackers/{id}/visits

ModelsExpand Collapse

TrackerCreateResponse object { id, createdAt, live, 8 more }

id: string

A unique ID prefixed with tracker_

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "tracker"

Always tracker.

redirectURLTemplate: string

The base template for URLs generated by this Tracker.

uniqueVisitCount: number

The unique number of interactions the Tracker has had.

formatint32

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

urlExpireAfterDays: 30 or 60 or 90 or 2 more

The number of days generated Tracker URLs remain valid.

One of the following:

30

60

90

180

365

visitCount: number

The total number of interactions the Tracker has had.

formatint32

description: optional string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata: optional map[unknown]

See the section on Metadata.

TrackerListResponse object { id, createdAt, live, 8 more }

id: string

A unique ID prefixed with tracker_

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "tracker"

Always tracker.

redirectURLTemplate: string

The base template for URLs generated by this Tracker.

uniqueVisitCount: number

The unique number of interactions the Tracker has had.

formatint32

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

urlExpireAfterDays: 30 or 60 or 90 or 2 more

The number of days generated Tracker URLs remain valid.

One of the following:

30

60

90

180

365

visitCount: number

The total number of interactions the Tracker has had.

formatint32

description: optional string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata: optional map[unknown]

See the section on Metadata.

TrackerUpdateResponse object { id, createdAt, live, 8 more }

id: string

A unique ID prefixed with tracker_

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "tracker"

Always tracker.

redirectURLTemplate: string

The base template for URLs generated by this Tracker.

uniqueVisitCount: number

The unique number of interactions the Tracker has had.

formatint32

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

urlExpireAfterDays: 30 or 60 or 90 or 2 more

The number of days generated Tracker URLs remain valid.

One of the following:

30

60

90

180

365

visitCount: number

The total number of interactions the Tracker has had.

formatint32

description: optional string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata: optional map[unknown]

See the section on Metadata.

TrackerRetrieveResponse object { id, createdAt, live, 8 more }

id: string

A unique ID prefixed with tracker_

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "tracker"

Always tracker.

redirectURLTemplate: string

The base template for URLs generated by this Tracker.

uniqueVisitCount: number

The unique number of interactions the Tracker has had.

formatint32

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

urlExpireAfterDays: 30 or 60 or 90 or 2 more

The number of days generated Tracker URLs remain valid.

One of the following:

30

60

90

180

365

visitCount: number

The total number of interactions the Tracker has had.

formatint32

description: optional string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata: optional map[unknown]

See the section on Metadata.

TrackerDeleteResponse object { id, deleted, object }

id: string

A unique ID prefixed with tracker_

deleted: true

object: "tracker"

Always tracker.

TrackerRetrieveVisitsResponse object { id, createdAt, device, 6 more }

id: string

A unique ID prefixed with tracker_visit_.

createdAt: string

The UTC time at which this visit was created.

formatdate-time

device: string

The type of device associated with the visit.

ipAddress: string

The IP address associated with the visit.

live: boolean

Indicates if the visit was used in a live order or not.

object: "tracker_visit"

Always tracker_visit.

orderID: string

The ID of the order where the interaction occurred.

tracker: string

The ID of the tracker related to this visit.

updatedAt: string

The UTC time at which this visit was last updated.

formatdate-time