Settings API - Capture business events with OneAgent schema table
Capture business events with OneAgent (builtin:bizevents.http.outgoing)
OneAgent can capture business events from outgoing 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.outgoing |
| HOST - HostHOST_GROUP - Host Groupenvironment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:bizevents.http.outgoing |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:bizevents.http.outgoing | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:bizevents.http.outgoing |
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 |
---|---|---|---|
Enabledenabled | boolean | - | required |
Rule nameruleName | text | - | required |
Triggerstriggers | Set<MatcherComplex> | 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 dataevent | EventComplex | - | required |
The MatcherComplex
object
Property | Type | Description | Required |
---|---|---|---|
source | DataSourceComplex | - | required |
Operatortype | enum |
| required |
Valuevalue | text | - | required |
Case sensitivecaseSensitive | boolean | - | required |
The EventComplex
object
Property | Type | Description | Required |
---|---|---|---|
provider | EventAttributeComplex | Event provider | required |
type | EventAttributeComplex | Event type | required |
category | EventCategoryAttributeComplex | Event category | required |
Event datadata | Set<EventDataFieldComplex> | Additional attributes for the business event. | required |
The DataSourceComplex
object
Property | Type | Description | Required |
---|---|---|---|
Data sourcedataSource | enum |
| required |
Pathpath | text | required |
The EventAttributeComplex
object
Property | Type | Description | Required |
---|---|---|---|
Data sourcesourceType | enum |
| required |
Fixed valuesource | text | - | required |
Pathpath | text | required |
The EventCategoryAttributeComplex
object
Property | Type | Description | Required |
---|---|---|---|
Data sourcesourceType | enum |
| required |
Fixed valuesource | text | - | required |
Pathpath | text | required |
The EventDataFieldComplex
object
Property | Type | Description | Required |
---|---|---|---|
Field namename | text | Field name to be added to data. | required |
source | EventDataAttributeComplex | - | required |
The EventDataAttributeComplex
object
Property | Type | Description | Required |
---|---|---|---|
Data sourcesourceType | enum |
| required |
Fixed valuesource | text | - | required |
Pathpath | text | required |