The schema the raw event export files follow is:
- gzip compressed
- one line of JSON encoded code (each line represents a single event)
- each line is a JSON dictionary with the following keys: user, time, client_time, type, app_version, payload, parameters, seqnum, version, device_id
type represents the event type sent to the Swrve API. It may be one of:
user represents the user identifier sent to the Swrve API with the event (or batch of events).
time represents the time recorded on the Swrve server when the event was received. This is an integer that represents the number of milliseconds since the epoch.
client_time represents the client time sent to Swrve with event. This is an integer that represents the number of milliseconds since the epoch.
app_version represents the app_version identifier sent to the Swrve API with the event (or batch of events).
payload represents the optional payload information added to the event.
payload is a dictionary of string / integer / boolean values.
parameters contains a dictionary of data sent to the Swrve API with the event. The dictionary fields depend on event_type. These parameters match the REST API.
|purchase||item, currency, cost, quantity|
Seqnum, version, device ID
device_idare internal and are used for debugging.
Swrve campaign events are logged in two formats, generic or custom, depending on the channel and action type in question. Generic campaign events use a common event name, with differentiators for channel, action and campaign ID stored within the event payloads. In contrast, custom campaign events encode the channel, action and campaign ID within the event name itself. We show some examples of each further down. In the meantime, here is the breakdown of channels and actions, per type:
|Channel||Actions in generic format||Actions in custom format|
Generic campaign event format
Campaign touchpoints that are tracked as generic Swrve campaign events will have an event name of
Swrve.generic_campaign_event and the following JSON format in the S3 raw logs:
|id||This is the tracking ID of the campaign event.
Use this ID to map the raw data to campaign metadata such as name, dashboard URL and so forth via the Campaign Meta Data API.
|campaignType||This indicates what channel the campaign has been run on:
|actionType||This indicates the action of the touchpoint being tracked.
See table above for values per channel.
Custom campaign event format
Campaign touchpoints that are tracked as custom Swrve campaign events will encode tracking ID, campaign type and action type in the event name, rather than the payload:
|Channel||Actions||Event name schema|
Where <ID> is the tracking ID. Use the raw event name to map from the log entry to relevant campaign metadata such as name, dashboard URL and so forth via the Campaign Meta Data API.
Push sent and delivered events
The raw S3 logs also include Push Sent and Delivered events, both in generic campaign event format.
Push Sent events are logged server-side, so are independent of all SDK flavors and require no SDK update. The deciding factor for Push Sent is what type of push.
|Push Type||Push Sent events logged|
|Geo-triggered||No – impression event logged from SDK|
Push Delivered events are logged client-side, so require an SDK update. They are also not supported by all of our SDKs yet.
|SDK platform||Push Delivered events logged|
Swrve support can help you with parsing and ETL of the data schema described above. If you need help with your queries, contact our Data Services team at email@example.com. They will help you get the most out of your data with dedicated support, pre-built and custom reports, and dedicated data science hours.