Settings API - User session exports schema table
User session exports (builtin:elasticsearch.user-session-export-settings-v2)
A user session export enables you to stream real user monitoring data from Dynatrace to an external data source where it can be leveraged as input for big data analytics, or for extending data retention.
Streamed data includes all user sessions, user actions, events, and high-level timing and error data.
Use your existing analytics infrastructure to perform ad-hoc analysis on large numbers of user sessions, and combine this data with data mined from other sources.
Once enabled, user session export automatically sends JSON data for all monitored user sessions in your environment to the configured HTTPS endpoint.
You can also filter on a management zone per user session export. You can define up to three user session exports to send specific data to different endpoints.
For complete details, visit Configure user session exports.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:elasticsearch.user-session-export-settings-v2 |
| environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:elasticsearch.user-session-export-settings-v2 |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:elasticsearch.user-session-export-settings-v2 | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:elasticsearch.user-session-export-settings-v2 |
Authentication
To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| endpointDefinition | Define your endpoint | EndpointDefinition | Dynatrace will send JSON data periodically to this endpoint. You can also pause and disable an endpoint to stop the data stream from Dynatrace to your endpoint. | required |
| authentication | Authentication | Authentication | Dynatrace can automatically send bulk data to Elasticsearch. You can use an SSL certificate, basic authentication or OAuth 2.0 to secure access. For Dynatrace SaaS installations, the Elasticsearch instance must be publicly reachable by the Dynatrace Cluster. | required |
| sendDirect | Send data directly to Elasticsearch | SendDirect | Activate this if you want to export user session data to your own Elasticsearch cluster. If you run Elasticsearch 7, make sure to enter _doc as the type. For Elasticsearch 8 omit the type. If you really want to use a type, then you have to add include_type_name=true when creating your Elasticsearch index. See more information in the Dynatrace help. | required |
| exportBehavior | Export scope, alerting, and advanced configuration | ExportBehavior | Define the scope of your export by using a specific management zone. You can also disable UI notifications for failing exports, or add special settings provided by Dynatrace support for troubleshooting. | required |
Request body objects
The EndpointDefinition object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| endpointUrl | Endpoint URL | text | - | required |
| enableUserSessionExport | Enable user session export | boolean | - | required |
| contentType | Content type | text | - | required |
| usePost | Use POST method (instead of PUT) | boolean | - | required |
The BasicAuth object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| username | User name | text | - | required |
| password | Password | secret | - | required |
The OAuth2 object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| grantType | Grant type | enum | - | required |
| accessTokenUrl | Access token URL | text | - | required |
| clientId | Client ID | text | - | required |
| clientSecret | Client secret | secret | - | required |
| scope | Scope | text | The scope of access you are requesting | optional |
| sendCredentials | Send credentials | enum | - | required |
The Authentication object
The SendDirect object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| active | Activate | boolean | - | required |
| indexName | Name of the index where data is sent | text | - | required |
| docType | Type of documents in the Elasticsearch index | text | - | optional |
The ExportBehavior object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| managementZone | Management zone | text | Restrict exported sessions to management zone | optional |
| disableNotification | Disable notification | boolean | - | required |
| customConfiguration | Custom configuration properties | text | Here you can set additional properties for this export configuration. Changing these values might only be necessary in some rare cases. Please contact support before changing this field. | optional |