Offline Tracking API

What will you be able to do with our Offline Tracking API?

This API can be used to send offline or server-side conversion data to FigPii. Use cases include tracking lead submissions or deal closures, server-side tracking for E-Commerce purchases, etc. 

Note: To receive access to the Offline Tracking Endpoint reach out to the FigPii support team. 

Identifying yourself (Auth Token)

Any requests missing an authentication token will be discarded and not tracked! Tokens are available on Large packages and can be generated by contacting our support team or emailing support@figpii.com

Example of a FigPii Offline Tracking Token:

347614:1725390897:5c203e0c66f14868fded53d5eb660908

Identifying your visitors (Unique Visitor ID)

Each visitor needs a unique ID we can refer to. You need to collect the FigPii Unique Visitor ID generated by our front-end tracker through our window API by calling  FIGPII.clientInfo.getVisitorId()

Example of a FigPii Visitor ID:

gO1E6fHubt8j7JZvFdY

Identifying the experiment (Experiment ID)

Each A/B Test has a unique visitor ID, refer to our guide for constructing experiment_strings for server-side tracking purposes on how to retrieve and store this data.

Example of a FigPii Experiment ID:

314897

Identifying the variation (Variation ID)

Each Experiment ID will be paired with a variation ID, i.e. which variation of the Experiment did the visitor receive.

Example of a FigPii Variation ID:

49876

Event URL 

If the request happened on a webpage, include the encoded URI as event_url. 

The event name and optional value 

If no value is attached to the conversion, simply do not include a "revenue" parameter.

Analytics Id and Analytics Region 

Refer to our guide for constructing experiment_strings for server-side tracking purposes on how to retrieve your analytics ID. Your Analytics region is selected by you at the time of your registration. The default is EU (GDPR Compliant), and US is available as an option.

Analytics ID can also be retrieved through our window API:  FIGPII.settings.analyticsId

Making the request 

* required

Make a GET request to the endpoint provided by the FigPii support team at the time of conversion or at regular intervals. Add all the available parameters as query parameters. If any of the required parameters are missing your request will fail. If you request is a success you will receive a success message from the request.

Example of a successful request:

Request:
curl -i "https://private.figpii.com/?event_name=purchase&analytics_id=22&test_id=343041&variation_id=44309&event_url=https%3A%2F%2Fwww.figpii.com%2F&uid=9ncWAcHurQdknGUvXfw&revenue=148"

Response Headers:
HTTP/2 200 
date: Tue, 03 Sep 2024 19:33:28 GMT
content-type: application/json; charset=UTF-8

Response Body:
{"status":"success"}

Example of a failed request:

Request:
curl -i "https://private.figpii.com/?event_name=purchase&test_id=343041&variation_id=44309&event_url=https%3A%2F%2Fwww.figpii.com%2F&uid=9ncWAcHurQdknGUvXfw&revenue=148"

Response Headers:
HTTP/2 400 
date: Tue, 03 Sep 2024 19:33:28 GMT
content-type: application/json; charset=UTF-8

Response Body:
{"status":"missing analytics_id parameter, please refer to https://kb.figpii.com/article/301-offline-tracking-api"}