Changing settings

Changes the current Data Stream export settings.

Request format

POST https://api.appmetrica.yandex.ru/management/v1/application/{id}/datastream/settings

id

App ID.

Request body 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",
                    ...
                ]
            }
        ]
    }
}

`settings`	Object with settings.
`settings.ui_checkbox_enabled`	Indicates whether the entire Data Stream is enabled for the app.
`settings.export_fields`	List of export setting objects. One setting object corresponds to one type of exported data.
`settings.export_fields.data_type`	Data type for export. Acceptable values: `event` `installation` `session_start` `session_end` `push_token` `crash` `error` `click` `revenue` `ecommerce` `ad_revenue`
`settings.export_fields.enabled`	Indicates whether export is enabled for the specified data type.
`settings.export_fields.export_format`	Data export format. Acceptable values: `csv`, `json`.
`settings.export_fields.fields`	Contains a list of sets of CSV fields that were used to generate data windows.
`settings.export_fields.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.
`settings.export_fields.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.

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",
                    ...
                ]
            }
        ]
    }
}

`settings`	API response.
`settings.ui_checkbox_enabled`	Indicates whether the entire Data Stream is enabled for the app.
`settings.export_fields`	List of export setting objects. One setting object corresponds to one type of exported data.
`settings.export_fields.data_type`	The type of data that forms the stream. Acceptable values: `event` `installation` `session_start` `session_end` `push_token` `crash` `error` `click` `revenue` `ecommerce` `ad_revenue`
`settings.export_fields.enabled`	Indicates whether export is enabled for the specified data type.
`settings.export_fields.export_format`	Data export format. Acceptable values: `csv`, `json`.
`settings.export_fields.fields`	Contains a list of sets of CSV fields that were used to generate data windows.
`settings.export_fields.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.
`settings.export_fields.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 POST 'https://api.appmetrica.yandex.ru/management/v1/application/1111/datastream/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: OAuth oauth_token' \
-d '{
    "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",
                    ...
                ]
            }
        ]
    }
}'

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",
                    ...
                ]
            }
        ]
    }
}

If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible.

Contact support

Was the article helpful?

Getting settings

Post API