Skip to main content

Data dictionary: Email events

Louise MacBean
  • Updated

The following data can be exported from Ometria into an AWS S3 bucket.

If you'd like to set up a data export please get in touch with your Customer Success Representative.

See also: Self-serve data export

This information relates to all of your email sends; automation, broadcast and transational. The exported data includes all email events, e.g. clicks, opens etc.

Note: Empty fields are passed as null - this means Ometria has no data for that field.

Bounces

The mail server has permanently rejected a message.

See also: Bounce management in Ometria 

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 66699836223080149       

uuid

String

The universally unique identifier for the message sent:

"uuid": "0f3fa2ee4c1045e1b979b31ea55397d4"

to_address

String

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "sample@ometria.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "bounce"

bounce_class

Integer

The bounce classification code for this email:

"bounce_class": "70"

reason

String

The standard text of the response returned by the remote server due to a failed delivery attempt, i.e. a bounce.:

"reason": "Bounce reason:Your email was detected as spam."

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2017-11-01T12:13:16+00:00"

device_type

String

The type of device used to engage (click, open) with the email.

This will always be null for bounce events:

"device_type": null

geo_country

String

The recipient's country location based on their IP address.

This will always be null for bounce events:

"geo_country": null

geo_region

String

The recipient's region location based on their IP address.

This will always be null for bounce events:

"geo_region": null

geo_city

String

The recipient's city location based on their IP address.

This will always be null for bounce events:

"geo_city": null

geo_timezone

String

The time zone in the recipient's location, based on their IP address.

This will always be null for bounce events:

"geo_timezone": null

target_url

String

The URL of the link which generated the event.

This will always be null for bounce events:

"target_url": null

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign; automation, broadcast or transactional.

"campaign_type": "BROADCAST",

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation B"

Click

The recipient has clicked a tracked link in an email.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 123456789

uuid

String

The universally unique identifier for the message sent:

"uuid": "ca9a8becec064ccb8cc3a7315116be05"

to_address

String. Max. 1024 characters.

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "sample@ometria.co.uk"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "click"

bounce_class

Integer

The bounce classification code for this email.

This will always be `null` for click events:

"bounce_class": null

reason

String. Max. 1024 characters.

This is always `null` for click events:

"reason": null

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2017-11-01T13:19:32+00:00"

device_type

String

The type of device used to engage (click, open) with the email:

"device_type": "tablet"

geo_country

String

The recipient's country location based on their IP address:

"geo_country": "GB"

geo_region

String

The recipient's region location  based on their IP address:

"geo_region": "ENG"

geo_city

String

The recipient's city location based on their IP address:

"geo_city": "London"

geo_timezone

String

The time zone in the recipient's location, based on their IP address:

"geo_timezone": "Europe/London"

target_url

String

The URL of the link which generated the click event:

"target_url": "https://www.ometria.co.uk"

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "AUTOMATION"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A - winner"

Delay

The remote mail transfer agent (MTA) has temporarily rejected a message/email.

When this happens Ometria automatically attempts redelivery.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 66699836223081929

uuid

String

The universally unique identifier for the message sent:

"uuid": "1f7fba91b39b4c96aff3a38631a62fe3"

to_address

String

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "sample@ometria.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "delay"

bounce_class

Integer

The bounce classification code for this email:

"bounce_class": 70

reason

String

The standard text of the response returned by the remote server due to a failed delivery attempt, i.e. a bounce.:

"reason": "REASON: no MAIL FROM response"

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2017-11-01T12:13:27+00:00"

device_type

String

The type of device used to engage (click, open) with the email.

This will always be null for delay events:

"device_type":null

geo_country

String

The recipient's country location based on their IP address.

This will always be null for delay events:

"geo_country": null

geo_region

String

The recipient's region location  based on their IP address. 

This will always be null for delay events:

"geo_region": null

geo_city

String

The recipient's city location based on their IP address. 

This will always be null for delay events:

"geo_city": null

geo_timezone

String

The time zone in the recipient's location, based on their IP address.

This will always be null for delay events:

"geo_timezone": null

target_url

String

The URL of the link which generated the event:

This will always be null for delay events.

"target_url": null

