The Compass REST API

Metrics

This resource represents metrics. Use this resource to send metric values into a component's metric source.

Send metric value

POST /gateway/api/compass/v1/metrics

Sends a metric value into a metric source for a component. This API is rate limited. Only 100 requests per user per minute are allowed.

Request

Body parameters

Content type	Value
application/json	oneOf [allOf [InsertMetricRequestDto, object], allOf [InsertMetricRequestDto, object]]

Example

cURL

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/metrics' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}'

Responses

200

400

404

429

Returned if the request is successful.

Content type	Value
application/json	InsertMetricResponseDto