API Query methods
W
Written by Weronika Spaleniak
Updated over a week ago

The base url for all API calls is

https://okr-for-jira-prod.herokuapp.com

Query objectives by date

Query for a list of all objectives, which have start date or/and due date inside specified date range.

GET /api/v2/api-export/objectives/byDate

Parameter

Description

Mandatory

startDateEpochMilli

Start date of query time window, in UNIX Epoch time format.

YES

deadlineEpochMilli

End date of query time window, in UNIX Epoch time format.

YES

expand

A list of objects you want to include expanded in reqeust.
By default you receive only ids of connected entities.
Permitted values:
KEY_RESULTS,TEAMS,PERIODS,LABELS

NO

Example request:

GET /api/v2/api-export/objectives/byDate?
startDateEpochMilli=1409459200000
&deadlineEpochMilli=1748647410000
&expand=KEY_RESULTS,TEAMS,PERIODS,LABELS

Example response

{
"okrs": [
{
"id": "5fda249d289742000406b3e4",
"key": "O-2",
"name": "Become more mature company",
"description": "<p>This quarter we will be focusing on improving our performance.</p><p></p>",
"parentObjectiveId": null,
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [],
"percentDone": 8.333333333333332,
"created": "2020-12-16T15:15:41+0000",
"startDate": "2021-01-01T00:00:00+0000",
"deadline": "2021-03-31T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"krIds": [
"605480b190c42b0003385170",
"6061e921e2f4470003bc3210"
],
"childObjectiveIds": [
"5fdb72c63d2cf000035ceb37",
"60743135b347480003dc6a9c",
"61f9367df9aa7f0e4024a6fe"
],
"latestUpdate": {
"entityId": "5fda249d289742000406b3e4",
"status": "ON_TRACK",
"created": "2021-05-05T12:15:14+0000",
"value": null,
"description": ""
},
"periodAliasId": "602a6a2717378700039f342a",
"weight": 0
}
],
"krs": [
{
"id": "605480b190c42b0003385170",
"key": "KR-8",
"name": "new auto KR",
"description": null,
"parentObjectiveId": "5fda249d289742000406b3e4",
"issueIds": [
"10005",
"10006",
"10010"
],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [
"5c12ad9fd3af3b1ccfecbf55"
],
"percentDone": 33.33333333333333,
"created": "2021-03-19T10:45:05+0000",
"startDate": "2021-01-01T00:00:00+0000",
"deadline": "2021-03-31T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342a",
"latestUpdate": {
"entityId": "620ea538512edb00acf67ac1",
"status": "ON_TRACK",
"created": "2022-02-17T19:42:43+0000",
"value": 1.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "AUTO",
"startValue": null,
"desiredValue": null,
"jql": "project= TEST"
},
"weight": 1
},
{
"id": "6061e921e2f4470003bc3210",
"key": "KR-9",
"name": "different start date",
"description": null,
"parentObjectiveId": "5fda249d289742000406b3e4",
"issueIds": [
"10000"
],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2021-03-29T14:50:09+0000",
"startDate": "2020-04-01T00:00:00+0000",
"deadline": "2020-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": null,
"latestUpdate": {
"entityId": "61138f2be5fd454858c3e1ee",
"status": "AT_RISK",
"created": "2021-08-11T08:49:47+0000",
"value": 0.0,
"description": null
},
"unit": {
"name": "USD",
"symbol": "$"
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
}
],
"teams": [],
"periods": [
{
"id": "602a6a2717378700039f342a",
"name": "Q1 Y2021",
"startDate": "2021-01-01T00:00:00+0000",
"deadline": "2021-03-31T23:59:59+0000"
}
],
"labels": []
}


Query objectives by id

Query for a list of all objectives with specified ids.

GET /api/v2/api-export/objectives/byIds

Parameter

Description

Mandatory

objectiveIds

Comma separated list of objective ids you want to receive.

YES

expand

A list of objects you want to include expanded in reqeust.
By default you receive only ids of connected entities.
Permitted values:
KEY_RESULTS,TEAMS,PERIODS,LABELS

NO

Example request:

