Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
What are the issue change logs?
The list of change logs represents the issue change history. A change log is a record reflecting specific Jira issue changes (e.g., status change, sprint change, etc.) performed at a particular time.
How to get the change logs for an issue?
Compile the request URL using the following Jira API endpoint:
JIRA_HOST_NAME/rest/api/2/issue/ISSUE_KEY?expand=changelog
Replace:JIRA_HOST_NAME
with the Jira hostname, which can be found in the browser address barISSUE_KEY
- can be found in the issue detailsExample: for the hostname company.atlassian.net and Jira issue with key TST-123, the request URL will look like this:
https://company.atlassian.net/rest/api/2/issue/TST-123?expand=changelog
Paste the compiled request URL to the browser address bar and navigate to see the issue history:
How to get the change logs for a sprint?
Compile the request URL using the following Jira API endpoint:
JIRA_HOST_NAME/rest/agile/1.0/sprint/SPRINT_ID
Replace:
JIRA_HOST_NAME
with the Jira hostname, which can be found in the browser address barSPRINT_ID
- can be found in the sprint details (“Reports” → “Sprint report”)Example: for the hostname company.atlassian.net and Jira sprint with ID 27, the request URL will look like this:
https://company.atlassian.net/rest/agile/1.0/sprint/27
Paste the compiled request URL to the browser address bar and navigate to see the sprint history:
How to get the change logs for a board?
Compile the request URL using the following Jira API endpoint:
JIRA_HOST_NAME/rest/agile/1.0/board/BOARD_ID/configuration
Replace:
a.JIRA_HOST_NAME
with the Jira hostname, which can be found in the browser address bar
b.BOARD_ID
- can be found in the board detailsExample: for the hostname company.atlassian.net and Jira board with ID 25, the request URL will look like this:
https://company.atlassian.net/rest/agile/1.0/board/25/configurationPaste the compiled request URL to the browser address bar and navigate to see the board history:
How to get the change logs for a status?
Compile the request URL using the following Jira API endpoint:
JIRA_HOST_NAME/jira/rest/api/2/status
Replace:
a.JIRA_HOST_NAME
with the Jira hostname, which can be found in the browser address barExample: for the hostname company.atlassian.net, the request URL will look like this:
https://company.atlassian.net/jira/rest/api/2/status
Why do we ask for the change logs?
Jira issue change log is an essential part of the application calculation engine. The issue change logs help to quickly identify the root cause of issues related to chart numbers.