List health metrics - Agile Tools Docs

GET

/

v1

/

public

/

health-metrics

List health metrics

curl --request GET \
  --url https://api.agile-tools.io/v1/public/health-metrics \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.agile-tools.io/v1/public/health-metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agile-tools.io/v1/public/health-metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agile-tools.io/v1/public/health-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.agile-tools.io/v1/public/health-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "9d404af5-b668-4514-8fd6-530bdf856676",
      "metricId": "c2f8338c-0d9f-4ad2-b653-96251c0a5de4",
      "metricName": "Team Health Pulse",
      "templateId": "a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592",
      "dataPeriod": "MONTH",
      "aggregationType": "AVG",
      "criteriaType": "INCREASE"
    }
  ],
  "meta": {
    "requestId": "f056699e-497d-41d9-a877-d7c862de6587",
    "timestamp": "2026-05-13T12:08:00Z"
  }
}

Authorizations

X-API-Key

string

header

required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Query Parameters

caretakerId

string

endDateMax

string<date>

Example:

"2022-03-10"

endDateMin

string<date>

Example:

"2022-03-10"

scopeId

string

scopeType

enum<string>

Available options:

TEAM,

ORG_UNIT,

VALUE_UNIT,

STRATEGIC_CONCEPT,

PERSON,

CLIENT_PROJECT,

ORGANIZATION,

TIMESHEET

Response

200 - application/json

Health metrics listed

id

string

metricId

string

metricName

string

templateId

string

unitId

string

dataPeriod

enum<string>

Available options:

DAY,

MONTH,

QUARTER,

YEAR

aggregationType

enum<string>

Available options:

AVERAGE,

SUM,

GEOMETRIC_MEAN,

LAST_VALUE

criteriaType

enum<string>

Available options:

BASELINE,

INCREASE,

DECREASE,

MAINTAIN,

MILESTONE,

PERCENTAGE

initialValue

number

targetValue

number

endingPeriodType

enum<string>

Available options:

DAY,

MONTH,

QUARTER,

FOUR_MONTHS,

SIX_MONTHS,

YEAR,

TWO_YEARS,

THREE_YEARS,

FIVE_YEARS,

CUSTOM

endingPeriodStartsAt

string<date>

Example:

"2022-03-10"

endingPeriodEndsAt

string<date>

Example:

"2022-03-10"

scoringType

enum<string>

Available options:

NO_ZONES,

TWO_ZONES_YES_NO,

TWO_ZONES_YES_NO_ASPIRATIONAL,

TWO_ZONES,

TWO_ZONES_ASPIRATIONAL,

TWO_ZONES_BEST_WORST,

THREE_ZONES,

THREE_ZONES_BEST_WORST,

FOUR_ZONES_ASPIRATIONAL,

FOUR_ZONES_SOFT_ORANGE,

FOUR_ZONES_SOFT_GREEN,

THREE_ZONES_MAINTAIN,

FIVE_ZONES_MAINTAIN

scoringThresholds

number[]

caretakerIds

string[]

autoCreatedFromId

string

autoCreatedAfterKpi

boolean

creationTimestamp

string<date-time>

Example:

"2022-03-10T16:15:50Z"

updatedAt

string<date-time>

Example:

"2022-03-10T16:15:50Z"

List health metrics

curl --request GET \
  --url https://api.agile-tools.io/v1/public/health-metrics \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.agile-tools.io/v1/public/health-metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agile-tools.io/v1/public/health-metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agile-tools.io/v1/public/health-metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.agile-tools.io/v1/public/health-metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "9d404af5-b668-4514-8fd6-530bdf856676",
      "metricId": "c2f8338c-0d9f-4ad2-b653-96251c0a5de4",
      "metricName": "Team Health Pulse",
      "templateId": "a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592",
      "dataPeriod": "MONTH",
      "aggregationType": "AVG",
      "criteriaType": "INCREASE"
    }
  ],
  "meta": {
    "requestId": "f056699e-497d-41d9-a877-d7c862de6587",
    "timestamp": "2026-05-13T12:08:00Z"
  }
}