Retrieve details of the epic
GET
/api/initiatives/SHO-MJXR/epics/EP-41The GET /api/initiatives/SHO-MJXR/epics/EP-41 endpoint retrieves detailed information about the epic identified by EP-41 within the initiative identified by SHO-MJXR.
Notes:
- Ensure that a valid authentication token is provided in the request headers.
- Ensure that you provide right epic external key
Request
Query Params
externalKey
string
required
Example:
EP-41
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
success
boolean
optional
data
object
optional
id
integer
optional
summary
string
optional
backlog
boolean
optional
description
string
optional
externalKey
string
optional
color
string
optional
estimate
string
optional
score
string
optional
businessValue
string
optional
order
integer
optional
progress
string
optional
externalProgress
string
optional
jiraId
string
optional
jiraKey
string
optional
jiraSelf
null
optional
jiraParentId
string
optional
teamId
null
optional
businessGoal
string
optional
tags
string
optional
urls
array [object {1}]
optional
persona
string
optional
userId
array[integer]
optional
startDate
string
optional
endDate
string
optional
roadmapId
integer
optional
businessObjectiveId
integer
optional
swimlaneId
integer
optional
timeBoxPlanningId
integer
optional
subTimeBoxPlanningId
integer
optional
storyMapId
integer
optional
features
array[string]
optional
userStories
array[string]
optional
user
array[string]
optional
progressPercentage
integer
optional
kpis
array [object {16}]
optional
Example
{
"success": true,
"data": {
"id": 1087,
"summary": "Enhance User Engagement and Retention",
"backlog": true,
"description": "<p>Improve user engagement and retention metrics through targeted feature enhancements and optimizations across the platform.</p><p> </p>",
"externalKey": "EP-41",
"color": "#ffb64f",
"estimate": "60",
"score": "1.6666666666666667",
"businessValue": "100",
"order": 19,
"progress": "review",
"externalProgress": "",
"jiraId": "",
"jiraKey": "",
"jiraSelf": null,
"jiraParentId": "",
"teamId": null,
"businessGoal": "Increase Monthly Active Users (MAUs) by 20% within the next fiscal year.",
"tags": "[\"Epic\",\"User engagement\"]",
"urls": [
{
"url": "https://example.com"
},
{
"url": "https://example.com"
}
],
"persona": "[{\"personaValue\":\"UX Researchers\",\"personaId\":999},{\"personaValue\":\"Engineers\",\"personaId\":1000}]",
"userId": [
17355
],
"startDate": "2024-06-30T18:30:00.000Z",
"endDate": "2024-07-30T18:30:00.000Z",
"roadmapId": 0,
"businessObjectiveId": 0,
"swimlaneId": 0,
"timeBoxPlanningId": 0,
"subTimeBoxPlanningId": 0,
"storyMapId": 0,
"features": [],
"userStories": [],
"user": [],
"progressPercentage": 0,
"kpis": [
{
"id": 7557,
"title": "Employee retention",
"benchmark": "50.00",
"benchmarkUnit": "%",
"benchmarkType": "MORE",
"initiativeId": 1116,
"dueDate": null,
"statement": "",
"createdAt": "2024-07-12T02:24:12.000Z",
"visualization": false,
"dashboardVisualization": true,
"order": 11,
"kpiId": 7557,
"name": "Employee retention",
"value": "",
"kpi_revisions": []
},
{
"id": 7558,
"title": "Churn",
"benchmark": "30.00",
"benchmarkUnit": "%",
"benchmarkType": "MORE",
"initiativeId": 1116,
"dueDate": null,
"statement": "",
"createdAt": "2024-07-12T02:41:32.000Z",
"visualization": false,
"dashboardVisualization": true,
"order": 12,
"kpiId": 7558,
"name": "Churn",
"value": "",
"kpi_revisions": []
},
{
"id": 7559,
"title": "hello",
"benchmark": "0.00",
"benchmarkUnit": "",
"benchmarkType": "",
"initiativeId": 1116,
"dueDate": null,
"statement": "",
"createdAt": "2024-07-12T02:44:56.000Z",
"visualization": false,
"dashboardVisualization": true,
"order": 13,
"kpiId": 7559,
"name": "hello",
"value": "0",
"kpi_revisions": []
},
{
"id": 7563,
"title": "Increase customer retention",
"benchmark": "40.00",
"benchmarkUnit": "%",
"benchmarkType": "MORE",
"initiativeId": 1116,
"dueDate": "2024-07-12T18:30:00.000Z",
"statement": "11",
"createdAt": "2024-07-12T02:51:29.000Z",
"visualization": true,
"dashboardVisualization": true,
"order": 15,
"kpiId": 7563,
"name": "Increase customer retention",
"value": "11",
"kpi_revisions": [
{
"id": 3275,
"createdAt": "2024-07-12T02:51:29.000Z",
"value": "11.00"
}
]
},
{
"id": 7564,
"title": "Increase customer retention",
"benchmark": "40.00",
"benchmarkUnit": "%",
"benchmarkType": "MORE",
"initiativeId": 1116,
"dueDate": "2024-07-12T18:30:00.000Z",
"statement": "11",
"createdAt": "2024-07-12T02:54:01.000Z",
"visualization": true,
"dashboardVisualization": true,
"order": 16,
"kpiId": 7564,
"name": "Increase customer retention",
"value": "11",
"kpi_revisions": [
{
"id": 3276,
"createdAt": "2024-07-12T02:54:01.000Z",
"value": "11.00"
}
]
}
]
}
}
Modified at 3 months ago