ATathenian
histograms
default

Calculate histograms over JIRA issue activities.

Changed on
post/histograms/jira

Request

Request body

prioritiesstring[]

Selected issue priorities.

typesstring[]

Selected issue types.

labels_includestring[]

PRs must relate to at least one JIRA issue label from the list. Several labels may be concatenated by a comma , so that all of them are required.

labels_excludestring[]

PRs cannot relate to JIRA issue labels from the list.

projectsstring[]

Issues must belong to these JIRA projects.

date_fromstring date required

Date from when to start measuring the distribution.

date_tostring date required

Date until which to measure the distribution.

timezoneinteger

Local time zone offset in minutes, used to adjust date_from and date_to.

exclude_inactiveboolean required

Value indicating whether issues with the last update older than date_from should be ignored.

quantilesnumber[]

Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting.

accountinteger required

Session account ID.

Example request

{
  "types": [
    "Bug"
  ],
  "histograms": [
    {
      "metric": "jira-raised"
    }
  ],
  "account": 1,
  "date_to": "2020-11-23",
  "date_from": "2020-01-23",
  "timezone": 120,
  "exclude_inactive": true
}

Response

Calculated histograms.

metric'jira-open' | 'jira-resolved' | 'jira-raised' | 'jira-acknowledged' | 'jira-acknowledged-q' | 'jira-life-time' | 'jira-life-time-below-threshold-ratio' | 'jira-lead-time' | 'jira-lead-time-below-threshold-ratio' | 'jira-acknowledge-time' | 'jira-acknowledge-time-below-threshold-ratio' | 'jira-pr-lag-time' | 'jira-backlog-time' | 'jira-resolution-rate' required

Currently supported JIRA activity metrics.

  • jira-open - number of issues active by the end of the time interval.
  • jira-resolved - number of issues closed in the given time range.
  • jira-raised - number of issues reported in the given time range.
  • jira-acknowledged - number of issues that are "In Progress" or "Resolved". This number matches the issues considered to calculate jira-acknowledge-time before applying the quantiles.
  • jira-acknowledged-q - number of issues that are "In Progress" or "Resolved". This number matches the issues considered to calculate jira-acknowledge-time after applying the quantiles.
  • jira-life-time - Mean Life Time - the time between min(issue creation, work began) and max(issue resolution, fixes released).
  • jira-life-time-below-threshold-ratio - ratio of issues with a jira-life-time below the threshold, disregarding the quantiles. The default threshold is 5 days.
  • jira-lead-time - Mean Lead Time - the time between when the work began and max(issue resolution, fixes released).
  • jira-lead-time-below-threshold-ratio - ratio of issues with a jira-lead-time below the threshold, disregarding the quantiles. The default threshold is 5 days.
  • jira-acknowledge-time - Mean Acknowledge Time - the time between when the issue was created and the work began = min(transitioned to "In Progress", PR created). It equals to 0 for retrofitted issues with PRs before their creation times.
  • jira-acknowledge-time-below-threshold-ratio - ratio of issues with a jira-acknowledge-time below the threshold, disregarding the quantiles. The default threshold is 3 days.
  • jira-pr-lag-time - the time between when the issue transitioned to "In Progress" and the first PR was created. It equals to 0 if the difference is negative or no PRs are mapped to the issue.
  • jira-backlog-time - the time between when the issue was created and transitioned to "In Progress".
  • jira-resolution-rate - ratio between the number of resolved issues to the number of raised issues.
scale'linear' | 'log' required

X axis scale: linear or logarithmic.

frequenciesinteger[] required

Series of histogram bar heights aka Y axis.

Example response

[
  {
    "metric": "jira-raised",
    "scale": "linear",
    "ticks": [
      0,
      1,
      10,
      50,
      100,
      500,
      10000
    ],
    "frequencies": [
      0,
      38,
      28,
      13,
      12,
      8
    ],
    "interquartile": {
      "left": 3,
      "right": 76
    }
  }
]

Changes

  • 4dcbf99639b4Revision changes
    • breaking

      added the new required request property //////

    • breaking

      added the new required request property /////////

  • 63ec2eb2e4b3Revision changes
    • warning

      added the new jira-acknowledge-time-below-threshold-ratio enum value to the / response property for the response status

    • info

      added the new jira-acknowledge-time-below-threshold-ratio enum value to the request property //