campaign_title

String

The title of the campaign this email is part of: 

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "AUTOMATION"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A - winner"

Delivery

The mail server acknowledged receipt of an email.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 48685442134979123

uuid

String

The universally unique identifier for the message sent:

"uuid": "569566a7e76b4a05a127d2fc059c7c5c"

to_address

String

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "sample@ometria.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "delivery"

bounce_class

Integer

The bounce classification code for this email.

This will always be `null` for delivery events:

"bounce_class": null

reason

String

This is always `null` for delivery events:

"reason": null

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2017-11-01T13:27:45+00:00"

device_type

String

The type of device used to engage (click, open) with the email:

"device_type": "computer"

geo_country

String

The recipient's country location based on their IP address:

"geo_country": “GB”

geo_region

String

The recipient's region location  based on their IP address:

"geo_region": “ENG”

geo_city

String

The recipient's city location based on their IP address:

"geo_city": “Wimbledon”

geo_timezone

String

The time zone in the recipient's location, based on their IP address:

"geo_timezone": "Europe/London"

target_url

String

The URL of the link which generated the click event:

"target_url": "https://www.ometria.co.uk"

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "BROADCAST"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A - winner"

Injection

The email has been received by the mail server.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 48685442134979093

uuid

String

The universally unique identifier for the message sent:

"uuid": "569566a7e76b4a05a127d2fc059c7c5c"

to_address

String. Max. 1024 characters.

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "aaa@example.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "injection"

bounce_class

Integer

The bounce classification code for this email.

This will always be `null` for injection events:

"bounce_class": null

reason

String. Max. 1024 characters.

This is always `null` for injection events:

"reason": null

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2019-05-28T00:00:17+00:00"

device_type

String

The type of device used to engage (click, open) with the email:

"device_type": null

geo_country

String

The recipient's country location.

Sparkpost doesn't provide an IP address for injection events, so this field will always be null:

"geo_country": null

geo_region

String

The recipient's region location.

Sparkpost doesn't provide an IP address for injection events, so this field will always be null:

"geo_region": null

geo_city

String

The recipient's city location.

Sparkpost doesn't provide an IP address for injection events, so this field will always be null:

"geo_city": null

geo_timezone

String

The recipient's time zone.

Sparkpost doesn't provide an IP address for injection events, so this field will always be null:

"geo_timezone": null

target_url

String

The URL of the link which generated the event.

This will always be null for injection events:

"target_url": null

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "BROADCAST”

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A"

Opens

The recipient opened a message in an email client.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 123456789

uuid

String

The universally unique identifier for the message sent:

"uuid": "0abfd082876948fa97a2ca4df00a3aa8"

to_address

String

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "aaa@example.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "open"

bounce_class

Integer

The bounce classification code for this email.

This will always be `null` for open events:

"bounce_class": null

reason

String

This is always `null` for open events:

"reason": null

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2019-04-28T00:00:17+00:00"

device_type

String

The type of device used to engage (click, open) with the email:

"device_type": "computer"

geo_country

String

The recipient's country location based on their IP address:

"geo_country": "KR"

geo_region

String

The recipient's region location  based on their IP address:

"geo_region": "11"

geo_city

String

The recipient's city location based on their IP address:

"geo_city": "Seoul"

geo_timezone

String

The time zone in the recipient's location, based on their IP address:

"geo_timezone": "Asia/Seoul"

target_url

String

The URL of the link which generated the event.

This will always be null for open events:

"target_url": null

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Test campaign 4133"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "AUTOMATION"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A"

list_unsubscribe 

The contact clicked the 'unsubscribe' button in an email.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 123456789

uuid

String

The universally unique identifier for the message sent:

"uuid":"0abfd082876948fa97a2ca4df00a3aa8"

to_address

String

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "aaa@example.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "list_unsubscribe"

bounce_class

Integer

The bounce classification code for this email.

This will always be `null` for list_unsubscribe events:

"bounce_class": null

reason

String

This is always `null` for open events:

"reason": null

dt_occurred

String

The date and time the event occurred:

"dt_occurred":"2019-04-28T00:00:17+00:00"

device_type

String

The type of device used to engage (click, open) with the email:

