In addition to the app’s API key you must also provide a personal key to access the export APIs. For more information, see Where do I find my API Key and personal key?

KPI export

The Swrve Export API enables you to export KPI data from the Swrve service. All of the KPI data that is displayed in Swrve is available through this REST API. The data is available in JSON and HTML format. The HTML data produces a table, which is especially useful for performing Excel web queries or for import into Google Spreadsheets. To request JSON data, add .json to the end of the URL. To request HTML data, add .html.

Call all of the API calls below with HTTP GET. All of the URLs share a common root: https://dashboard.swrve.com/api/1/exporter/kpi (or https://eu-dashboard.swrve.com/api/1/exporter/kpi for EU-configured apps).

Get DAU in a specific format:

Common URL parameters

The following parameters are used by all calls in the KPI Exporter API:

Extra parameters

The following parameter is only required for some API calls. The documentation for each call below specifies if these extra parameters are required.

KPIs

Examples

Get DAU for a specific time range:

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
https://dashboard.swrve.com/api/1/exporter/kpi/dau.json

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
https://eu-dashboard.swrve.com/api/1/exporter/kpi/dau.json

Get MAU for the last 60 days (30day_rolling granularity):

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "history=60" https://dashboard.swrve.com/api/1/exporter/kpi/mau.json

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "history=60" https://eu-dashboard.swrve.com/api/1/exporter/kpi/mau.json

Get Currency Spent for the coins currency in the TopPlayers segment:

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "segment=TopPlayers" 
-d "currency=coins" -d "granularity=day" 
https://dashboard.swrve.com/api/1/exporter/kpi/currency_spent.json

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "segment=TopPlayers" 
-d "currency=coins" -d "granularity=day" 
https://eu-dashboard.swrve.com/api/1/exporter/kpi/currency_spent.json

Get Avg Session Length in HTML format, transposed and without data labels:

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
-d "transpose=true" -d "only_data=true" 
https://dashboard.swrve.com/api/1/exporter/kpi/avg_session_length.html

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
-d "transpose=true" -d "only_data=true" 
https://eu-dashboard.swrve.com/api/1/exporter/kpi/avg_session_length.html

Get Day 1 Retention (or Day N Retention):

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
https://dashboard.swrve.com/api/1/exporter/kpi/day1_retention

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
https://eu-dashboard.swrve.com/api/1/exporter/kpi/day1_retention

Get Day7 Retention (or Day N Retention):

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
https://dashboard.swrve.com/api/1/exporter/kpi/day7_retention

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "granularity=day" 
https://eu-dashboard.swrve.com/api/1/exporter/kpi/day7_retention

Get Avg Playtime for last two days in 24hour_rolling granularity:

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "history=48" -d "granularity=24hour_rolling" 
https://dashboard.swrve.com/api/1/exporter/kpi/avg_playtime.json

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "history=48" -d "granularity=24hour_rolling" 
https://eu-dashboard.swrve.com/api/1/exporter/kpi/avg_playtime.json

Error codes

If an error occurs while processing the request, you may receive one or more of the the following error codes and need to make sure your integration is equipped to handle error conditions.

Event export

The Swrve Export API enables you to export event count information from the Swrve service.

The data is available in JSON and HTML format. The HTML data produces a table, which is especially useful for performing Excel web queries or for import into Google Spreadsheets. To request JSON data, add .json to the end of the URL. To request HTML data, add .html.