GET /api/v2/api-export/objectives/byIds?token=cddad774-46b2-4666-b3e2-d5155362cd8e
&expand=OBJECTIVES,KEY_RESULTS,TEAMS,PERIODS,LABELS
&objectiveIds=5fda249d289742000406b3e4,5fdb72c63d2cf000035ceb37

Example response

{
"okrs": [
{
"id": "5fda249d289742000406b3e4",
"key": "O-2",
"name": "Become more mature companybbb",
"description": "<p>This quarter we will be focusing on improving our performance.</p><p></p>",
"parentObjectiveId": null,
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [],
"percentDone": 8.333333333333332,
"created": "2020-12-16T15:15:41+0000",
"startDate": "2021-01-01T00:00:00+0000",
"deadline": "2021-03-31T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"krIds": [
"605480b190c42b0003385170",
"6061e921e2f4470003bc3210"
],
"childObjectiveIds": [
"5fdb72c63d2cf000035ceb37",
"60743135b347480003dc6a9c",
"61f9367df9aa7f0e4024a6fe"
],
"latestUpdate": {
"entityId": "5fda249d289742000406b3e4",
"status": "ON_TRACK",
"created": "2021-05-05T12:15:14+0000",
"value": null,
"description": ""
},
"periodAliasId": "602a6a2717378700039f342a",
"weight": 0
},
{
"id": "5fdb72c63d2cf000035ceb37",
"key": "O-3",
"name": "45",
"description": null,
"parentObjectiveId": "5fda249d289742000406b3e4",
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2020-12-17T15:01:26+0000",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"krIds": [
"5fda249d289742000406b3e5",
"5fdb72c63d2cf000035ceb38",
"5ff445869f8c190003e0e445",
"60bde9dc99b4177c88ad428c"
],
"childObjectiveIds": [],
"latestUpdate": {
"entityId": "5fdb72c63d2cf000035ceb37",
"status": "UNDEFINED",
"created": "2021-08-09T00:00:00+0000",
"value": null,
"description": ""
},
"periodAliasId": "602a6a2717378700039f342c",
"weight": 0
}
],
"krs": [
{
"id": "5fda249d289742000406b3e5",
"key": "KR-2",
"name": "adda",
"description": null,
"parentObjectiveId": "5fdb72c63d2cf000035ceb37",
"issueIds": [
"10003"
],
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2020-12-16T15:15:41+0000",
"startDate": "2021-01-05T00:00:00+0000",
"deadline": "2021-03-28T00:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": null,
"latestUpdate": {
"entityId": "61c993aaa0fd9b768a0fb47d",
"status": "AT_RISK",
"created": "2021-12-27T10:21:30+0000",
"value": 0.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 22.0,
"jql": null
},
"weight": 1
},
{
"id": "5fdb72c63d2cf000035ceb38",
"key": "KR-3",
"name": "12",
"description": null,
"parentObjectiveId": "5fdb72c63d2cf000035ceb37",
"issueIds": [],
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [
"5c12ad9fd3af3b1ccfecbf55"
],
"percentDone": 0.0,
"created": "2020-12-17T15:01:26+0000",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342c",
"latestUpdate": {
"entityId": "5fdb72c63d2cf000035ceb39",
"status": "ON_TRACK",
"created": "2020-12-17T15:00:24+0000",
"value": 1.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 1.0,
"desiredValue": 2.0,
"jql": null
},
"weight": 1
},
{
"id": "5ff445869f8c190003e0e445",
"key": "KR-5",
"name": "miau",
"description": null,
"parentObjectiveId": "5fdb72c63d2cf000035ceb37",
"issueIds": [],
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2021-01-05T10:55:02+0000",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342c",
"latestUpdate": {
"entityId": "5ff445909f8c190003e0e447",
"status": "DELAYED",
"created": "2021-01-05T10:55:12+0000",
"value": 0.0,
"description": ""
},
"unit": null,
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
},
{
"id": "605480b190c42b0003385170",
"key": "KR-8",
"name": "new auto KR",
"description": null,
"parentObjectiveId": "5fda249d289742000406b3e4",
"issueIds": [
"10005",
"10006",
"10010"
],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [
"5c12ad9fd3af3b1ccfecbf55"
],
"percentDone": 33.33333333333333,
"created": "2021-03-19T10:45:05+0000",
"startDate": "2021-01-01T00:00:00+0000",
"deadline": "2021-03-31T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342a",
"latestUpdate": {
"entityId": "620ea538512edb00acf67ac1",
"status": "ON_TRACK",
"created": "2022-02-17T19:42:43+0000",
"value": 1.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "AUTO",
"startValue": null,
"desiredValue": null,
"jql": "project= TEST"
},
"weight": 1
},
{
"id": "6061e921e2f4470003bc3210",
"key": "KR-9",
"name": "different start date",
"description": null,
"parentObjectiveId": "5fda249d289742000406b3e4",
"issueIds": [
"10000"
],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2021-03-29T14:50:09+0000",
"startDate": "2020-04-01T00:00:00+0000",
"deadline": "2020-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": null,
"latestUpdate": {
"entityId": "61138f2be5fd454858c3e1ee",
"status": "AT_RISK",
"created": "2021-08-11T08:49:47+0000",
"value": 0.0,
"description": null
},
"unit": {
"name": "USD",
"symbol": "$"
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
},
{
"id": "60bde9dc99b4177c88ad428c",
"key": "KR-15",
"name": "fghjfgh",
"description": "",
"parentObjectiveId": "5fdb72c63d2cf000035ceb37",
"issueIds": [],
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [
"5c12ad9fd3af3b1ccfecbf55"
],
"percentDone": 0.0,
"created": "2021-06-07T09:41:48+0000",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000",
"labelIds": [],
"teamIds": [
"605df77c6e53750003068c7d",
"605dfb316e53750003068c8a"
],
"periodAliasId": "602a6a2717378700039f342c",
"latestUpdate": {
"entityId": "60bde9dc99b4177c88ad428d",
"status": "ON_TRACK",
"created": "2021-06-07T09:41:37+0000",
"value": 0.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
}
],
"teams": [
{
"id": "605df77c6e53750003068c7d",
"name": "lets go!"
},
{
"id": "605dfb316e53750003068c8a",
"name": "My team"
}
],
"periods": [
{
"id": "602a6a2717378700039f342a",
"name": "Q1 Y2021",
"startDate": "2021-01-01T00:00:00+0000",
"deadline": "2021-03-31T23:59:59+0000"
},
{
"id": "602a6a2717378700039f342c",
"name": "Q3 Y2021",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000"
}
],
"labels": []
}


Query key results by date

Query for a list of all key results, which have start date or/and due date inside specified date range.

GET /api/v2/api-export/keyResults/byDate

Parameter

Description

Mandatory

startDateEpochMilli

Start date of query time window, in UNIX Epoch time format.

YES

deadlineEpochMilli

End date of query time window, in UNIX Epoch time format.

YES

expand

A list of objects you want to include expanded in reqeust.
By default you receive only ids of connected entities.
Permitted values:
OBJECTIVES,TEAMS,PERIODS,LABELS

NO

Example request:

GET /api/v2/api-export/keyResults/byDate?
startDateEpochMilli=1509459200000
&deadlineEpochMilli=1748647410000
&expand=OBJECTIVES,KEY_RESULTS,TEAMS,PERIODS,LABELS

Example response

{
"okrs": [
{
"id": "620265fe81300a4c89e89806",
"key": "O-99",
"name": "Department objective ",
"description": "",
"parentObjectiveId": "620265d481300a4c89e89802",
"ownerAccountId": "557058:a63fcd57-682a-450b-8d7c-ec330b2aa543",
"collaboratorAccountIds": [],
"percentDone": 4.761904761904762,
"created": "2022-02-08T12:45:50+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [
"61fac8f89556e8621145011d"
],
"krIds": [
"62027c6f81300a4c89e89a1c"
],
"childObjectiveIds": [
"6202664f81300a4c89e89810",
"6202666281300a4c89e89812"
],
"latestUpdate": {
"entityId": "620265fe81300a4c89e89806",
"status": "NOT_STARTED",
"created": "2022-02-08T12:45:50+0000",
"value": null,
"description": "Objective created."
},
"periodAliasId": "602a6a2717378700039f342f",
"weight": 1
},
{
"id": "6202664f81300a4c89e89810",
"key": "O-101",
"name": "Team objective",
"description": "",
"parentObjectiveId": "620265fe81300a4c89e89806",
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2022-02-08T12:47:11+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [
"61c3402d8a875b727286a6c2"
],
"krIds": [
"6202671581300a4c89e89827",
"6202672781300a4c89e8982a"
],
"childObjectiveIds": [],
"latestUpdate": {
"entityId": "6202664f81300a4c89e89810",
"status": "NOT_STARTED",
"created": "2022-02-08T12:47:11+0000",
"value": null,
"description": "Objective created."
},
"periodAliasId": "602a6a2717378700039f342f",
"weight": 1
},
{
"id": "6202666281300a4c89e89812",
"key": "O-102",
"name": "Team 2 objective",
"description": "",
"parentObjectiveId": "620265fe81300a4c89e89806",
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [],
"percentDone": 9.523809523809524,
"created": "2022-02-08T12:47:30+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [
"611a1b88c385f85c13ac8630"
],
"krIds": [
"6202673e81300a4c89e8982e",
"6202674e81300a4c89e89830",
"62029d8881300a4c89e8af27"
],
"childObjectiveIds": [],
"latestUpdate": {
"entityId": "6202666281300a4c89e89812",
"status": "NOT_STARTED",
"created": "2022-02-08T12:47:30+0000",
"value": null,
"description": "Objective created."
},
"periodAliasId": "602a6a2717378700039f342f",
"weight": 1
}
],
"krs": [
{
"id": "6202671581300a4c89e89827",
"key": "KR-96",
"name": "Team KR",
"description": "",
"parentObjectiveId": "6202664f81300a4c89e89810",
"issueIds": [],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2022-02-08T12:50:29+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342f",
"latestUpdate": {
"entityId": "6202671581300a4c89e89828",
"status": "NOT_STARTED",
"created": "2022-02-08T12:50:29+0000",
"value": 0.0,
"description": "Key result created."
},
"unit": {
"name": "Numeric",
"symbol": ""
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
},
{
"id": "6202672781300a4c89e8982a",
"key": "KR-97",
"name": "Team KR 2 ",
"description": "",
"parentObjectiveId": "6202664f81300a4c89e89810",
"issueIds": [],
"ownerAccountId": "557058:a63fcd57-682a-450b-8d7c-ec330b2aa543",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2022-02-08T12:50:47+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342f",
"latestUpdate": {
"entityId": "6202672781300a4c89e8982b",
"status": "NOT_STARTED",
"created": "2022-02-08T12:50:47+0000",
"value": 0.0,
"description": "Key result created."
},
"unit": {
"name": "Numeric",
"symbol": ""
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
},
{
"id": "6202673e81300a4c89e8982e",
"key": "KR-98",
"name": "Team KR 3",
"description": "",
"parentObjectiveId": "6202666281300a4c89e89812",
"issueIds": [],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2022-02-08T12:51:09+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342f",
"latestUpdate": {
"entityId": "6202673e81300a4c89e8982f",
"status": "NOT_STARTED",
"created": "2022-02-08T12:51:09+0000",
"value": 0.0,
"description": "Key result created."
},
"unit": {
"name": "Numeric",
"symbol": ""
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
},
{
"id": "6202674e81300a4c89e89830",
"key": "KR-99",
"name": "Team KR 4",
"description": "",
"parentObjectiveId": "6202666281300a4c89e89812",
"issueIds": [],
"ownerAccountId": "557058:a63fcd57-682a-450b-8d7c-ec330b2aa543",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2022-02-08T12:51:26+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342f",
"latestUpdate": {
"entityId": "6202674e81300a4c89e89831",
"status": "NOT_STARTED",
"created": "2022-02-08T12:51:26+0000",
"value": 0.0,
"description": "Key result created."
},
"unit": {
"name": "Numeric",
"symbol": ""
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 1
},
{
"id": "62027c6f81300a4c89e89a1c",
"key": "KR-103",
"name": "For tracking ",
"description": "",
"parentObjectiveId": "620265fe81300a4c89e89806",
"issueIds": [],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2022-02-08T14:21:35+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342f",
"latestUpdate": {
"entityId": "62027c6f81300a4c89e89a1d",
"status": "NOT_STARTED",
"created": "2022-02-08T14:21:35+0000",
"value": 0.0,
"description": "Key result created."
},
"unit": {
"name": "Numeric",
"symbol": ""
},
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 1.0,
"jql": null
},
"weight": 0
},
{
"id": "62029d8881300a4c89e8af27",
"key": "KR-104",
"name": "Auto KR",
"description": "",
"parentObjectiveId": "6202666281300a4c89e89812",
"issueIds": [
"10008",
"10007",
"10009",
"10000",
"10002",
"10001",
"10004"
],
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 28.57142857142857,
"created": "2022-02-08T16:42:48+0000",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": "602a6a2717378700039f342f",
"latestUpdate": {
"entityId": "62029d8881300a4c89e8af2a",
"status": "NOT_STARTED",
"created": "2022-02-08T16:42:48+0000",
"value": 2.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "AUTO",
"startValue": null,
"desiredValue": null,
"jql": "project = ddd"
},
"weight": 1
}
],
"teams": [
{
"id": "611a1b88c385f85c13ac8630",
"name": "Product team"
},
{
"id": "61c3402d8a875b727286a6c2",
"name": "Operations"
},
{
"id": "61fac8f89556e8621145011d",
"name": "Research"
}
],
"periods": [
{
"id": "602a6a2717378700039f342f",
"name": "Q2 Y2022",
"startDate": "2022-04-01T00:00:00+0000",
"deadline": "2022-06-30T23:59:59+0000"
}
],
"labels": []
}


Query key results by id

Query for a list of all key results with specified ids.

GET /api/v2/api-export/keyResults/byIds

Parameter

Description

Mandatory

keyResultIds

Comma separated list of key result ids you want to receive.

YES

expand

A list of objects you want to include expanded in reqeust.
By default you receive only ids of connected entities.
Permitted values:
KEY_RESULTS,TEAMS,PERIODS,LABELS

NO

Example request:

GET /api/v2/api-export/keyResults/byIds?
expand=OBJECTIVES,KEY_RESULTS,TEAMS,PERIODS,LABELS
&keyResultIds=5fda249d289742000406b3e5

Example response

{
"okrs": [
{
"id": "5fdb72c63d2cf000035ceb37",
"key": "O-3",
"name": "45",
"description": null,
"parentObjectiveId": "5fda249d289742000406b3e4",
"ownerAccountId": "5dbfee8570f1ea0df7698353",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2020-12-17T15:01:26+0000",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000",
"labelIds": [],
"teamIds": [],
"krIds": [
"5fda249d289742000406b3e5",
"5fdb72c63d2cf000035ceb38",
"5ff445869f8c190003e0e445",
"60bde9dc99b4177c88ad428c"
],
"childObjectiveIds": [],
"latestUpdate": {
"entityId": "5fdb72c63d2cf000035ceb37",
"status": "UNDEFINED",
"created": "2021-08-09T00:00:00+0000",
"value": null,
"description": ""
},
"periodAliasId": "602a6a2717378700039f342c",
"weight": 0
}
],
"krs": [
{
"id": "5fda249d289742000406b3e5",
"key": "KR-2",
"name": "adda",
"description": null,
"parentObjectiveId": "5fdb72c63d2cf000035ceb37",
"issueIds": [
"10003"
],
"ownerAccountId": "5c12ad9fd3af3b1ccfecbf55",
"collaboratorAccountIds": [],
"percentDone": 0.0,
"created": "2020-12-16T15:15:41+0000",
"startDate": "2021-01-05T00:00:00+0000",
"deadline": "2021-03-28T00:59:59+0000",
"labelIds": [],
"teamIds": [],
"periodAliasId": null,
"latestUpdate": {
"entityId": "61c993aaa0fd9b768a0fb47d",
"status": "AT_RISK",
"created": "2021-12-27T10:21:30+0000",
"value": 0.0,
"description": null
},
"unit": null,
"currentProgressDefinition": {
"type": "STANDARD",
"startValue": 0.0,
"desiredValue": 22.0,
"jql": null
},
"weight": 1
}
],
"teams": [],
"periods": [
{
"id": "602a6a2717378700039f342c",
"name": "Q3 Y2021",
"startDate": "2021-07-01T00:00:00+0000",
"deadline": "2021-09-30T23:59:59+0000"
}
],
"labels": []
}

Did this answer your question?