---
metadata:
  - name: generator
    content: Diplodoc Platform v5.50.6
alternate:
  - https://appmetrica.yandex.by/docs/en/mobile-api/datastream/ref/settings.md
  - https://appmetrica.yandex.by/docs/ru/mobile-api/datastream/ref/settings.md
---
> **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.by/docs/en/llms.txt

# Getting settings

Gets the current Data Stream export settings.

## Request format {#request-format}

```
GET https://api.appmetrica.yandex.com/management/v1/application/{id}/datastream/settings
```

#|
|| `id` | App ID ||
|#

## Response format {#output-structure}

```json translate=no
{
    "settings": {
        "ui_checkbox_enabled": boolean,
        "export_fields": [
            {
                "data_type": string,
                "enabled": boolean,
                "export_format": string,
                "fields": ["profile_id", "os_name", "event_name", "event_timestamp", ... ],
                "include_events": ["Useful Event 1", "Useful Event 2", ... ],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2", ... ],
                "event_attribution": string
            },
            ...
        ]
    }
}
```

#|
|| `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[i].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`
- `attributed_event`
- `deeplink`
 ||
|| `settings.export_fields[i].enabled` | Indicates whether export is enabled for the specified data type. ||
|| `settings.export_fields[i].export_format` | Data export format. Acceptable values: `csv`, `json`.
 ||
|| `settings.export_fields[i].fields` | Contains a list of sets of CSV fields that were used to generate data windows. ||
|| `settings.export_fields[i].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[i].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.
 ||
|| `settings.export_fields[i].event_attribution` | The attribution model for the `attributed_event` data type. Acceptable values:
- `first_appmetrica` — "first click" in terms of AppMetrica;
- `last_appmetrica` — "last click" in terms of AppMetrica.

If not specified, the default value `last_appmetrica` is used.
 ||
|#

## Example {#example}

Request:

```bash translate=no
curl -X GET 'https://api.appmetrica.yandex.com/management/v1/application/1111/datastream/settings' \
-H 'Authorization: OAuth oauth_token'
```

Response:

```json translate=no
{
    "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_timestamp"],
                "include_events": ["Useful Event 1", "Useful Event 2"],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2"]
            },
            {
                "data_type": "attributed_event",
                "enabled": true,
                "export_format": "csv",
                "fields": ["attributed_event_type", "event_name", "conversion_id", "conversion_name"],
                "include_events": ["Useful Event 1", "Useful Event 2"],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2"],
                "event_attribution": "last_appmetrica"
            }
        ]
    }
}
```

<!-- source: en/_includes/feedback-button-3.md -->
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.

<a href="../../../troubleshooting/feedback-new">
  <span class="button">Contact support</span>
</a>

<a href="../../../troubleshooting/feedback-docs">
  <span class="button">Suggest an improvement for documentation</span>
</a>
<!-- endsource: en/_includes/feedback-button-3.md -->