List Tracker Visits

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

Retrieve a paginated list of visits for a Tracker.

Path ParametersExpand Collapse

id: string

Query ParametersExpand Collapse

limit: optional number

formatint32

search: optional string

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

skip: optional number

formatint32

ReturnsExpand Collapse

data: array of 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

limit: number

formatint32

object: "list"

skip: number

formatint32

totalCount: number

formatint32

List Tracker Visits

curl https://api.postgrid.com/print-mail/v1/trackers/$ID/visits \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "tracker_visit_123456789abcdefghijklmnopqrstuvwxyz",
      "object": "tracker_visit",
      "live": false,
      "tracker": "tracker_123456789abcdefghijklmnopqrstuvwxyz",
      "orderID": "order_123456789abcdefghijklmnopqrstuvwxyz",
      "device": "Device Unknown",
      "ipAddress": "Unknown IP Address",
      "createdAt": "2020-11-12T23:30:12.581Z",
      "updatedAt": "2020-11-12T23:31:12.581Z"
    }
  ]
}

Returns Examples

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "tracker_visit_123456789abcdefghijklmnopqrstuvwxyz",
      "object": "tracker_visit",
      "live": false,
      "tracker": "tracker_123456789abcdefghijklmnopqrstuvwxyz",
      "orderID": "order_123456789abcdefghijklmnopqrstuvwxyz",
      "device": "Device Unknown",
      "ipAddress": "Unknown IP Address",
      "createdAt": "2020-11-12T23:30:12.581Z",
      "updatedAt": "2020-11-12T23:31:12.581Z"
    }
  ]
}