System events

System events are a group of events available to all Exponea customers by default without the need for a specifically-tailored integration. As opposed to custom events, automatic events should be the same for all Exponea users. In this article, we will list and explain the attributes of these events.

first_session, session_start, session_end

session_start happens when the customer visits your website
first_session is derived from the session_start event. It happens when the customer visits your website for the very first time
session_ping is an auxiliary event that will help you track other events. It is generated on every page_visit and then every 2 minutes while the page is still open in the browser.
session_end is generated 20 minutes after the last session_ping with a timestamp of the last session_ping + 30 seconds.

The duration of the session will be the difference between the timestamps of session_start and session_end in seconds. The timestamp of the session_end will have a timestamp within 2 minutes after the customer closed the last page (the 20-minute timeout is ignored for the purpose of calculating the session duration).

In other words, the timeout ensures that if someone closes the page but returns within 20 minutes, this will still be counted as a single session. However, if they don't return, those 20 minutes will not be counted into the session duration.

Attribute
Description
Example

city

Name of the city from which the user is visiting your website.

Little Rock

state

Name of the state/region from which the user is visiting your website.

Arkansas

country

Name of the country from which the user is visiting your website.

United States

latitude

Latitude from which the user is visiting your website.

80.5293

longitude

Longitude from which the user is visiting your website.

40.5293

source

Name of the platform from which the user visited your website. It has value only if the referrer is among the pre-prepared list of source platforms.

Facebook

referrer

Url of the platform from which the user visited your website.

campaign_id

Automatically-generated ID of the campaign that brought the customer on your website. More about UTM parameters

utm_campaign

UTM code of the campaign that brought the customer on your website. By default, this will be equal to the name of the email node / web push node within the scenario.
More about UTM parameters

autumn_campaign

utm_source

UTM code of the platform from which the user visited your website. More about UTM parameters

facebook_ads

utm_medium

UTM code of the campaign method used to bring the customer on your website. More about UTM parameters

email / push_notification

utm_content

UTM code of the content that brought the customer on your website. More about UTM parameters

banner / logolink / product-feed

utm_term

UTM code based on terms defining the product. Present if the campaign redirected the customer on a particular product page. More about UTM parameters

subject-STREETWEAR-category-Clothing-T-shirts-Everyday-With + sleeve-brand-Nike + men

gclid

Google Click Identifier is a code added by Google to the website's url when the customer visits your site through a Google Ad campaign.

EAwaSSdkbEAQ112

ip

IP address of the user who visited your website.

129.233.109.145

device

Mobile device from which the user visited your website. If the visit was not through a mobile device then it is marked as "other".

Iphone

os

Operating system of the device through which the user visited your website.

Android

browser

Browser through which the user visited your website.

Chrome

location

URL of the page where the user's session started.

path

Last part of the URL where the user's session started.

chaz-kangeroo-hoodie.html

duration (only for session_end)

The amount of time the user spent on the website during this session measured in seconds .

2415.980319

Customer's location inaccuracies

