What a Tracking Page Does
A tracking page in Perform.AI is a hosted, customer-facing experience that surfaces shipment data in real time. When you link a shipment to a tracking page, your customers get access to:- Live shipment status and events — up-to-date tracking milestones pulled directly from the carrier and enriched with any custom events you’ve added.
- Estimated delivery dates (ETAs) — powered by Perform.AI’s predictive engine.
- Your brand design — the page uses the colors, logo, and layout configured for that tracking experience in your Perform.AI account.
The tracking_page_reference Field
You link a shipment to a specific tracking experience using the tracking_page_reference field. You can include this field when you create or update a shipment. The value must match the reference string configured for a tracking experience in your Perform.AI account.
The tracking page reference is configured in your Perform.AI account.
Contact your Customer Success team to set up a tracking experience and obtain
the correct reference string to use here.
Adding a Tracking Page Reference to a Shipment
Includetracking_page_reference in your shipment create or update payload:
"your-reference-here" with the reference string for the tracking experience you want to use.
Effect of Linking a Tracking Page
Once you link a shipment to a tracking page:- Notification branding — all notification emails and SMS messages generated for that shipment adopt the design and content configuration from the linked tracking experience.
- Tracking links — any tracking link included in a notification email opens that specific tracking page, showing the customer a branded, real-time view of their shipment.
- Dashboard visibility — the
tracking_page_referencevalue appears in the Parcel Overview and Parcel Details in the Perform.AI portal, making it easy to filter and report on shipments by tracking experience.
tracking_page_reference is optional, but strongly recommended for any
customer-facing shipment. Linking a tracking page ensures your customers
always land on a consistent, branded experience rather than a generic carrier
page.Updating the Tracking Page Reference
You can change or add atracking_page_reference at any time by including the field in an update request for the shipment. The new value will overwrite the previously linked tracking experience for that shipment.