Event

Submit a conversion

get

Track an event with necessary parameters and enqueue it for processing.

Query parameters
access_tokenstringRequired

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 [email protected]

event_namestringRequired

Name of the event to track, i.e. purchase

test_idintegerRequired

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.

variation_idintegerRequired

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

vidstringRequired

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()

analytics_idstringOptional

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 window.FIGPII.settings.analyticsId

analytics_regionstringOptional

The region of the analytics (default is EU)

revenuenumber · floatOptional

The revenue value for the event

event_urlstringOptional

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

Responses
200

Event successfully tracked

application/json
get
/event
GET /event?access_token=text&event_name=text&test_id=1&variation_id=1&vid=text HTTP/1.1
Host: analytics-api.figpii.com
Accept: */*
{
  "status": "success"
}

Was this helpful?