Metrics API - POST ingest data points

Pushes custom data points to Dynatrace.

You can access the ingested datapoints via:

Provided data points must follow the Metrics ingestion protocol. You don't have to register the metric first. After Dynatrace has ingested and processed the data, you can use it just like any other metrics in Dynatrace, such as in charts or metric events. You can also provide metadata for the ingested metric via the Settings API.

You can also push the data points directly from a OneAgent-monitored host to the Extensions Execution Controller (EEC) OneAgent module over a secure channel using the local http://localhost:<port>/metrics/ingest endpoint, which doesn't require token authentication. The default port is 14499. Using this method, the Dynatrace reserved dt.entity.host=<host-ID> dimension is added to each metric.

You can use the dimension dt.process.id=<PID> to add a process group identifier dimension. When the process group identifier is provided, dt.entity.process_group_instance dimension will be added to a given metric. It works on OneAgent metrics ingest only via dynatrace_ingest API.

For more information, see OneAgent metric API.

You can't ingest metrics with key prefix of dt.—these are reserved for usage by Dynatrace.

The request consumes a text/plain payload. The payload is limited to 1 MB.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/metrics/ingest

Authentication

To execute this request, you need an access token with metrics.ingest scope.

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

Parameters

Parameter
Type
Description
In
Required
body
string

Data points, provided in the line protocol. Each line represents a single data point.

body
required

Request body objects

The RequestBody object

Response

Response codes

Code
Type
Description
202

The provided metric data points are accepted and will be processed in the background.

400

Some data points are invalid. Valid data points are accepted and will be processed in the background.

4XX

Client side error.

5XX

Server side error.

Example

With this curl command, you'll ingest the cpu.temperature metric assigned to the HOST-06F288EE2A930951 dimension.

curl -L -X POST 'https://mySampleEnv.live.dynatrace.com/api/v2/metrics/ingest' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: text/plain' \
--data-raw 'cpu.temperature,dt.entity.host=HOST-06F288EE2A930951,cpu=1 55'

Related topics