Read key result - Agile Tools Docs

GET

/

v1

/

public

/

key-results

/

{id}

Read key result

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

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

fetch('https://api.agile-tools.io/v1/public/key-results/{id}', 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/key-results/{id}",
  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/key-results/{id}"

	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/key-results/{id}")

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

{
  "id": "3f1d2f9f-df66-4f3c-b4c0-f6a4dc1f8c90",
  "name": "Increase activation"
}

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.

Path Parameters

id

string

required

Pattern: [^\s_]\S*

Query Parameters

expand

string

Optional comma-separated expansions. Allowed values: currentPeriod, steps, latestNote.

lastPeriodCount

integer<int32>

Required range: x <= 10

Response

Key result returned

id

string

status

enum<string>

Available options:

DRAFT,

PUBLISHED,

ACTIVE,

ABANDONED,

COMPLETED

modificationStatus

enum<string>

Available options:

NOT_MODIFIED,

PENDING,

MODIFIED

currentPeriod

object

Show child attributes

confidence

enum<string>

Available options:

LOW,

MEDIUM,

HIGH

confidenceSource

enum<string>

Available options:

IMPLICIT,

CHECK_IN

checkInStats

object

Show child attributes

clonedFrom

object

Show child attributes

goal

object

Show child attributes

name

string

context

string

steps

object[]

Show child attributes

percentageItems

integer<int32>

latestNote

object

Show child attributes

Read key result

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

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

fetch('https://api.agile-tools.io/v1/public/key-results/{id}', 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/key-results/{id}",
  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/key-results/{id}"

	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/key-results/{id}")

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

{
  "id": "3f1d2f9f-df66-4f3c-b4c0-f6a4dc1f8c90",
  "name": "Increase activation"
}