How to Get Sprint Velocity Data via JIRA REST API?

[John Consorti]

Hi,

I am looking for a way to obtain velocity data via JIRA server REST API.  I have been unable to find a way to do this and was hoping someone might have some insight on this?  I am basically looking to pull the data from the velocity report page, but for all past sprints.  When I do a REST call for all issues within a sprint, I am only returned the current data, however this is not what I'm looking for.  Any help or advice would be much appreciated.

Thanks in advance!

[Thomas Magny-Garcia · Accepted solution]

Hi @John Consorti 

According to https://jira.atlassian.com/browse/JSWSERVER-12877 , the documentation is not full. So :

JIRA Agile REST API Reference does not contain any info about how to query Agile reports e.g. Velocity or Burndown.

However, there are available endpoints to achieve this, e.g.:

• for Velocity:

  /rest/greenhopper/1.0/rapid/charts/velocity?rapidViewId=<board_ID>

Hope it helps !

[vjpaddy]

Thanks for this. This works.

[Aakash Chauhan]

This only gives data for the last 7 sprints. Any ideas on how to get beyond those sprints ?

[Robert Cronk]

I'd also like to get more than 7 sprints of data.  I have little hope of getting more though since this looks like it's just the data from the web interface and there's no way I know of to get beyond that many in the web interface.  Hopefully I'm wrong.  Or someone could point us to a different way to get velocity beyond what this page gives us without buying an expensive add-on.

[Ashikkumar Patel]

Hi, I am getting this response while calling the API endpoint 

{

    "errorMessages": [],

    "errors": {

        "rapidViewId": "The requested board cannot be viewed because it either does not exist or you do not have permission to view it."

    }

}

[David Yohler]

Digging around, found the sprintreport variation under greenhopper which allows for the sprintId to be passed.  Couldn't find any documentation, but it allows the sprint to be passed just like in the UI dropdown.

/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=<board_ID>&sprintId=<sprint_ID>

The velocity appears to be hardcoded at 7.  Which if 2 week sprints, shows a rolling quarter.  Probably due to data size and UI display why it is locked.