OpenPipeline Ingest API - POST Built-in generic events

Latest Dynatrace
Reference
1-min read
Published Aug 02, 2024

Ingests generic events from built-in endpoints.

The request consumes an application/json payload.

POST SaaS https://{your-environment-id}.live.dynatrace.com/platform/ingest/v1/events

Authentication

To execute this request, you need an access token with openpipeline.events scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	Events	The JSON body of the request. Contains the events for ingest.	body	Required

Request body objects

The `Events` object

The events to be ingested. This can either be a list of events, or a single event.

Element	Type	Description	Required
<*>	object[]	List of events that will get ingested.	Optional

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.

[
  {
    "event.id": 1,
    "additionalProp1": "bar",
    "additionalProp2": "foo",
    "additionalProp3": [
      {
        "prop1": "string",
        "prop2": 1
      }
    ]
  },
  {
    "event.id": 2,
    "additionalProp1": 123.45,
    "additionalProp2": "lorem",
    "additionalProp3": [
      {
        "prop1": "string",
        "prop2": 1
      }
    ]
  }
]

Response

Response codes

Code	Type	Description
202	-	Accepted. Response doesn't have a body.
400	ErrorResponseEnvelope	Failed. The input is invalid.
404	ErrorResponseEnvelope	Failed. Endpoint not found.
413	ErrorResponseEnvelope	Failed. Content too large.
429	ErrorResponseEnvelope	Failed. Too many requests.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `ErrorResponseEnvelope` object

Encloses the encountered error.

Element	Type	Description
error	ErrorResponse	Basic information of the encountered error.

The `ErrorResponse` object

Basic information of the encountered error.

Element	Type	Description
code	integer	The returned HTTP status code.
details	ErrorResponseDetails	Detailed information of the error.
message	string	Description of the encountered error.

The `ErrorResponseDetails` object

Detailed information of the error.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constraintViolation` -> ConstraintViolationDetails The element can hold these values `constraintViolation`

Response body JSON models

{
  "error": {
    "code": 400,
    "message": "The input is invalid."
  }
}