Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

How do you get Flow Metrics out of Align using the Align REST API?????/

Hello Friends,

This is a challenge for the most tech savvy of you.  If you can figure this out, your name will be glorified and will live in infamy within the Atlassian Community.   Any help will be greatly appreciated.

The Challenge

How do you pull Flow Metrics out  of the Align REST API?  My goal is to pull these metrics from REST Endpoints and run calculation for these flow metrics in a data lake.  Can anyone figure out which combination of REST endpoints to use for each flow metric.

1.Flow Distribution- Flow distribution counts how many of each flow item (ie. feature, defects, risks, dependencies,) are in a value stream in a given time period like a quarter or Program Increment.

2.Flow Velocity- How many flow items (ie. features) were completed in a program increment or quarter.

3.Flow Time- Measures the average time from when work is started to completed on a feature in a value stream (ie. program can be a value stream)

4.Flow Load- Counts the number of features that are in progress (ie. not done or not in to do status) at the present moment in a value stream5

5.low Efficiency- Ratio of active time to waiting time for a feature in a Program Increment 

6. Flow Predictability-Ratio of planned vs actual work done in a Program Increment


3 answers

1 vote
Rich Sparks Atlassian Team Oct 27, 2021

I hate to say this, but the fastest way to get Flow Metrics is to use Enterprise Insights (EI). EI is a reporting database for Jira Align that has all the historical information needed to generate the reports.

My colleague @Derek Huether wrote an excellent article explaining this here: here:

If you don't want to use EI, you need to extract from Jira Align on a regular basis and build your own reporting datamart (to keep track of all the state transitions and such.) Technically it can be done, but it is faster and more reliable to license Enterprise Insights and build the reports from that datamart.

0 votes

Another possibility is to just pull the all the Stories and their State each day.  For example: 

{{base_JA_url}}/stories?$select=ID,Title,State&$filter=releaseId eq 8 &$top=100

Rich Sparks Atlassian Team Oct 27, 2021

Here @Allan Maxwell  provides two examples of what I was suggesting: If you don't use Enterprise Insights, you'd need to build your own process to extract the data on a regular basis then build the data structure to meet your needs.

You could use this example (and the one below) to get the stories and features and epics and track their state on a daily basis. Then you'd need to capture the data for state changes to get your more detailed metrics.

Some items might be easier -- like Item #4 above, counting the number of features in progress at the current state. But then flow efficiency would be more difficult because you have to track the state changes as something may move in and out of "active status."

Like lou_rodriguez likes this
0 votes

Not a great solution, but you could pull the Audit logs for all the work items of interest using {{base_JA_url}}/Stories/26997/AuditLog

Screen Shot 2021-10-27 at 1.55.08 PM.png

Thank you for your input.  They all sound like possible solutions but I think Enterprise Insights makes the most sense.

Were building an app that needs the flow metrics from Jira Align.  So our customers will need Enterprise Insights in order to make our app work.   I believe with Enterprise Insights we can connect our data lake directly to the EI database and pull data that way. 

Rich Sparks Atlassian Team Oct 29, 2021

With Enterprise Insights, you can either:

  1. Point your visualization tool directly at EI and run the queries there, or
  2. Use interfaces from EI to load the data into your own data lake and combine with other information.
Like lou_rodriguez likes this

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Jira Align

Rockin' the Roadmap - How to make most of the Roadmap with Jira Align

The roadmap challenge for large scale agile enterprises Regardless of the agile framework you use, the agile enterprise has a massive scale with the challenge to connect hundreds of teams and thous...

3,713 views 8 30
Read article

Atlassian Community Events