Trackers

List Tracker Visits

Changed on

Retrieve a paginated list of visits for a Tracker.

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

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/trackers/{id}/visits
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

The ID of the Tracker whose visits should be listed.

Query parameters

skipinteger
limitinteger
string
OR
string

You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource.

For example, let's say you created a series of letters that all had metadata: { campaignID: 'abc' }. You could search for all those letters by passing in { "metadata.campaignID": "abc" } into the search parameter.

Note that this string must be valid JSON.

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.

Response

A list object containing Tracker Visits.

object'list' required
totalCountinteger required
skipinteger required
limitinteger required

Changes