As all the attributes that localize the customers are based on their IP, they depend on the quality of the IP infrastructure. The country and city attributes are generally very reliable, however, the latitude and longitude are often not (as they are a more precise measure of the customer's location).

session_start custom attributes

session_start is often complemented with these manually-added custom attributes.

Attribute
Description
Example

page_load_ms

Number of milliseconds it took to load the page.

632

screen_height

Height of the screen the customer used to visit your webpage.

900

screen_width

Width of the screen the customer used to visit your webpage.

1440

screen_resolution

Resolution of the screen the customer used to visit your webpage.

1440x900

version

Version of a browser the customer used to visit your webpage.

Chrome 75

page_visit

page_visit happens each time the customer opens one of the pages of your website

Attribute
Description
Example

device

Mobile device from which the user visited the page. If the visit was not through a mobile device then it is marked as "other".

Iphone

referrer

Url of the platform from which the user visited the page.

os

Operating system of the device through which the user visited the page.

Android

location

URL of the page that the user visited.

browser

Browser through which the user visited the page.

Chrome

Issues with the tracking

If you are using our CDN page outside of your own domain for giving out surveys/getting consent, no page_visit or session_start events will be generated.

campaign

The campaign event is generated when working with emails, text messages, push notifications, or webhooks.

Attribute
Description
Example

status

Status of the user's interaction with the campaign mainly based on the SMTP code.

code

The SMPT code received from a server after you sent out an email.

422

campaign_name

Name you gave to the campaign.

September newsletter

campaign_id

Automatically-generated ID of the campaign.

5c584sa5729971a4f992sj9

action_type

Campaign's method of approaching the user.

email/webhook/push web/sms/split

action_name

Name you gave to the specific action within the campaign scenario. In case of emailing through Email campaigns and not scenarios, action_name is the same as campaign_name.

Shoes email

action_id

Unique ID number of the action. The number rises proportionally with the order in which you created the action in the scenarios. The action_id of the first action is 1, for the second action it is 2 etc.

12

campaign_policy

Name of the policy used in the campaign shown to the particular user. More on policy

default

subject

Custom-given subject of the e-mail sent in the campaign.

Autumn Collection

language

Language used in the campaign shown to the particular user.

sk

recipient

The user's email address where the campaign email was delivered.

user@gmail.com

ip

IP address of the user targeted by the campaign.

129.233.109.145

user-agent

Name of the email client from which the campaign link was clicked from.

Mozilla

url

URL campaign link that was clicked on by the user.

variant

Name of the A/B split variant loaded on the webpage.

Variant A, control group

new_choice

Information on whether the user saw this variant for the first time.

true/false

Values of the status attribute

Status
Explanation

enqueued

Exponea enqueued the email to the email provider

sent

The message was submitted to the network for delivery.

delivered

Email provider confirmed delivery

enqueue_failed

Exponea could not enqueue the email

failed

Communication error between Exponea and the email provider

opened

The email was opened = pixel in the email was loaded.
Note that some services block these pixels, which may result in customers who only have the clicked event tracked, without opened

clicked

The customer clicked on a link inside the email. This also includes clicking on the unsubscribe link.

dropped

Email provider did not temporarily deliver the email

complained

Email provider notified Exponea that the customer marked the email as "Spam"

soft_bounced

Email provider notified Exponea that the email was soft bounced and will try again later, maybe because of full inbox (Mandrill)

bounced

Email provider notified Exponea that the email was bounced with a permanent error

rejected

Email provider notified Exponea that email was rejected for delivery, might be because of too many bounces, unsubscribed or blacklisted (Mandrill)

Tracking clicked event

Links to your webpage sent out in a campaign firstly lead to our CDN domain so that the clicked event is tracked. After that, the customer is immediately redirected from the CDN domain to your webpage.

Issues with the opened event

Opened event tracked for Gmail does not guarantee that the recipient had indeed opened your email. Gmail's servers sometimes download external images from emails into their cache in advance. As we use these images to track whether the customers opened the email, we get a fake open event every time Gmail's servers do this. Moreover, email providers sometimes block the loading of the images we use for the tracking of the opened event so even if your email seems to be just delivered it might, in fact, be opened.

Bounced emails and unsubscribing customers

When an email is bounced, the email_invalid property is set to true/yes`. When `email_invalid` or `unsubscribed` is set to `true`/yes`, Exponea won't send emails to those customers, even if they satisfy all other conditions, hence using these attributes manually in conditions is not necessary. This serves to prevent undeliverable emails from being sent, protecting the sender's reputation and spam score. Learn more about how unsubscribing works in the campaign groups article.

Bounced and dropped statuses

Statuses of the campaign event are based on the SMTP error codes received. SMTP error codes starting with 4xx are marked as dropped, while error codes 5xx stand for bounced. However, some providers send 5xx marked as dropped. In these cases, Exponea treats them as bounced emails.

Values of the code attribute

Code attribute gives you the SMPT error or reply code received from a server after you send out a campaign email. The status attribute is based on these codes, however, it is useful to also know the code itself as it is more precise in assessing what happened to the email. The following link contains a list of codes and their corresponding meanings. For these to work correctly, you need to have a Mailgun integration. Even though SMPT codes are reliable for most customers, beware that small email providers often send alternative SMPT codes that will not be recognized.

survey

survey happens when the customer is shown a survey question you had created. More on surveys

Attribute
Description
Example

question

Question given in the survey.

How likely are you to recommend Exponea to your friends?

answer

Answer given by the user in the survey. (has value only if the customer answers the question)

Very likely.

device

Mobile device from which the user filled the survey. If was not done through a mobile device then it is marked as "other".

Iphone

location

URL of the page with the survey.

path

Last part of the URL of the survey page.

survey.html

interaction

Information on whether the user filled and sent the survey.

true

os

Operating system of the device through which the user filled the survey.

Windows

browser

Browser through which the user filled the survey.

Chrome

merge

merge when two customer profiles are merged into one

Attribute
Description
Example

source_internal_ids

Two IDs that merged together.

5c584sa5729971a4f992sj9, 5c584sa5729971a4f992sj9

destination_internal_id

The ID resulting from the merger (the older one from the two original ones).

5c584sa5729971a4f992sj9

original_external_ids

Two IDs for external platforms that merged together.

{"cookie":[google_analytics
["user@gmail.com"],}{id:2};
{"cookie[google_analytics
["user@gmail.com"],}{id:3}

final_external_ids

The ID for external platforms resulting from the merger (the older one from the two original ones).

{"cookie":[google_analytics
["user@gmail.com"]{id:2},}

ab test

ab test happens when the customer sees one of the variants of a page/banner/recommendation you had created in an A/B split. More on A/B testing

Attribute
Description
Example

variant

Name of the A/B split variant loaded on the webpage.

Variant A/control group

variant_id

Automatically-generated ID of the variant.

c584sa5729971a4f992sj9

location

URL of the particular variant of the user sees.

device

Mobile device from which the user sees the particular variant. If the visit was not through a mobile device then it is marked as "other".

Iphone

os

Operating system of the device through which the user sees the particular variant.

Windows

browser

Browser through which the the user sees the particular variant.

Chrome

experiment

experiment happens when an experiment is shown to the customer. More on experiments

Attribute
Description
Example

experiment_name

Custom-given name of the experiment.

Experiment 1

experiment_id

Automatically-generated ID of the experiment.

584sa5729971a4f992sj9

variant_name

Name of the A/B split variant used in the experiment loaded on the webpage.

Variant A

variant_id

Automatically-generated ID of the variant used in the experiment loaded on the webpage.

c584sa5729971a4f992sj9

action

Nature of the engagement the user had with the experiment. "Show" is a default standard for indicating that the experiment has loaded on the page.

show/close/submit/click

location

URL of the page with the experiment.

path

Last part of the URL of the page with the experiment.

chaz-kangeroo-hoodie-experiment-1.html

device

Mobile device from which the user sees the page with the experiment. If the visit was not through a mobile device then it is marked as "other".

Iphone

os

Operating system of the device through which the user sees the page with the experiment.

Windows

browser

Browser through which the the user sees the page with the experiment.

Chrome

anonymization

anonymization happens when you remove the customer's identification but still keep their data for analytics purposes. You can read more about anonymization in Data management.

Attribute
Description
Example

source

Software through which the user's information was anonymized.

events_ext_api

access_group_id

Level of access rights of the person who anonymized the user's information.

Group_B

System events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.