Intro
This API is designed to collect job views and conversions (apply start & finish) of traffic generated via jobiqo AIR.
The jobiqo AIR Tracking API works with simple POST requests and can be called client- (e.g. Javascript) and server-side (e.g. in backend application). As the tracking service does not require any information of the website visitor, such as the IP address, a server side implementation is recommended in regards to data privacy, but both implementations are possible and fully GDPR compliant.
Events
The API currently supports following events:
- Job View: the user lands on the job landing page
- Job Apply Start: the user clicks the “Apply” button
- Job Apply Finish (optional): the user finishes an application
Additional events can be set up on demand.
Jobiqo AIR URLs
Any traffic generated from jobiqo AIR can be identified via GET parameters in the URL on the job detail page. Such URLs usually look like e.g.:
https://example.com/job-20725?aw_campaign_id=023d1fa2-e9f&utm_campaign=jobiqo-air&utm_source=Talent&utm_medium=aggregator
To safely identify a valid Jobiqo AIR traffic, make sure the parameter aw_campaign_id or air_campaign_item_id is given (rest is optional, but usually avaiable). Only in this case you need to call the jobiqo AIR Tracking API.
Sessions
To correctly track conversions (apply start & apply finish) you need to start a session once the job view event happens. Usually the “apply start” conversion is attributed to jobiqo AIR if it happens at least within 30 minutes after the job view event, for “apply finish” longer periods can be used.
Technically this can be achieved by using the browser’s local storage or cookies. To connect a job view and a job apply event, you need to generate a random session ID.
There are no requirements on the format, as long as the job view and apply event use the same ID.
Endpoint
For any event type, the endpoint is following and accepts a HTTP POST request:
https://air.jobiqo.com/campaign-tracking
No API key authentication is required and there are no CORS restrictions. jobiqo AIR performs validations based on the parameters below.
In case of a successful request the Tracking API returns the string “OK”, else “ERROR”.
The POST body
The POST body needs to be formatted as JSON (Header Content Type: 'application/json') and needs to contain following data:
- event_type: either “view”, “apply” (means apply start) or “apply_finish”
- session_id: any randomly generated number used to identify a user session.
- url: the full job URL including all the GET parameters from jobiqo AIR
Example
On the initial job view, send the following JSON and save the session ID & URL in the local storage:
{
"event_type":"view",
"session_id":"jobiqo-air-1682952244483hlov72uhk"
"url":"https://example.com/job-20725?aw_campaign_id=023d1fa2-e9f&utm_
campaign=jobiqo-air&utm_source=Talent&utm_medium=aggregator",
}
If the user clicks on the apply button, send following POST request:
{
"event_type":"apply",
"session_id":"jobiqo-air-1682952244483hlov72uhk"
"url":"https://example.com/job-20725?aw_campaign_id=023d1fa2-e9f&utm_
campaign=jobiqo-air&utm_source=Talent&utm_medium=aggregator",
}