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 IDSchema groupsScope
builtin:elasticsearch.user-session-export-settings-v2
  • group:integration.external
  • group:integration
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:elasticsearch.user-session-export-settings-v2
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:elasticsearch.user-session-export-settings-v2
Environment ActiveGatehttps://{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

PropertyTypeDescriptionRequired
Define your endpoint
endpointDefinition		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
Send data directly to Elasticsearch
sendDirect		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
Export scope, alerting, and advanced configuration
exportBehavior		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
The EndpointDefinition object
PropertyTypeDescriptionRequired
Endpoint URL
endpointUrl		text-required
Enable user session export
enableUserSessionExport		boolean-required
Content type
contentType		text-required
Use POST method (instead of PUT)
usePost		boolean-required
The Authentication object
PropertyTypeDescriptionRequired
Activate
active		boolean-required
Authentication type
authType		enum
  • basic
  • oauth2
required
Basic authentication
basicAuth		BasicAuth-required
OAuth 2.0 (Early Adopter)
oAuth2		OAuth2-required
The SendDirect object
PropertyTypeDescriptionRequired
Activate
active		boolean-required
Name of the index where data is sent
indexName		text-required
Type of documents in the Elasticsearch index
docType		text-optional
The ExportBehavior object
PropertyTypeDescriptionRequired
Management zone
managementZone		setting

Restrict exported sessions to management zone

optional
Disable notification
disableNotification		boolean-required
Custom configuration properties
customConfiguration		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
The BasicAuth object
PropertyTypeDescriptionRequired
User name
username		text-required
Password
password		secret-required
The OAuth2 object
PropertyTypeDescriptionRequired
Grant type
grantType		enum
  • clientCredentials
required
Access token URL
accessTokenUrl		text-required
Client ID
clientId		text-required
Client secret
clientSecret		secret-required
Scope
scope		text

The scope of access you are requesting

optional
Send credentials
sendCredentials		enum
  • header
required