"device_type": "computer"

geo_country

String

The recipient's country location based on their IP address.

This will always be null for unsubscribe events:

"geo_country": "null"

geo_region

String

The recipient's region location  based on their IP address. 

This will always be null for unsubscribe events:

"geo_region": "null"

geo_city

String

The recipient's city location based on their IP address. 

This will always be null for unsubscribe events:

"geo_city": "null"

geo_timezone

String

The time zone in the recipient's location, based on their IP address.

This will always be null for unsubscribe events:

"geo_timezone": "null"

target_url

String

The URL of the link which generated the event.

This will always be null for unsubscribe events:

"target_url": null

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Test campaign 4133"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "AUTOMATION"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A"

out_of_band 

The remote mail transfer agent (MTA) initially reported acceptance of a message, but it has since reported that the message was not delivered.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 66699836223081929

uuid

String

The universally unique identifier for the message sent:

"uuid":"1f7fba91b39b4c96aff3a38631a62fe3"

to_address

String. Max. 1024 characters.

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "sample@ometria.com

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "out_of_band"

bounce_class

Integer

The bounce classification code for this email:

"bounce_class": 70

reason

String

The standard text of the response returned by the remote server due to a failed delivery attempt, i.e. a bounce:

"reason": "REASON: no MAIL FROM response"

dt_occurred

String

The date and time the event occurred:

"dt_occurred": "2017-11-01T12:13:27+00:00"

device_type

String

The type of device used to engage (click, open) with the email.

This will always be null for out_of_band events:

"device_type": null

geo_country

String

The recipient's country location based on their IP address.

This will always be null for out_of_band events:

"geo_country": null

geo_region

String

The recipient's region location  based on their IP address. 

This will always be null for out_of_band events:

"geo_region": null

geo_city

String

The recipient's city location based on their IP address. 

This will always be null for out_of_band events:

"geo_city": null

geo_timezone

String

The time zone in the recipient's location, based on their IP address.

This will always be null for out_of_bound events:

"geo_timezone": null

target_url

String

The URL of the link which generated the event.

This will always be null for out_of_band events:

"target_url": null

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "AUTOMATION"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A - winner"

spam_complaint

The message was classified as spam/junk by the recipient.

Field

Type

Description

event_id

Integer

The unique event identifier:

"event_id": 66699836223081929

uuid

String

The universally unique identifier for the message sent.

"uuid":"1f7fba91b39b4c96aff3a38631a62fe3"

to_address

String

The recipient's email address (lowercase) used on this message's SMTP envelope:

"to_address": "sample@ometria.com"

event_type

String

The type of email event recorded, e.g. bounce, click, delay etc.:

"event_type": "spam_complaint"

bounce_class

Integer

The bounce classification code for this email.

This will always be null for spam_complaint events:

"bounce_class": "null"

reason

String

The standard text of the response returned by the remote server due to a failed delivery attempt, i.e. a bounce.

This will always be null for spam_complaint events:

"reason": "null"

dt_occurred

String

The date and time the event occurred:

"dt_occurred":"2017-11-01T12:13:27+00:00"

device_type

String

The type of device used to engage (click, open) with the email.

This will always be null for spam_complaint events:

"device_type": null

geo_country

String

The recipient's country location based on their IP address.

This will always be null for spam_complaint events:

"geo_country": null

geo_region

String

The recipient's region location  based on their IP address. 

This will always be null for spam_complaint events:

"geo_region": null

geo_city

String

The recipient's city location based on their IP address. 

This will always be null for spam_complaint events:

"geo_city": null

geo_timezone

String

The time zone in the recipient's location, based on their IP address.

This will always be null for spam_complaint events:

"geo_timezone": null

target_url

String

The URL of the link which generated the event.

This will always be null for spam_complaint events:

"target_url": null

campaign_title

String

The title of the campaign this email is part of:

"campaign_title": "Your Campaign Name"

campaign_type

String

The type of campaign, either broadcast or automation:

"campaign_type": "AUTOMATION"

variant_name

String

The name of the broadcast campaign variant (if applicable):

"variant_name": "Variation A - winner"

Related articles

Comments

0 comments

Article is closed for comments.