Exporting Raw Events¶
Export the raw events that power the GetSocial Analytics if you want to make a deeper analysis or integrate with other analytics services.
The export option is available inside Data Export → CSV Export in the GetSocial Dashboard and through the HTTP API
The exported data will include events from the last 45 days up to ~2 hours before the export time.
The exporting process can take from a few seconds to a couple of hours depending on the volume of data.
Once finished, the files will be available via webhooks.
Additionally, the files will be sent by email if requested through the GetSocial Dashboard.
Exported files will be available for 30 days.
Format¶
The data will be exported as CSV files, gzip compressed with a maximum size of 500 MB per file.
One single export can generate multiple files.
Available Filters¶
When exporting through the HTTP API this params is required:
event
: Name of the event to export, e.g.,app_install
.
The available list of GetSocial events to export is:
app_session_start
invite_created
invite_sent
invite_canceled
invite_failed
app_install
app_reinstall
app_open
web_signup
web_open
referral_data_received
invite_link_click
friends_add
friends_remove
inapp_purchase
For your own events, you can use custom
and all the custom events will be exported together
And these are optional:
from
: Date From inYYYY-MM-DD
, e.g.,"2020-01-01"
to
: Date To inYYYY-MM-DD
, e.g.,"2020-01-01"
Available Properties¶
Global Properties¶
This is the list of Global Properties that are available for all events.
Property | Description |
---|---|
ts |
UTC Timestamp of the event e.g., 2017-11-01 04:39:54 |
app_version |
Version of the App e.g., 1.0.1 |
app_release |
Build Version of the App e.g., 1017103015 |
sdk_version |
Version of the GetSocial SDK e.g., 6.10.1 |
city |
City (based on GeoIP) e.g., Toronto |
region |
Region (based on GeoIP) e.g., Ontario |
country |
Country Code ISO Alpha 2 (based on GeoIP) e.g., CA |
distinct_id |
GetSocial Unique User ID e.g., 110236346286681927 |
idfa |
ID for Advertising of the device (if available) e.g., 4AF27B96-2E2D-4430-96E6-55B3AA30CFFF |
ifv |
ID for Vendor of the device (if available) e.g., 86F1FE93-07B6-420A-A019-F2F4B80DEFFF |
user_language |
Language defines for the GetSocial SDK (full list) e.g., en |
device_language |
Language and Locale from the device e.g., en-CA |
device_timezone |
Device Timezone (full list ) e.g., America/Toronto |
manufacturer |
Manufacturer of the device e.g., Apple |
model |
Model of the device e.g., iPhone10,4 |
carrier |
Carrier of the device (if available) e.g., T-Mobile |
network_type |
Internet connection type (if available) e.g., Mobile |
network_subtype |
Internet connection subtype (if available) e.g., LTE |
app_platform |
Platform e.g., iOS , Android |
os_version |
Version of the Operating System e.g., 11.0.3 |
App Session Started¶
Generated every time the app is opened and the GetSocial SDK is initialized.
It doesn’t include any additional properties.
Invite Created¶
Generated when the app requests the GetSocial SDK to create a new Smart Invite Link to be sent through a specific channel or when a Smart Link is created through the GetSocial Dashboard.
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite or Smart Link e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
source |
Origin of the Smart Invite / Smart Link:
|
token |
Unique Identifier of the Smart Invite / Smart Link e.g., SYWb31COQa |
campaign_id |
Campaign Identifier (Only for Smart Links) e.g., 1234 |
medium |
Medium (Only for Smart Links) e.g., CPC |
link_type |
Type of link created:
|
Invite Sent¶
Generated when the user sends the Smart Invite.
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
token |
Identifier of the Smart Invite e.g., SYWb31COQa |
Invite Canceled¶
Generated when the user cancels the sending of a Smart Invite. Not all channels provide this information.
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
token |
Identifier of the Smart Invite e.g., SYWb31COQa |
Invite Failed¶
Generated when the sending of a Smart Invite fails for some reason. Not all channels provide this information.
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
token |
Identifier of the Smart Invite e.g., SYWb31COQa |
App Install¶
Generated when the app is opened for the first time and was installed after clicking on a Smart Invite Link or Smart Link.
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
referrer_distinct_id |
GetSocial Unique User ID of the inviter e.g., 110236346286681927 |
token |
Identifier of the Smart Invite / Smart Link e.g., SYWb31COQa |
campaign_id |
Campaign Identifier (Only for Smart Links) e.g., 1234 |
medium |
Medium (Only for Smart Links) e.g., CPC |
link_type |
Type of link created:
|
click_id |
Unique Identifier of the link click e.g., bbd75cbee59c11e79ea50242ac110004 |
Referral Data Received¶
Generated whenever Referral data is requested from the app, either when:
- app is opened for the first time after clicking on a Smart Invite or Smart Link.
- app is opened is directly after clicking on a Smart Invite or Smart Link (deeplinking).
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
referrer_distinct_id |
GetSocial User ID of the inviter e.g., 110236346286681927 |
token |
Identifier of the Smart Invite / Smart Link e.g., SYWb31COQa |
campaign_id |
Campaign Identifier (Only for Smart Links) e.g., 1234 |
medium |
Medium (Only for Smart Links) e.g., CPC |
link_type |
Type of link created:
|
click_id |
Unique Identifier of the link click e.g., bbd75cbee59c11e79ea50242ac110004 |
Invite Link Click¶
Generated when a user clicks on a Smart Invite or Smart Link.
Property | Description |
---|---|
channel |
Name of the channel specified in the Smart Invite e.g., whatsapp |
sub_channel |
In case the channel is nativeshare , sub_channel provides extra details about the application the user selected.e.g., com.google.Gmail.ShareExtension |
referrer_distinct_id |
GetSocial User ID of the inviter e.g., 110236346286681927 |
token |
Identifier of the Smart Invite / Smart Link e.g., SYWb31COQa |
campaign_id |
Campaign Identifier (Only for Smart Links) e.g., 1234 |
medium |
Medium (Only for Smart Links) e.g., CPC |
link_type |
Type of link created:
|
click_id |
Unique Identifier of the link click e.g., bbd75cbee59c11e79ea50242ac110004 |
ua |
Complete User Agent of browser where the link was clicked e.g., Mozilla/5.0 (iPad; CPU OS 11_2... |
ua_name |
Name of the browser where the link was clicked e.g., Mobile Safari UI/WKWebView |
ua_version |
Version of the browser where the link was clicked e.g., 11.2 |
Friend Added¶
Generated when a new friend relation is added to the Social Graph.
Property | Description |
---|---|
source |
Origin of the relation:
|
type |
Trigger for adding the relation:
|
friend_distinct_id |
GetSocial User ID of the friend added e.g., 110236346286681927 |
Friend Removed¶
Generated when a friend relation is removed from the Social Graph.
Property | Description |
---|---|
friend_distinct_id |
GetSocial User ID of the friend removed e.g., 110236346286681927 |
Custom events¶
These are custom events sent by the developer via the SDK or the HTTP API.
Property | Description |
---|---|
event |
Name of the event e.g., level_unlocked |
data |
JSON string of custom data map e.g., {"level":"1"} |