Metrics

Postman Collection

OpenAPI

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

Operations

POST/compass/v1/metrics

POST

Send metric value

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

Request bodyapplication/json

oneOf [allOf [InsertMetricRequestDto, object], allOf [InsertMetricRequestDto, object]]

InsertMetricRequestDto

object

InsertMetricRequestDto

object

Responses

Returned if the request is successful.

application/json

InsertMetricResponseDto

The metric value that was sent into the metric source.

POST/compass/v1/metrics

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 '{}'

200Response

{
  "metricSourceId": "<string>",
  "value": 24,
  "timestamp": "<string>"
}