Screen_Recording_2021-06-14_at_10.52.45.50_AM.gif

 

The Reports page helps you visualize activity across Stories, Epics, Milestones, Projects, Iterations, Owners and Labels. 

Note

Free plan accounts do not have access to the Reports page. For access to the Reports page and more, please consider upgrading to a paid plan.

How to Set A Custom Timeframe

You can choose to review activity between any two dates of your choosing by clicking on the "Date Range" drop-down menu, select Specific Date and selecting your desired start and end dates.

mceclip2.png

You may also choose to select Relative Date from the drop down. Instead of having to select specific dates to filter the Reports page by, you can select relative dates (i.e. past 3 weeks, or past 2 months). These relative dates also persist in the URL and can be shared that way. Now, you can click the same link everyday to view data for, say, the past 30 days and the data will change as time progresses!

 

mceclip1.png

Please note that dates on your Reports page reflect your Organization's UTC offset, which can be configured via Settings (gear wheel) > Workspace Settings > General Settings. 

How to filter Reports

You can filter the Reports page by selecting all or certain Projects, Epics, Milestones, Iterations, Owners and/or Labels. You may also quickly remove all filters by clicking Clear Filters button to the far right of the filters.

mceclip0.png

How to group reports by time

Additionally, reports can be Grouped by Day, Week, Month and even Iterations. This allows you to better visualize velocity within time-boxed periods.

mceclip0.png

Show, Hide or Re-Order the Reports Page

You can include only the reports you truly care about by clicking the Display Charts button in the upper right corner of the page. From here, you may select the charts that are most important to you (and unselect those that aren't), as well as the order that they appear in by simply dragging and dropping them.

Screen_Recording_2021-07-26_at_08.29.53.76_PM.gif

 

  Tip

After choosing and re-ordering the reports to your liking, you may copy and share the URL of this page to your colleagues. This URL will allow anyone you share it with access to this specific report page's order/selection.

 

How Reports are Generated

Stories that are included in the Reports page are ones that have been moved into a "Done" workflow state. You can review your Workflow States by clicking on Settings (gear wheel) > Workflow. More on how to define your Organization's Workflow here.  

Archived stories are not included within any Reports.

If a Story is moved to a "Done" workflow state and subsequently moved back, it will not be accounted for on the Reports page. Once it is moved back into a "Done" state, it will only show up in the Report for the final/updated date range.

Note: If you are using the Shortcut API to manually override the time/date a Story was completed, this override will be respected by Reports within the UI.  

Sections of the Reports page

Story and Epics completion Summary

Screen_Shot_2019-09-05_at_10.53.57_AM.png

You should immediately notice the Story & Epic completion summary after a report is generated. The number of stories completed are shown to the left, with the Story type breakdown immediately next to it. We specify which Story types accumulated their respective number of points. The next panel summarizes the number of Epics that were finished and the number that were updated. 

Velocity Chart

Upon generating a report with the desired date range and filters discussed above, a velocity chart will be populated. The Velocity chart is a great tool to measure the pace at which teams are completing work grouped by selected interval within the specified date range. This is calculated by either the number of Stories or Stories points completed, broken down by type.

  • The x-axis represents time; the intervals can be changed by using the Group By filter at the top of the page.
  • The y-axis can represent either points or Story count, and can be changed by using the Sum Using filter.

Story Count vs. Story Points

  • When using Story Count, the height of the bar represents total number of Stories completed in that interval.
  • When using Story Points, the height of the bar represents the amount of completed points associated with completed stories in that Interval. Completed Stories that have 0 points or are unestimated, do not contribute to the calculation of Story Points.

The bars are color coded to represent different story types: Feature Stories (yellow), Bug Stories (red), and Chore Stories (blue).

Hovering your mouse over a single bar will produce a pop up with a quantitative breakdown of the Story types, as well as the total number of Stories or Story Points completed within the interval. 

Averages

  • The dotted green line shows you the overall average of velocity. This is the total number of points or stories across the entire date range, divided by the total number of intervals in the chart.
  • The solid green line shows you the trailing average of velocity. The number of intervals used to calculate this changes depending on the Group By filter at the top of the page:
  • Day uses a 7 day trailing average, inclusive of that day
  • Week uses a 4 week trailing average
  • Month uses a 3 month trailing average
  • Iteration uses 4 iteration trailing average

Note: The trailing average uses data outside of the selected date range to show an accurate metric at the start of the graph. For example, if the chart is Grouped By Day, the first Trailing Average calculation uses Stories completed that day, and the previous 6 days (which are not on the chart)

app.clubhouse.io_internal_reports_2021-01-11_days_26_group_id_week_aggregate_id_stories_cycle_time_scale_Log_cycle_time_type_Lead_Time_wf_state_calculation_average_wf_state_type_stacked_area_cc_aggregate_count_vc_aggregate_stories_t__2_.png

Epics Progression Section

The bottom section of the Reports page breaks down how Epics have progressed (through the stories completed and/or added) within the specified date range.


Screen_Shot_2019-09-05_at_11.09.11_AM.png

Progress is measured in percentages according to how many associated Stories were completed within the date range of the report. An Epic's progress is calculated not only by the number of Stories completed, but also by the number of Stories that may have been added to the Epic (as these two events change how far you are from completion).

Clicking on an Epic in this section will take you directly to view that Epic, its associated Stories, and its own reports. For more information on the reports within an Epic, see our guide on the Epic’s Report Tab.

 

Want to see Reports in action? Explore our Sample Workspace, which contains pre-filled information that will allow you to see how it all works together. Access it by clicking on your User Icon on top right > Help / Feedback > Sample Workspace.