Data schema

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

type represents the event type sent to the Swrve API. It may be one of:

• event
• user
• purchase
• currency_given
• iap
• session_start
• session_end

User

user represents the user identifier sent to the Swrve API with the event (or batch of events).

Time

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

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

app_version represents the app_version identifier sent to the Swrve API with the event (or batch of events).

Payload

payload represents the optional payload information added to the event. payload is a dictionary of string / integer / boolean values.

Parameters

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.

Seqnum, version, device ID

• seqnum, version, and device_id are internal and are used for debugging.

Campaign events

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. For examples, see Custom campaign event format below. The following table provides a breakdown of channels and actions by 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": "...",
    "campaignType": "...",
    "actionType": "...",
    "contextId":"...",
    "payload": {
        "key1": "...",
        "...": "..."
    }
}

where:

Example event

{
"type": "generic_campaign_event",
"time": 123,
"seqnum": 1,
"actionType": "delivered",
"campaignType": "push",
"id": "1",
"payload": {
    "displayed": "false",
    "reason": "permission_denied",
    "silent": "false"
}
}

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:

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.

Swrve campaign events have the following JSON format in the S3 raw logs:

{
  "name": "...",
  "payload": {
        "key1": "...",
        "...": "..."
  }
}

where:

Example event

{
"type": "event",
"time": 123,
"seqnum": 1,
"name": "Swrve.Messages.Message-646079.click",
"payload": {
    "embedded": "false",
    "contextId": 207747,
    "name": "Button 1",
    "buttonId": 259418,
    "pageName": "Page 3",
  }
}

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 Delivered events are logged client-side, so require an SDK update. They are also not supported by all of our SDKs yet.