Skip to content

Create Tracker

print_mail.trackers.create() -> TrackerCreateResponse

POST/print-mail/v1/trackers

Create a Tracker.

ParametersExpand Collapse

redirect_url_template: str

The base template for URLs generated by this Tracker.

url_expire_after_days: Literal[30, 60, 90, 2 more]

The number of days generated Tracker URLs remain valid.

One of the following:

30

60

90

180

365

description: Optional[str]

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

metadata: Optional[Dict[str, object]]

See the section on Metadata.

ReturnsExpand Collapse

class TrackerCreateResponse: …

id: str

A unique ID prefixed with tracker_

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

live: bool

true if this is a live mode resource else false.

object: Literal["tracker"]

Always tracker.

redirect_url_template: str

The base template for URLs generated by this Tracker.

unique_visit_count: int

The unique number of interactions the Tracker has had.

formatint32

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

url_expire_after_days: Literal[30, 60, 90, 2 more]

The number of days generated Tracker URLs remain valid.

One of the following:

30

60

90

180

365

visit_count: int

The total number of interactions the Tracker has had.

formatint32

description: Optional[str]

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

metadata: Optional[Dict[str, object]]

See the section on Metadata.

Create Tracker

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
)
tracker = client.print_mail.trackers.create(
    redirect_url_template="https://postgrid.com?name={{to.firstName}}",
    url_expire_after_days=30,
)
print(tracker.id)

{
  "id": "tracker_123456789abcdefghijklmnopqrstuvwxyz",
  "object": "tracker",
  "live": false,
  "redirectURLTemplate": "https://postgrid.com?name={{to.firstName}}",
  "urlExpireAfterDays": 30,
  "visitCount": 0,
  "uniqueVisitCount": 0,
  "createdAt": "2020-11-12T23:30:12.581Z",
  "updatedAt": "2020-11-12T23:30:12.581Z"
}

Returns Examples

{
  "id": "tracker_123456789abcdefghijklmnopqrstuvwxyz",
  "object": "tracker",
  "live": false,
  "redirectURLTemplate": "https://postgrid.com?name={{to.firstName}}",
  "urlExpireAfterDays": 30,
  "visitCount": 0,
  "uniqueVisitCount": 0,
  "createdAt": "2020-11-12T23:30:12.581Z",
  "updatedAt": "2020-11-12T23:30:12.581Z"
}