Business Events API v2
POST Business Events
Ingests a business event.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/bizevents/ingest |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/bizevents/ingest |
Authentication
To execute this request, you need an access token with bizevents.ingest
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | Cloud | The Business Event | body | required |
Request body objects
The CloudEvent
object
CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.
Element | Type | Description | Required |
---|---|---|---|
data | object | - | optional |
data_base64 | string | - | optional |
datacontenttype | string | - | optional |
dataschema | string | - | optional |
dtcontext | string | Dynatrace context | optional |
id | string | - | required |
source | string | - | required |
specversion | string | - | required |
subject | string | - | optional |
time | string | - | optional |
traceparent | string | Trace related to this event. See distributed tracing for further information. | optional |
type | string | - | required |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"specversion": "1.0","id": "1","source": "custom.source","type": "com.mycompany.shop.checkout","dtcontext": "dt.session_id=\"234234234324235345345\",dt.entity.rum_application=\"APPLICATION-53453458340758\",host.name=\"123.123.123.123\"","dataschema": "http://dynatrace.com/schema/bizevents/generic/1.0","traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00","data": {"id": "OR-838475","paymentType": "paypal","plannedDeliveryDate": "01.01.2021","total": 234}}
Responses
Response codes
Code | Type | Description |
---|---|---|
202 | - | The provided business events are all accepted and will be processed. |
400 | Biz | Some business events are invalid. Valid business events are accepted and will be processed. |
413 | Biz | Content too large |
429 | Biz | Too many requests |
503 | Biz | Service is temporarily unavailable |
4XX | Error | Client side error. |
5XX | Error | Server side error. |