Skip to content

Exporting Data

Export your GetSocial data to import into your backend or to integrate with other services.

The export option is available inside Data Export → CSV Export in the GetSocial Dashboard and through the HTTP API and allows you to either export specific data a full export.

When requesting a full export, take in mind that you will receive each export data independently via email or webhook as soon as each export gets processed. This export will not include any media, for that, please take a look at Exporting Media.

The exported data is current as of the time of export.

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 could 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 Data

This the list of data that can be export:

Users

This export will contain all information about Users.

Property Description
distinct_id GetSocial Unique User ID
e.g., 110236346286681927
display_name Name of the user
e.g., John Doe
avatar_url URL of the avatar of the user
e.g., https://...
channel Name of the channel this user came from
e.g., whatsapp
campaign_id GetSocial Unique ID of Smart Link Campaign
e.g., 11023
marketing_link_id GetSocial Unique ID of Smart Link
e.g., 11023
medium Smart Link Campaign medium
e.g., cpc
identities Custom identities of the User (in JSON)
e.g., {"facebook":"1234567890", "custom":"0987654321"}
app_version Version + Build of the App
e.g., 1.0.1 (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
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 defined 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
app_platform Platform
e.g., iOS, Android
os_version Version of the Operating System
e.g., 11.0.3
first_session UTC Timestamp of the first session
e.g., 2017-11-01 04:39:54
last_session UTC Timestamp of the last session
e.g., 2017-11-01 04:39:54
count_sessions Number of total session
e.g., 184
first_invite_sent UTC Timestamp of the first invite sent
e.g., 2017-11-01 04:39:54
last_invite_sent UTC Timestamp of the last invite sent
e.g., 2017-11-01 04:39:54
count_invites_sent Number of total invites sent
e.g., 184
first_activity_posted UTC Timestamp of the first activity posted
e.g., 2017-11-01 04:39:54
last_activity_posted UTC Timestamp of the last activity posted
e.g., 2017-11-01 04:39:54
count_activities_posted Number of total activities posted
e.g., 184
first_comment_posted UTC Timestamp of the first comment posted
e.g., 2017-11-01 04:39:54
last_comment_posted UTC Timestamp of the last comment posted
e.g. 2017-11-01 04:39:54
count_comments_posted Number of total comments posted
e.g. 184
first_install_generated UTC Timestamp of the first install generated
e.g. 2017-11-01 04:39:54
last_install_generated UTC Timestamp of the last install generated
e.g. 2017-11-01 04:39:54
count_installs_generated Number of total installs generated
e.g. 184
first_friend_added UTC Timestamp of the first friend added
e.g. 2017-11-01 04:39:54
last_friend_added UTC Timestamp of the last friend added
e.g. 2017-11-01 04:39:54
count_friends Number of total friends
e.g. 184
public_properties Public user property defined by the developer
e.g. colour
private_properties Public user property defined by the developer
e.g. weapon_type
referrer_user_id GetSocial Unique User ID of a referrer user
e.g. 110236346286681927
first_purchase UTC Timestamp of the first invite sent
e.g. 2017-11-01 04:39:54
last_purchase UTC Timestamp of the last invite sent
e.g. 2017-11-01 04:39:54
count_purchases Number of purchases by the user
e.g. 3
ltv Total purchased (USD) by the user
e.g. 3.99
social_ltv Aggregated Lifetime Value (USD) of the referred users
e.g. 8.25

Promo Codes

This export will contain all information about Promo Codes.

Actual claims are available in Promo Codes Usage.

Properties Description
id Internal ID of the Promo Code
e.g., 1234
code External ID of the Promo Code
e.g., holidays
created_by GetSocial UserID of the user that created the Promo Code
e.g., 1234 or 0 when created by Developer
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
updated_at UTC Timestamp of the last update
e.g., 2017-11-01 04:39:54
enabled If the Promo Code is active
e.g., 0 or 1
max_claims Maximum number of claims
e.g., 1000
num_claims Number of claims so far
e.g., 200
valid_from UTC Timestamp when the Promo Code becomes active
e.g., 2017-11-01 04:39:54
valid_until UTC Timestamp when the Promo Code becomes inactive
e.g., 2017-11-01 04:39:54
custom_data JSON string of the custom data
e.g., {"key":"value"}

Promo Codes Usage

This export will contain all Promo Code claims.

Properties Description
created_at UTC Timestamp of claim of the Promo Code
e.g., 2017-11-01 04:39:54
code External ID of the Promo Code
e.g., holidays
user_id GetSocial UserID of the user that claimed the Promo Code
e.g., 1234

Smart Invites

This export will contain all Smart Invites sent by users.

Properties Description
id Internal ID of the Smart Invite
e.g., 1234
token External ID of the Smart Invite
e.g., DK35L4
created_by GetSocial UserID of the user that created the Smart Invite
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
properties JSON string of the properties
e.g., {"key":"value"}
channel Channel where the Smart Invite was sent through
e.g., whatsapp

This export will contain all Smart Links created by the developer.

Properties Description
id Internal ID of the Smart Link
e.g., 1234
name Name of the Smart Link
e.g., Summer Sale
token External ID of the Smart Link
e.g., DK35L4
campaign Campaign where the Smart Link was sent through
e.g., Summer sale
title Localized Title of the Smart Link
e.g., {"en":"Summer Sale", "de": "Sommerschlussverkauf"}
description Localized Description of the Smart Link
e.g., {"en":"Summer Sale", "de": "Sommerschlussverkauf"}
image URL of the image of the Smart Link
e.g., https://...
fallback_url URL to fallback when app is not available in the current platform
e.g., https://...
channel Channel where the Smart Link was sent through
e.g., whatsapp
medium Medium where the Smart Link was sent through
e.g., cpc
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
custom_data JSON string of the custom data
e.g., {"key":"value"}

This export will contain all Link Clicks tracked.

Properties Description
id Internal ID of the Link Click
e.g., 890FB45A0F5811EEB5E50A58A9FEAC04
token External ID of the Smart Invite/Smart Link
e.g., DK35L4
link_type Either smart-invite or smart-link
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
custom_data JSON string of the custom data
e.g., {"key":"value"}
channel Channel where the Smart Link was sent through
e.g., whatsapp
os Operating System of the device
e.g., Android
os_version Version of the Operating System of the device
e.g., 13
device_brand Brand of the device
e.g., Samsung
device_model Model of the device
e.g., SM-A515F
city City where link was clicked
e.g., Birmingham
region Region where link was clicked
e.g., England
country Country where link was clicked
e.g., United Kingdom of Great Britain and Northern Ireland

This export will contain details about the attribution of a given Link Click to a subsequent install, reinstall or app open.

Properties Description
id Internal ID of the Link Attribution
e.g., 1234
link_click_id Internal ID of the Link Click
e.g., 890FB45A0F5811EEB5E50A58A9FEAC04
token External ID of the Smart Invite/Smart Link
e.g., DK35L4
link_type Either smart-invite or smart-link
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the user that clicked on the Link
e.g., 1234
install If the click resulted in an install
e.g., 0 or 1
reinstall If the click resulted in an reinstall
e.g., 0 or 1
app_open If the click resulted in an app open
e.g., 0 or 1

Referrals

This export will contain details about the referrer relationship among users.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the referrer user
e.g., 1234
target_entity_type Type of the referrer entity
always user in this case
target_entity_id GetSocial UserID of the referred user
e.g., 1234
custom_data JSON string of the custom data
e.g., {"key":"value"}
event Event that triggered this referral relationship
e.g., app_open, purchase_completed

Friends

This export will contain details about the friend relationship among users.
The friend relationship is symmetric so 2 rows will be return for each relationship.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the friend A
e.g., 1234
target_entity_type Type of the entity
always user in this case
target_entity_id GetSocial UserID of the friend B
e.g., 1234

User Followers

This export will contain details about the follower relationship between users.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the follower
e.g., 1234
target_entity_type Type of the entity
always user in this case
target_entity_id ID of the target entity
e.g., 1234

Blocked Users

This export will contain details about the blocked relationship among users.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the user that blocked
e.g., 1234
target_entity_type Type of the entity
always user in this case
target_entity_id GetSocial UserID of the blocked user B
e.g., 1234

Topics

This export will contain details about all the Topics.

Properties Description
id ID of the Topic
e.g., 1234
title Localized Title
e.g., {"en":"Health", "de": "Gesundheit"}
description Localized Description
e.g., {"en":"Let's talk about Health.", "de": "Sprechen wir über Gesundheit."}
avatar URL of the Avatar
e.g., https://...
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
created_by GetSocial UserID of the creator
e.g., 1234 or 0 when created by Developer
permissions JSON string of the permissions map
see Permissions
labels List of labels
e.g., label1,label2,label3
properties JSON string of the properties
e.g., {"key":"value"}
is_discoverable If the Topic will be returned when searching
e.g., 0 or 1
is_trending If the Topic is trending
e.g., 0 or 1
followers Number of followers
e.g., 587

Topic Followers

This export will contain details about the topic followers.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the follower
e.g., 1234
target_entity_type Type of the entity
always topic in this case
target_entity_id ID of the target entity
e.g., 1234

Groups

This export will contain details about all the Groups.

Properties Description
id ID of the Group
e.g., 1234
title Localized Title
e.g., {"en":"Health", "de": "Gesundheit"}
description Localized Description
e.g., {"en":"Let's talk about Health.", "de": "Sprechen wir über Gesundheit."}
avatar URL of the Avatar
e.g., https://...
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
created_by GetSocial UserID of the creator
e.g., 1234 or 0 when created by Developer
permissions JSON string of the permissions map
see Permissions
labels List of labels
e.g., label1,label2,label3
properties JSON string of the properties
e.g., {"key":"value"}
is_discoverable If the Group will be returned when searching
e.g., 0 or 1
is_private If anyone can join the Group
e.g., 0 or 1
is_trending If the Group is trending
e.g., 0 or 1
followers Number of followers
e.g., 587
members Number of members
e.g., 587

Group Members

This export will contain details about all the Groups Members of all Groups, including invitations or requests that have yet not been accepted.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of member
e.g., 1234
target_entity_type Type of the target entity
always group in this case
target_entity_id ID of the Group
e.g., 1234
status Status of the membership
e.g., approval_pending, invitation_pending , approved , rejected
role Role of the membership
e.g., owner, admin , member

Group Followers

This export will contain details about the group followers.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the follower
e.g., 1234
target_entity_type Type of the entity
always group in this case
target_entity_id ID of the target entity
e.g., 1234

Labels

This export will contain details about all the Labels.

Properties Description
name Name
e.g., Product1
activities Number of activities/comments with the label
e.g., 587
followers Number of followers
e.g., 587
is_trending If the Label is trending
e.g., 0 or 1

Label Followers

This export will contain details about the label followers.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the follower
e.g., 1234
target_entity_type Type of the entity
always label in this case
target_entity_id ID of the target entity
e.g., 1234

Hashtags

This export will contain details about all the Hashtags.

Properties Description
name Name
e.g., SummerSale
activities Number of activities/comments with the label
e.g., 587
followers Number of followers
e.g., 587
is_trending If the Hashtag is trending
e.g., 0 or 1

Hashtag Followers

This export will contain details about the label followers.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
user_id GetSocial UserID of the follower
e.g., 1234
target_entity_type Type of the entity
always hashtag in this case
target_entity_id ID of the target entity
e.g., 1234

Activities

This export will contain details about all the Activities posted in the feed of any user, topic orgroup.

The export can be also filtered by entity through the Dashboard or HTTP API.

For the HTTP API you need to set these params:

Params Description
target_entity_type Type of the entity where it was posted
either user, group or topic
target_entity_id ID of the entity where it was posted
e.g., Global, 1234
Properties Description
id ID of the Activity
e.g., 1234
created_by GetSocial UserID of the creator
e.g., 1234 or 0 when created by Developer
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
target_entity_type Type of the entity where it was posted
e.g., user, group, topic
target_entity_id ID of the entity where it was posted
e.g., 1234
content JSON string of the content
see Activity Content
properties JSON string of the properties
e.g., {"key":"value"}
labels List of labels
e.g., label1,label2,label3
comments Number of comments
e.g., 587
reactions Number of reactions
e.g., 587
allow_multi_reactions If the Activity allows users to react multiple times
e.g., 0 or 1
reaction_count JSON map of reaction counts
e.g., {"like":10, "wow":90}
poll_options JSON string of the poll options
see Poll Options
poll_ends_at UTC Timestamp when the poll finishes
e.g., 2017-11-01 04:39:54
votes Number of votes
e.g., 587
allow_multi_votes If the Activity allows users to vote multiple times (only for polls)
e.g., 0 or 1
vote_count JSON map of vote counts
e.g., {"option_0":10, "option_1":90}
bookmarks Number of bookmarks
e.g., 587
is_trending If the Activity is trending
e.g., 0 or 1
reports_open Number of reports that haven’t been reviewed by moderation
e.g., 3
reports_closed Number of reports that have been reviewed by moderation
e.g., 1
last_reported_at UTC Timestamp of last report
e.g., 2017-11-01 04:39:54
status Status of the activity
either pending, approved, rejected or deleted
status_updated_at UTC Timestamp of last status update
e.g., 2017-11-01 04:39:54

Activity’s reactions

This export will contain details about all the reactions in Activities.
It will also include custom reactions, votes and bookmarks.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
created_by GetSocial UserID of the creator
e.g., 1234 or 0 when created by Developer
target_entity_type Type of the entity that was reacted
always activity in this case
target_entity_id ID of the entity that was reacted
e.g., 1234
group Group of reaction
e.g., reactions, bookmarks, votes
reaction Type of reaction
e.g., like, wow, sad, v_123, bookmark

Comments

This export will contain details about all the Comments posted.

Properties Description
id ID of the Comment
e.g., 1234
created_by GetSocial UserID of the creator
e.g., 1234 or 0 when created by Developer
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
target_entity_type Type of the entity where it was posted
e.g., user, group, topic
target_entity_id ID of the entity where it was posted
e.g., 1234
parent_id ID of the activity/comment where it was posted
e.g., 1234
content JSON string of the content
see Activity Content
properties JSON string of the properties
e.g., {"key":"value"}
labels List of labels
e.g., label1,label2,label3
comments Number of comments
e.g., 587
reactions Number of reactions
e.g., 587
allow_multi_reactions If the Activity allows users to react multiple times
e.g., 0 or 1
reaction_count JSON map of reaction counts
e.g., {"like":10, "wow":90}
poll_options JSON string of the poll options
see Poll Options
poll_ends_at UTC Timestamp when the poll finishes
e.g., 2017-11-01 04:39:54
votes Number of votes
e.g., 587
allow_multi_votes If the Activity allows users to vote multiple times (only for polls)
e.g., 0 or 1
vote_count JSON map of vote counts
e.g., {"option_0":10, "option_1":90}
bookmarks Number of bookmarks
e.g., 587
reports_open Number of reports that haven’t been reviewed by moderation
e.g., 3
reports_closed Number of reports that have been reviewed by moderation
e.g., 1
last_reported_at UTC Timestamp of last report
e.g., 2017-11-01 04:39:54
status Status of the activity
either pending, approved, rejected or deleted
status_updated_at UTC Timestamp of last status update
e.g., 2017-11-01 04:39:54

Comment’s reactions

This export will contain details about all the reactions in Comments.
It will also include custom reactions, votes and bookmarks.

Properties Description
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
created_by GetSocial UserID of the creator
e.g., 1234 or 0 when created by Developer
target_entity_type Type of the entity that was reacted
always comment in this case
target_entity_id ID of the entity that was reacted
e.g., 1234
group Group of reaction
e.g., reactions, bookmarks, votes
reaction Type of reaction
e.g., like, wow, sad, v_123, bookmark

Reports

This export will contain details about all the moderation reports for Activities and Comments.

Properties Description
reported_at UTC Timestamp of the report
e.g., 2017-11-01 04:39:54
reported_by GetSocial UserID of the user who created the report
e.g., 1234 or 0 when created by Developer
target_entity_type Type of the entity that was reported
either activity or comment
target_entity_id ID of the entity that was reported
e.g., 1234
explanation Custom explanation about the report
e.g., This content is offensive
type Type of report
either spam or inappropiate
status Status of the report, if it was already handled by moderator
either open or closed

Announcements

This export will contain details about all the Announcements posted.

Properties Description
id ID of the Activity
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
target_entity_type Type of the entity where it was posted
e.g., user, group, topic
target_entity_id ID of the entity where it was posted
e.g., 1234
content JSON string of the content
see Activity Content
properties JSON string of the properties
e.g., {"key":"value"}
comments Number of comments
e.g., 587
reactions Number of reactions
e.g., 587
allow_multi_reactions If the Activity allows users to react multiple times
e.g., 0 or 1
reaction_count JSON map of reaction counts
e.g., {"like":10, "wow":90}
poll_options JSON string of the poll options
see Poll Options
poll_ends_at UTC Timestamp when the poll finishes
e.g., 2017-11-01 04:39:54
votes Number of votes
e.g., 587
allow_multi_votes If the Activity allows users to vote multiple times (only for polls)
e.g., 0 or 1
vote_count JSON map of vote counts
e.g., {"option_0":10, "option_1":90}
bookmarks Number of bookmarks
e.g., 587
visible_from UTC Timestamp when the Announcements becomes visible
e.g., 2017-11-01 04:39:54
visible_to UTC Timestamp when the Announcements disappears
e.g., 2017-11-01 04:39:54

Chats

This export will contain details about all the Chats created, but not the actual messages.

Chat Messages are available in Chat Messages.

Properties Description
id ID of the Chat
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
members Array of members
e.g., ["1234","4321"]

Chat Messages

This export will contain details about all the Chats Messages.

Properties Description
id ID of the Chat Message
e.g., 1234
created_by GetSocial UserID of the creator
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
target_entity_type Type of the entity where it was posted
always chat in this case
target_entity_id ID of the entity where it was posted
e.g., 1234
content JSON string of the content
see Activity Content
properties JSON string of the properties
e.g., {"key":"value"}

Direct Notifications

This export will contain details about all the User-to-User Notifications. These are custom notifications that were sent directly from the HTTP or SDK.

Properties Description
id ID of the Notification
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
sender_id GetSocial UserID of the sender
e.g., 1234
receiver_id GetSocial UserID of the receiver
e.g., 1234
status Status of the notification
e.g., unread, read, ignored, consumed
template_id ID of the Notification Template
e.g., 1234
notification_data JSON map of notification data
e.g., {"CHAT_MESSAGE": "Hi there!"}
action Action of the Notification
e.g., open_profile, open_chat, custom, open_url, open_store
action_data JSON map of action arguments
e.g., [{"$chat_id":"1fe7caa23f71c615a0b26c5b10b29f77"}]

System Notification

This export will contain details about all the GetSocial-to-User Notifications.
These includes all the notifications with a GetSocial Notification Template, like activity_like, comment, chat_message, etc.

Properties Description
id ID of the Notification
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
sender_id GetSocial UserID of the sender
e.g., 1234
receiver_id GetSocial UserID of the receiver
e.g., 1234
template_id ID of the Notification Template
e.g., 1234
notification_data JSON map of notification data
e.g., {"CHAT_MESSAGE": "Hi there!"}
status Status of the notificationbr/>e.g., unread, read, ignored, consumed
action Action of the Notification
e.g., open_profile, open_chat, custom, open_url, open_store
action_data JSON map of action arguments
e.g., [{"$chat_id":"1fe7caa23f71c615a0b26c5b10b29f77"}]

Targeted Notifications

This export will contain details about all the Smart Targeting Notifications

Properties Description
id ID of the Notification
e.g., 1234
created_at UTC Timestamp of the creation
e.g., 2017-11-01 04:39:54
receiver_id GetSocial UserID of the receiver
e.g., 1234
template_id ID of the Notification Template
e.g., 1234
status Status of the notification
e.g., unread, read, ignored, consumed
action Action of the Notification
e.g., open_profile, open_chat, custom, open_url, open_store
action_data JSON map of action arguments
e.g., [{"$chat_id":"1fe7caa23f71c615a0b26c5b10b29f77"}]

Notification Templates

This export will contain details about all the custom Notifications Templates

Properties Description
id ID of the Notification
e.g., 1234
name Name
e.g., SummerSale
description Name
e.g., SummerSale template
text Localized Text of the Notification Template
e.g., {"en":"Summer Sale", "de": "Sommerschlussverkauf"}
action Action of the Notification
e.g., open_profile, open_chat, custom, open_url, open_store
action_data JSON map of action arguments
e.g., [{"$chat_id":"1fe7caa23f71c615a0b26c5b10b29f77"}]

Media

Exporting all your app’s media can be achieved in 2 ways:

  • You can download each file using the file URLs available in the exported CSVs
  • You can request us a one-time export of all your apps media to a downloadable package

This will consists of:

  • Avatars of users, groups and topics
  • Smart Invite/Link Images and/or Videos
  • Attachments (Images/Videos) included in activities, comments, announcements and chat messages

The media files will be archived in one or multiple tar files of max 2GB each.

The structure of the package will be like this: 

/[APP_ID]/
│
├── ACTIVITY_FEED/: media attachments in activities and comments. 
│   └── [ACTIVITY_ID]/
│       ├── images as png
│       └── videos as mp4, animated gif and jpg thumbnail
│
├── CHAT/: media attachments in chat messages. 
│   └── [CHAT_MESSAGE_ID]/
│       ├── images as png
│       └── videos as mp4, animated gif and jpg thumbnail
│
├── STICKY_ACTIVITY/: media attachments in announcements. 
│   └── app/
│       ├── images as jpg
│       └── videos as mp4, animated gif and jpg thumbnail
│
├── CUSTOM_INVITE_IMAGE/: media included in custom smart invites and smart links.
│   └── app/
│       ├── images as jpg
│       └── videos as mp4, animated gif and jpg thumbnail
│
├── INVITE_IMAGE/: default media included in the smart invites and smart links.
│   └── app/
│       ├── images as jpg
│       └── videos as mp4, animated gif and jpg thumbnail
│
├── LANDING_PAGE/: default media included in the landing page.
│   └── app/
│       ├── images as jpg
│       └── videos as mp4, animated gif and jpg thumbnail
│
├── THUMB_LANDING_PAGE/: default media included in the landing page, thumbnail version
│   └── app/
│       └── images as jpg
│
├── NOTIFICATION_MEDIA/: media included in notifications
│   └── [USER_ID]/
│       ├── images as png
│       └── videos as mp4, animated gif and jpg thumbnail
│
└── USER_AVATAR/: user avatars.
    └── [USER_ID]/
        └── images as png

The structure is aligned with the URL format from any media URL included in the rest of the exported data.

For example, a user avatar that is publicly available here:

https://cdn.getsocial.im/21208109381005007/USER_AVATAR/623136439356529688/bb60a0bc6958c27571a5c75506185625.png

will be found in the archive under:

/21208109381005007/USER_AVATAR/623136439356529688/bb60a0bc6958c27571a5c75506185625.png

Additional Data Structures

Activity Content

The Content of the activity is exported as a JSON string with the following structure:

{
    "en": {
        "text": "This is the content in English",
        "attachments": [
            {
                "imageUrl": "https://cdn.getsocial.im/image1.jpg"
            },
            {
                "videoUrl": "https://cdn.getsocial.im/video.mp4"
            }
        ]
    },
    "de": {
        "text": "Dies ist der Inhalt in Englisch",
        "attachments": [
            {
                "imageUrl": "https://cdn.getsocial.im/image1.jpg"
            },
            {
                "videoUrl": "https://cdn.getsocial.im/video.mp4"
            }
        ]
    }
}

It consists of a map of languages using the ISO code and for each of the languages there is a text and an array of attachments, each containing either imageUrl or videoUrl or both in case the the video has a thumbnail.

Poll Options

The Poll Options of the activity is exported as a JSON string with the following structure:

[
    {
        "id": "79d49064",
        "content": {
            "en": {
                "text": "Option One",
                "attachment": {
                    "imageUrl": "https://cdn.getsocial.im/image.jpg",
                    "videoUrl": "https://cdn.getsocial.im/video.mp4"
                }
            },
            "de": {
                "text": "Option eins",
                "attachment": {
                    "imageUrl": "https://cdn.getsocial.im/image.jpg",
                    "videoUrl": "https://cdn.getsocial.im/video.mp4"
                }
            }
        }
    },
    {
        "id": "b177d4e6",
        "content": {
            "en": {
                "text": "Option Two",
                "attachment": {
                    "imageUrl": "https://cdn.getsocial.im/image.jpg"
                }
            },
            "de": {
                "text": "Option zwei",
                "attachment": {
                    "imageUrl": "https://cdn.getsocial.im/image.jpg"
                }
            }
        }
    }
]

It consists of a sorted array of options, each of them with an unique id and content. The content of each poll option contains a map of languages using the ISO code and for each of the languages there is a text and an attachment, object containing either imageUrl or videoUrl or both in case the the video has a thumbnail.

Permissions

The Permissions of a topic/group is exported as a JSON string with the following structure:

{
    "feed.post": "owner",
    "feed.read": "everyone",
    "feed.post.interact": "owner"
}

It consists of a permissions map where the key is the permission and the value is the lowest type of user role that is allowed to do that action.

The permissions available are:

  • feed.post: who can post activities
  • feed.read: who can read activities
  • feed.post.interact: who can either comment or react to activities

And the possible user roles, in order, are:

  • owner: creator of the Topic or the Group
  • admin: admin added by the owner (only available for Groups)
  • member: any member added by the owner or admins (only available for Groups)
  • followers: any follower
  • everyone: anyone else

Setting a permission to followers means that the action is allowed to followers and any of the roles above (member, admin, owner)

Give us your feedback! Was this article helpful?

😀 🙁