Call all of the API calls below with HTTP GET. All of the URLs share a common root: https://dashboard.swrve.com/api/1/exporter/event/
(https://eu-dashboard.swrve.com/api/1/exporter/event/)

Common URL parameters

The following parameters are used by all calls in the Event Export API:

Event count

This API call gets the event count for a named event.

URL

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "name=Swrve.session.start" 
https://dashboard.swrve.com/api/1/exporter/event/count

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "name=Swrve.session.start" 
https://eu-dashboard.swrve.com/api/1/exporter/event/count

Event list

This API call gets a list of the event names that have been received by Swrve from the event API. This API should be used to enumerate a list of all event names so that they can be passed to the event count API. This API call supports the JSON and HTML formats like all other calls in the export API. The following parameters are not required: history, start, stop, segment, and granularity.

The output is a list of event names (which match the names set in the incoming event API requests), where event API could be a link to the event API.

URL

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://dashboard.swrve.com/api/1/exporter/event/list

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://eu-dashboard.swrve.com/api/1/exporter/event/list

Payload count

This API call gets the event payload counts for a named event and payload/key pair. This method enables you to export the data buckets that are displayed on the Events Overview screen.

The only granularity supported by this function is day.

URL

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "name=Swrve.session.start" 
-d "payload_key=foo" https://dashboard.swrve.com/api/1/exporter/event/payload

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "name=Swrve.session.start" 
-d "payload_key=foo" https://eu-dashboard.swrve.com/api/1/exporter/event/payload

Payload key list

This API call gets a list of the event payload key names that have been received by Swrve from the event API. Use this API to enumerate a list of all event payload key names so that they can be passed to the payload count API. This API supports the JSON and HTML formats like all other calls in the export API. The following parameters are not needed: history, start, stop, segment, and granularity.

The return value is a list of string names that correspond to the payload_key parameter of named events sent to Swrve using the event API.

URL

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "name=Swrve.session.start" https://dashboard.swrve.com/api/1/exporter/event/payloads

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
-d "name=Swrve.session.start" https://eu-dashboard.swrve.com/api/1/exporter/event/payloads

Error codes

See KPI Export.

User cohorts export

This API call gets the specified cohort_type data for daily cohorts for the days specified. A user cohort represents a section of users who start using the app on a particular day. You can view data for those users for the 30 days after they joined and compare this to other users starting on other days. You can get the following information for any cohort:

• Retention – the number of retained users.
• Avg Sessions – the average number of sessions started per retained user.
• Avg Playtime – the average session length per retained user.
• Avg Revenue – the average revenue generated per retained user.
• Total Revenue – the total revenue generated.

The data is available in JSON and HTML format. The HTML data produces a table, which is especially useful for performing Excel web queries or for import into Google Spreadsheets. To request JSON data, add .json to the end of the URL. To request HTML data, add .html.

Call the API below with HTTP GET. The URL has the root:
https://dashboard.swrve.com/api/1/exporter/cohorts/daily
(https://eu-dashboard.swrve.com/api/1/exporter/cohorts/daily)

Common URL parameters

The following parameters are used by all calls in the User Cohorts Export API:

Example

curl -G -d "cohort_type=retention" -d "api_key=<api key>" 
-d "personal_key=<personal key>" -d "start=2011-06-20" -d "stop=2011-06-22" 
https://dashboard.swrve.com/api/1/exporter/cohorts/daily

curl -G -d "cohort_type=retention" -d "api_key=<api key>" 
-d "personal_key=<personal key>" -d "start=2011-06-20" -d "stop=2011-06-22" 
https://eu-dashboard.swrve.com/api/1/exporter/cohorts/daily

Error codes

See KPI Export.

Item sales export

The Swrve Export API enables you to export item sales data from the Swrve service.

The data is available in JSON and HTML format. The HTML data produces a table, which is especially useful for performing Excel web queries or for import into Google Spreadsheets. To request JSON data, add .json to the end of the URL. To request HTML data, add .html.

Call the API below with HTTP GET. All of the URLs will share a common root:
https://dashboard.swrve.com/api/1/exporter/item/
(https://eu-dashboard.swrve.com/api/1/exporter/item/)

Common URL parameters

The following parameters are used by all calls in the Item Sales Export API:

Extra parameters

The following parameters are only required for some API calls. The documentation for each call below specifies whether these extra parameters are required.

Item sales

This API call gets the sales data of a particular item.

URL

Extra parameters

uid, tag, currency

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "uid=sword" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "segment=Ireland" -d "currency=gold" 
-d "granularity=day" -d "transpose=true" -d "only_data=true" 
https://dashboard.swrve.com/api/1/exporter/item/sales

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "uid=sword" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "segment=Ireland" -d "currency=gold" 
-d "granularity=day" -d "transpose=true" -d "only_data=true" 
https://eu-dashboard.swrve.com/api/1/exporter/item/sales

Item revenue

This API call gets the revenue data of a particular item.

URL

Extra parameters

uid, tag, currency

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "uid=sword" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "segment=Ireland" -d "currency=gold" 
-d "granularity=day" -d "transpose=true" -d "only_data=true" 
https://dashboard.swrve.com/api/1/exporter/item/revenue

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "uid=sword" 
-d "start=2011-06-20" -d "stop=2011-06-22" -d "segment=Ireland" -d "currency=gold" 
-d "granularity=day" -d "transpose=true" -d "only_data=true" 
https://eu-dashboard.swrve.com/api/1/exporter/item/revenue

Item tag

This API call gets the UIDs of all items that are associated with a particular tag.

URL

Extra parameters

tag

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "tag=test_tag" 
-d "transpose=true" -d "only_data=true" 
https://dashboard.swrve.com/api/1/exporter/item/tag

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" -d "tag=test_tag" 
-d "transpose=true" -d "only_data=true" 
https://eu-dashboard.swrve.com/api/1/exporter/item/tag

Error codes

See KPI Export.

Segment list

This API call gets a list of the segment names that have been created for this app. This API supports the JSON and HTML formats like all other calls in the export API. The return value is a list of string names that correspond to the name parameter of segments created for this app.

The data is available in JSON and HTML format. The HTML data produces a table, which is especially useful for performing Excel web queries or for import into Google Spreadsheets. To request JSON data, add .json to the end of the URL. To request HTML data, add .html.

Call the API below with HTTP GET. The URL has the root:
https://dashboard.swrve.com/api/1/exporter/segment/list
(https://eu-dashboard.swrve.com/api/1/exporter/segment/list)

Common URL parameters

The following parameters are used by all calls in the Segment list API:

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://dashboard.swrve.com/api/1/exporter/segment/list

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://eu-dashboard.swrve.com/api/1/exporter/segment/list

Error codes

See KPI Export.

User database export

The User DB Downloads screen enables you to download data sets reflecting different properties of your users. For apps with a large number of users, these data sets are further split into multiple files. The export API for user DB downloads provides a list of all the available data and schema files, enabling you to automate the download of the data sets in which you are interested. For more information about the User DB Downloads screen, see Manually downloading user DBs.

Call this API call with HTTP GET. The URL has the root:
https://dashboard.swrve.com/api/1/userdbs.json
(https://eu-dashboard.swrve.com/api/1/userdbs.json)

Common URL parameters

The following parameters are used by all calls in the User DB Export API:

File list

This API call returns a JSON object that lists the URLs of the various data and schema files for the different data sets. This JSON takes the following format:

{
   "data_files":{
      "items_purchased": ["<DATA_URL_1>", ..., "<DATA_URL_N>"],
      "custom_properties": ["<DATA_URL_1>", ..., "<DATA_URL_N>"],
      "abtest_exposure": ["<DATA_URL_1>", ..., "<DATA_URL_N>"],
      "segment_membership": ["<DATA_URL_1>", ..., "<DATA_URL_N>"],
      "events_fired": ["<DATA_URL_1>", ..., "<DATA_URL_N>"],
      "swrve_events_fired": ["<DATA_URL_1>", ..., "<DATA_URL_N>"], 
      "swrve_properties": ["<DATA_URL_1>", ..., "<DATA_URL_N>"]
},
   "schemas":{
      "redshift":"<SCHEMA_URL_REDSHIFT>",
      "mysql":"<SCHEMA_URL_MYSQL>"
   },
   "date":"<DATE>"
}

where:

• DATA_URL_* is the URL of a Gzipped CSV data file.
• SCHEMA_URL is the URL of an SQL definition file.
• DATE is the date of the latest update.

For example, to download the custom events fired for all users, loop through the data URLs referred to in this JSON contained list:

obj["data_files"]["events_fired"]

You must append your app ID, personal key and API key to the URL of each file request. For example:

https://dashboard.swrve.com/api/1/userdbs/downloads/2020-02-12/all-users_01234_2020-02-12_items_purchased.1_0.1.csv.gz?api_key=<API key>&personal_key=<personal key>

https://eu-dashboard.swrve.com/api/1/userdbs/downloads/2020-02-12/all-users_01234_2020-02-12_items_purchased.1_0.1.csv.gz?api_key=<API key>&personal_key=<personal key>

URL

Example

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://dashboard.swrve.com/api/1/userdbs.json

curl -G -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://eu-dashboard.swrve.com/api/1/userdbs.json

Error codes

See KPI Export.

Campaign metadata

Swrve provides two APIs for mapping tracking events for Swrve campaign touchpoints to the relevant campaign data, such as name, dashboard URL, start date, and so forth.

Depending on the channel and action type, these Swrve campaign events are logged in two formats—Generic or Custom. For more details on which channel/actions map to which format, see Raw event data schema.

Additionally, Swrve provides a third API for mapping in-app message events – click, navigation, and dismiss – to their associated actions, such as deeplink, copy-to-clipboard, page navigation, and permission requests.

Call the API below with HTTP GET. All of the metadata URLs will share a common root:

https://dashboard.swrve.com/api/1/exporter/campaign_meta_data/
(https://eu-dashboard.swrve.com/api/1/exporter/campaign_meta_data/)

Common URL parameters

The following parameters are used by all calls in the Campaign Metadata API:

Generic campaign events API

This is the API for retrieving a mapping between the tracking ID in generic campaign events and campaign metadata.

URL

Example

curl -LOJG --compressed -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://dashboard.swrve.com/api/1/exporter/campaign_meta_data/generic_campaign_events.csv

curl -LOJG --compressed -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://eu-dashboard.swrve.com/api/1/exporter/campaign_meta_data/generic_campaign_events.csv

Tracking ID mapping

This returns a CSV file that maps tracking IDs in generic campaign events to campaign metadata for all campaigns that are scheduled, active, or finished.

By uploading this table into a local store, you can map tracking IDs and campaign types to appropriate contextual information in your local reports.

Each campaign may have more than one tracking ID for platforms, locales, or test variants, where applicable.

The columns in this CSV file are:

The filename format is: campaign-meta-data-generic-<APP_ID>-<CURRENT_DATE>-<RANDOM_STRING>.csv

where:

• APP_ID is the Swrve app ID, as encoded in the Swrve Dashboard URL
• CURRENT_DATE is a date/time-stamp
• RANDOM_STRING is a random string

Example: campaign-meta-data-generic-12345-2020-03-30_14-03-07-31f44b88388852cc.csv

Custom campaign events API

This is the API for retrieving a mapping between the tracking ID in custom campaign events and campaign metadata.

URL

Example

curl -LOJG --compressed -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://dashboard.swrve.com/api/1/exporter/campaign_meta_data/custom_campaign_events.csv

curl -LOJG --compressed -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://eu-dashboard.swrve.com/api/1/exporter/campaign_meta_data/custom_campaign_events.csv

Tracking event mapping

This returns a CSV file mapping custom Swrve campaign events to campaign metadata for all campaigns that are scheduled, active, or finished.

By uploading this table into a local store, you can map these event names to appropriate contextual information in your local reports.

Each campaign may have more than tracking event for platforms, locales, or test variants, where applicable.

This will return a CSV file with the following columns:

The filename format is: campaign-meta-data-custom-<APP_ID>-<CURRENT_DATE>-<RANDOM_STRING>.csv

where:

• APP_ID is the ID of the app as encoded in Swrve dashboard URL
• CURRENT_DATE is a date/time-stamp
• RANDOM_STRING is a random string

Example: campaign-meta-data-custom-12345-2020-03-30_14-03-07-31f44b88388852cc.csv

In-app button metadata API

This is the API for retrieving a mapping between the button ID in events and in-app message button data.

URL

Example

curl -LOJG --compressed -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://dashboard.swrve.com/api/1/exporter/campaign_meta_data/in_app_button_meta_data.csv

curl -LOJG --compressed -d "api_key=<api key>" -d "personal_key=<personal key>" 
https://eu-dashboard.swrve.com/api/1/exporter/campaign_meta_data/in_app_button_meta_data.csv

Button mapping

This returns a CSV file that maps the button IDs in in-app message campaign events to button metadata. The CSV file only includes data for in-app message campaigns that are scheduled active, inactive, or archived.

By uploading this table into a local store and joining with Swrve’s raw event data, you can create your own comprehensive button click report, complete with specific button actions.

The columns in this CSV file are:

The filename format is: campaign-meta-data-in_app_button_meta_data-<APP_ID>-<CURRENT_DATE>-<RANDOM_STRING>.csv

where:

• APP_ID is the ID of the app as encoded in Swrve dashboard URL
• CURRENT_DATE is a date/time-stamp
• RANDOM_STRING is a random string

Example: campaign-meta-data-in_app_button_meta_data-1030-2023-10-19_15-52-11-5de231e0b8802aab.csv

Error codes

See KPI Export.