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.

OAuth scopes required:

NONE

Request

Body parameters

metricSourceId Required

string

The ID of the metric source to send the value into.

value Required

number

The metric value to send.

Format: double

timestamp

string

The time the metric value was collected.

Format: date-time

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 '{
  "metricSourceId": "<string>",
  "value": 25,
  "timestamp": "<string>"
}'

Responses

200

400

404

Returned if the request is successful.

Content type	Value
application/json	InsertMetricResponseDto