Create and manage Trackers.
Trackers can be used to track interactions in your orders through personalized URLs and QR codes.
| Name | Type | Description |
|---|
| id | string | A unique ID prefixed with tracker_ |
| object | string | The object of the response, always tracker |
| description | string (Optional) | A description of the Tracker |
| live | boolean | Indicates if the Tracker is live |
| redirectURLTemplate | string | The base template for URLs generated by this Tracker |
| urlExpireAfterDays | 30, 60, 90 | Indicates the number of days a Tracker's generated URLs will remain valid after its creation |
| visitCount | number | The total number of interactions the Tracker has had |
| uniqueVisitCount | number | The unique number of interactions the Tracker has had |
| metadata | object (Optional) | Metadata for the Tracker |
| createdAt | Date | The creation date of the Tracker |
| updatedAt | Date | The date at which the Tracker was last updated |
| Name | Type | Description |
|---|
| id | string | A unique ID prefixed with tracker_visit_ |
| object | string | The object of the response, always tracker_visit |
| tracker | string | The ID of the tracker related to this visit |
| live | boolean | Indicates if the visit was used in a live order or not |
| orderID | string | The ID of the order where the interaction occurred |
| device | string | The type of device associated the visit |
| ipAddress | string | The IP address associated with the visit |
| createdAt | Date | The creation date of the Tracker Visit |
| updatedAt | Date | The date at which the Tracker Visit was last updated |
