Getting settings

Gets the current Data Stream export settings.

Request format

GET /management/v1/application/{id}/datastream/settings

id App ID.

Response format

{
    "settings": {
        "ui_checkbox_enabled": boolean,
        "export_fields": [
            {
                "data_type": string,
                "enabled": boolean,
                "export_format": string,
                "fields": [
                    "publisher_name",
                    "publisher_id",
                    "tracker_name",
                    "tracking_id",
                    "click_timestamp",
                    ...
                ],
                "include_events": [],
                "exclude_events": []
            },
            {
                "data_type": string,
                "enabled": boolean,
                "export_format": string,
                "fields": [
                    "profile_id",
                    "os_name",
                    "event_name",
                    "event_json",
                    "event_timestamp",
                    ...
                ],
                "include_events": [
                    "My Helpful Event 1",
                    "My Helpful Event 2",
                    ...
                ],
                "exclude_events": [
                    "Ignored Event 1",
                    "Ignored Event 2",
                    ...
                ]
            }
        ]
    }
}
Copied to clipboard

settings

API response.

ui_checkbox_enabled

Indicates whether the entire Data Stream is enabled for the app.

export_fields

List of export setting objects. One setting object corresponds to one type of exported data.

data_type

Data type for export.

Acceptable values:

event.
installation.
session_start.
push_token.
crash.
error.

enabled

Indicates whether export is enabled for the specified data type.

export_format

Data export format. Acceptable values: csv, json.

fields

List of string names of fields selected for export. For more information about the fields, see Data types for export.

include_events

“White list” of event names. If the list isn't empty, only events whose event_name are in the list will be exported. Limit: 10 thousand items.

exclude_events

“Black list” of event names. Those events whose event_name are in the list will be excluded from export. Limit: 10 thousand items.

Example

Request:

curl -X GET '/management/v1/application/1111/datastream/settings' \
-H 'Authorization: OAuth oauth_token'
Copied to clipboard

Response:

{
    "settings": {
        "ui_checkbox_enabled": true,
        "export_fields": [
            {
                "data_type": "installation",
                "enabled": true,
                "export_format": "csv",
                "fields": [
                    "publisher_name",
                    "publisher_id",
                    "tracker_name",
                    "tracking_id",
                    "click_timestamp",
                    ...
                ],
                "include_events": [],
                "exclude_events": []
            },
            {
                "data_type": "event",
                "enabled": true,
                "export_format": "csv",
                "fields": [
                    "profile_id",
                    "os_name",
                    "event_name",
                    "event_json",
                    "event_timestamp",
                    ...
                ],
                "include_events": [
                    "My Helpful Event 1",
                    "My Helpful Event 2",
                    ...
                ],
                "exclude_events": [
                    "Ignored Event 1",
                    "Ignored Event 2",
                    ...
                ]
            }
        ]
    }
}
Copied to clipboard