Settings API - Capture business events with OneAgent schema table

Capture business events with OneAgent (builtin:bizevents.http.incoming)

OneAgent can capture business events from incoming HTTP requests. To activate this feature, add capture rules below.

Capture rules tell OneAgent to capture business events when specific webservices or endpoints are called. A capture rule consists of trigger rules, mandatory business event information (e.g. type and provider) and optional event data fields. A trigger defines the criteria that, when met, cause a business event to be captured (e.g. endpoint “/api/buy” is called). By adding event data fields to your business event, you can extract data directly from the incoming request payload. To limit the scope of a capture rule to a certain Host-Group or Host, create the rule directly in the Host-Group or Host setting screen.

Learn more by visiting our documentation.

Schema ID
Schema groups
Scope
builtin:bizevents.http.incoming
  • group:business-analytics.business-events-sources
  • group:business-analytics
HOST - Host
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:bizevents.http.incoming
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:bizevents.http.incoming
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:bizevents.http.incoming

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
Type
Description
Required
Enabled
enabled
boolean
-
required
Rule name
ruleName
text
-
required
Triggers
triggers

Define conditions to trigger business events from incoming web requests. Triggers are connected by AND logic per capture rule. If you set multiple trigger rules, all of them need to be fulfilled to capture a business event.

required
Event meta data
event
-
required
The MatcherComplex object
Property
Type
Description
Required
source
-
required
Operator
type
enum
  • EQUALS
  • N_EQUALS
  • STARTS_WITH
  • N_STARTS_WITH
  • ENDS_WITH
  • N_ENDS_WITH
  • CONTAINS
  • N_CONTAINS
  • EXISTS
  • N_EXISTS
required
Value
value
text
-
required
Case sensitive
caseSensitive
boolean
-
required
The EventComplex object
Property
Type
Description
Required
provider

Event provider

required
type

Event type

required
category

Event category

required
Event data
data

Additional attributes for the business event.

required
The DataSourceComplex object
Property
Type
Description
Required
Data source
dataSource
enum
  • request.path
  • request.url
  • request.method
  • request.headers
  • request.parameters
  • request.body
  • response.body
  • response.headers
  • response.statusCode
required
Path
path
text
required
The EventAttributeComplex object
Property
Type
Description
Required
Data source
sourceType
enum
  • request.path
  • request.url
  • request.method
  • request.headers
  • request.parameters
  • request.body
  • response.body
  • response.headers
  • response.statusCode
  • constant.string
required
Fixed value
source
text
-
required
Path
path
text
required
The EventCategoryAttributeComplex object
Property
Type
Description
Required
Data source
sourceType
enum
  • request.path
  • request.url
  • request.method
  • request.headers
  • request.parameters
  • request.body
  • response.body
  • response.headers
  • response.statusCode
  • constant.string
required
Fixed value
source
text
-
required
Path
path
text
required
The EventDataFieldComplex object
Property
Type
Description
Required
Field name
name
text

Field name to be added to data.

required
source
-
required
The EventDataAttributeComplex object
Property
Type
Description
Required
Data source
sourceType
enum
  • request.path
  • request.url
  • request.method
  • request.headers
  • request.parameters
  • request.body
  • response.body
  • response.headers
  • response.statusCode
  • constant.string
required
Fixed value
source
text
-
required
Path
path
text
required