Create health metric

POST

public

health-metrics

curl --request POST \
  --url https://api.agile-tools.io/v1/public/health-metrics \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "scopeType": "GOAL",
  "scopeId": "1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122",
  "templateId": "a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592",
  "dataPeriod": "MONTH",
  "aggregationType": "AVG",
  "criteriaType": "INCREASE",
  "initialValue": 2,
  "targetValue": 4,
  "endingPeriodType": "MONTH",
  "endingPeriodStartsAt": "2026-01-01",
  "endingPeriodEndsAt": "2026-12-31",
  "scoringType": "SCORES_1_5",
  "scoringThresholds": [
    1,
    2,
    3,
    4,
    5
  ],
  "caretakerIds": [
    "a1585ef9-9a3e-4f81-9e66-efe8f407f95d"
  ]
}
'

import requests

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

payload = {
    "scopeType": "GOAL",
    "scopeId": "1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122",
    "templateId": "a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592",
    "dataPeriod": "MONTH",
    "aggregationType": "AVG",
    "criteriaType": "INCREASE",
    "initialValue": 2,
    "targetValue": 4,
    "endingPeriodType": "MONTH",
    "endingPeriodStartsAt": "2026-01-01",
    "endingPeriodEndsAt": "2026-12-31",
    "scoringType": "SCORES_1_5",
    "scoringThresholds": [1, 2, 3, 4, 5],
    "caretakerIds": ["a1585ef9-9a3e-4f81-9e66-efe8f407f95d"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scopeType: 'GOAL',
    scopeId: '1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122',
    templateId: 'a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592',
    dataPeriod: 'MONTH',
    aggregationType: 'AVG',
    criteriaType: 'INCREASE',
    initialValue: 2,
    targetValue: 4,
    endingPeriodType: 'MONTH',
    endingPeriodStartsAt: '2026-01-01',
    endingPeriodEndsAt: '2026-12-31',
    scoringType: 'SCORES_1_5',
    scoringThresholds: [1, 2, 3, 4, 5],
    caretakerIds: ['a1585ef9-9a3e-4f81-9e66-efe8f407f95d']
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scopeType' => 'GOAL',
    'scopeId' => '1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122',
    'templateId' => 'a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592',
    'dataPeriod' => 'MONTH',
    'aggregationType' => 'AVG',
    'criteriaType' => 'INCREASE',
    'initialValue' => 2,
    'targetValue' => 4,
    'endingPeriodType' => 'MONTH',
    'endingPeriodStartsAt' => '2026-01-01',
    'endingPeriodEndsAt' => '2026-12-31',
    'scoringType' => 'SCORES_1_5',
    'scoringThresholds' => [
        1,
        2,
        3,
        4,
        5
    ],
    'caretakerIds' => [
        'a1585ef9-9a3e-4f81-9e66-efe8f407f95d'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"scopeType\": \"GOAL\",\n  \"scopeId\": \"1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122\",\n  \"templateId\": \"a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592\",\n  \"dataPeriod\": \"MONTH\",\n  \"aggregationType\": \"AVG\",\n  \"criteriaType\": \"INCREASE\",\n  \"initialValue\": 2,\n  \"targetValue\": 4,\n  \"endingPeriodType\": \"MONTH\",\n  \"endingPeriodStartsAt\": \"2026-01-01\",\n  \"endingPeriodEndsAt\": \"2026-12-31\",\n  \"scoringType\": \"SCORES_1_5\",\n  \"scoringThresholds\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ],\n  \"caretakerIds\": [\n    \"a1585ef9-9a3e-4f81-9e66-efe8f407f95d\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agile-tools.io/v1/public/health-metrics")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scopeType\": \"GOAL\",\n  \"scopeId\": \"1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122\",\n  \"templateId\": \"a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592\",\n  \"dataPeriod\": \"MONTH\",\n  \"aggregationType\": \"AVG\",\n  \"criteriaType\": \"INCREASE\",\n  \"initialValue\": 2,\n  \"targetValue\": 4,\n  \"endingPeriodType\": \"MONTH\",\n  \"endingPeriodStartsAt\": \"2026-01-01\",\n  \"endingPeriodEndsAt\": \"2026-12-31\",\n  \"scoringType\": \"SCORES_1_5\",\n  \"scoringThresholds\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ],\n  \"caretakerIds\": [\n    \"a1585ef9-9a3e-4f81-9e66-efe8f407f95d\"\n  ]\n}")
  .asString();

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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scopeType\": \"GOAL\",\n  \"scopeId\": \"1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122\",\n  \"templateId\": \"a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592\",\n  \"dataPeriod\": \"MONTH\",\n  \"aggregationType\": \"AVG\",\n  \"criteriaType\": \"INCREASE\",\n  \"initialValue\": 2,\n  \"targetValue\": 4,\n  \"endingPeriodType\": \"MONTH\",\n  \"endingPeriodStartsAt\": \"2026-01-01\",\n  \"endingPeriodEndsAt\": \"2026-12-31\",\n  \"scoringType\": \"SCORES_1_5\",\n  \"scoringThresholds\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ],\n  \"caretakerIds\": [\n    \"a1585ef9-9a3e-4f81-9e66-efe8f407f95d\"\n  ]\n}"

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

{
  "data": {
    "id": "9d404af5-b668-4514-8fd6-530bdf856676",
    "metricName": "Team Health Pulse",
    "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.

Body

application/json

Create payload for a health metric. Resolve scope and template ids before creating.

scopeType

enum<string>

required

Available options:

TEAM,

ORG_UNIT,

VALUE_UNIT,

STRATEGIC_CONCEPT,

PERSON,

CLIENT_PROJECT,

ORGANIZATION,

TIMESHEET

scopeId

string

required

Pattern: \S

templateId

string

required

Pattern: \S

dataPeriod

enum<string>

required

Available options:

DAY,

MONTH,

QUARTER,

YEAR

aggregationType

enum<string>

required

Available options:

AVERAGE,

SUM,

GEOMETRIC_MEAN,

LAST_VALUE

criteriaType

enum<string>

required

Available options:

BASELINE,

INCREASE,

DECREASE,

MAINTAIN,

MILESTONE,

PERCENTAGE

initialValue

number

required

targetValue

number

required

endingPeriodType

enum<string>

required

Available options:

DAY,

MONTH,

QUARTER,

FOUR_MONTHS,

SIX_MONTHS,

YEAR,

TWO_YEARS,

THREE_YEARS,

FIVE_YEARS,

CUSTOM

endingPeriodStartsAt

string<date>

required

Example:

"2022-03-10"

endingPeriodEndsAt

string<date>

required

Example:

"2022-03-10"

scoringType

enum<string>

required

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[]

required

unitId

string

caretakerIds

string[]

Maximum array length: 2

autoResolveConflicts

boolean

Optional flag to auto-resolve conflicting health metric periods during create.

Response

Health metric created

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"

Create health metric

curl --request POST \
  --url https://api.agile-tools.io/v1/public/health-metrics \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "scopeType": "GOAL",
  "scopeId": "1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122",
  "templateId": "a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592",
  "dataPeriod": "MONTH",
  "aggregationType": "AVG",
  "criteriaType": "INCREASE",
  "initialValue": 2,
  "targetValue": 4,
  "endingPeriodType": "MONTH",
  "endingPeriodStartsAt": "2026-01-01",
  "endingPeriodEndsAt": "2026-12-31",
  "scoringType": "SCORES_1_5",
  "scoringThresholds": [
    1,
    2,
    3,
    4,
    5
  ],
  "caretakerIds": [
    "a1585ef9-9a3e-4f81-9e66-efe8f407f95d"
  ]
}
'

import requests

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

payload = {
    "scopeType": "GOAL",
    "scopeId": "1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122",
    "templateId": "a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592",
    "dataPeriod": "MONTH",
    "aggregationType": "AVG",
    "criteriaType": "INCREASE",
    "initialValue": 2,
    "targetValue": 4,
    "endingPeriodType": "MONTH",
    "endingPeriodStartsAt": "2026-01-01",
    "endingPeriodEndsAt": "2026-12-31",
    "scoringType": "SCORES_1_5",
    "scoringThresholds": [1, 2, 3, 4, 5],
    "caretakerIds": ["a1585ef9-9a3e-4f81-9e66-efe8f407f95d"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scopeType: 'GOAL',
    scopeId: '1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122',
    templateId: 'a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592',
    dataPeriod: 'MONTH',
    aggregationType: 'AVG',
    criteriaType: 'INCREASE',
    initialValue: 2,
    targetValue: 4,
    endingPeriodType: 'MONTH',
    endingPeriodStartsAt: '2026-01-01',
    endingPeriodEndsAt: '2026-12-31',
    scoringType: 'SCORES_1_5',
    scoringThresholds: [1, 2, 3, 4, 5],
    caretakerIds: ['a1585ef9-9a3e-4f81-9e66-efe8f407f95d']
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scopeType' => 'GOAL',
    'scopeId' => '1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122',
    'templateId' => 'a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592',
    'dataPeriod' => 'MONTH',
    'aggregationType' => 'AVG',
    'criteriaType' => 'INCREASE',
    'initialValue' => 2,
    'targetValue' => 4,
    'endingPeriodType' => 'MONTH',
    'endingPeriodStartsAt' => '2026-01-01',
    'endingPeriodEndsAt' => '2026-12-31',
    'scoringType' => 'SCORES_1_5',
    'scoringThresholds' => [
        1,
        2,
        3,
        4,
        5
    ],
    'caretakerIds' => [
        'a1585ef9-9a3e-4f81-9e66-efe8f407f95d'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"scopeType\": \"GOAL\",\n  \"scopeId\": \"1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122\",\n  \"templateId\": \"a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592\",\n  \"dataPeriod\": \"MONTH\",\n  \"aggregationType\": \"AVG\",\n  \"criteriaType\": \"INCREASE\",\n  \"initialValue\": 2,\n  \"targetValue\": 4,\n  \"endingPeriodType\": \"MONTH\",\n  \"endingPeriodStartsAt\": \"2026-01-01\",\n  \"endingPeriodEndsAt\": \"2026-12-31\",\n  \"scoringType\": \"SCORES_1_5\",\n  \"scoringThresholds\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ],\n  \"caretakerIds\": [\n    \"a1585ef9-9a3e-4f81-9e66-efe8f407f95d\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agile-tools.io/v1/public/health-metrics")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scopeType\": \"GOAL\",\n  \"scopeId\": \"1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122\",\n  \"templateId\": \"a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592\",\n  \"dataPeriod\": \"MONTH\",\n  \"aggregationType\": \"AVG\",\n  \"criteriaType\": \"INCREASE\",\n  \"initialValue\": 2,\n  \"targetValue\": 4,\n  \"endingPeriodType\": \"MONTH\",\n  \"endingPeriodStartsAt\": \"2026-01-01\",\n  \"endingPeriodEndsAt\": \"2026-12-31\",\n  \"scoringType\": \"SCORES_1_5\",\n  \"scoringThresholds\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ],\n  \"caretakerIds\": [\n    \"a1585ef9-9a3e-4f81-9e66-efe8f407f95d\"\n  ]\n}")
  .asString();

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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scopeType\": \"GOAL\",\n  \"scopeId\": \"1e65c0f9-8dcf-4e5d-9f11-4f9ecf8aa122\",\n  \"templateId\": \"a1a6f5a0-bf6a-4dcd-b6f2-4a35995eb592\",\n  \"dataPeriod\": \"MONTH\",\n  \"aggregationType\": \"AVG\",\n  \"criteriaType\": \"INCREASE\",\n  \"initialValue\": 2,\n  \"targetValue\": 4,\n  \"endingPeriodType\": \"MONTH\",\n  \"endingPeriodStartsAt\": \"2026-01-01\",\n  \"endingPeriodEndsAt\": \"2026-12-31\",\n  \"scoringType\": \"SCORES_1_5\",\n  \"scoringThresholds\": [\n    1,\n    2,\n    3,\n    4,\n    5\n  ],\n  \"caretakerIds\": [\n    \"a1585ef9-9a3e-4f81-9e66-efe8f407f95d\"\n  ]\n}"

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

{
  "data": {
    "id": "9d404af5-b668-4514-8fd6-530bdf856676",
    "metricName": "Team Health Pulse",
    "criteriaType": "INCREASE"
  },
  "meta": {
    "requestId": "f056699e-497d-41d9-a877-d7c862de6587",
    "timestamp": "2026-05-13T12:08:00Z"
  }
}

API

API Reference

API Guides

CLI

Integration Automation

Support

Authorizations

Body

Response