ATathenian
metrics
default

Calculate metrics over JIRA issue activities.

Changed on
post/metrics/jira

Request

Request body

accountinteger required

Session account ID.

date_fromstring date required

Issues must be resolved after this date.

date_tostring date required

Issues must be created before this date.

timezoneinteger

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

prioritiesstring[]

Selected issue priorities.

typesstring[]

Selected issue types.

labels_includestring[]

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

labels_excludestring[]

JIRA issues may not contain labels from this list.

exclude_inactiveboolean required

Value indicating whether issues with the last update older than date_from should be ignored. If date_from and date_to are null, does nothing.

epicsstring[]

JIRA issues must be attached to any of the epic IDs from this list.

projectsstring[]

Issues must belong to these JIRA projects.

metricsJIRAMetricID[] required

List of measured metrics.

quantilesnumber[]

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

granularitiesGranularity[] required

The splits of the specified time range.

group_by_jira_labelboolean

Value indicating whether the metrics should be grouped by assigned JIRA issue label.

Example request

{
  "account": 1,
  "date_from": "2020-10-01",
  "date_to": "2020-10-30",
  "priorities": [
    "High"
  ],
  "types": [
    "Bug"
  ],
  "metrics": [
    "jira-open",
    "jira-resolved",
    "jira-raised"
  ],
  "granularities": [
    "all"
  ],
  "exclude_inactive": true
}

Response

Calculated metrics.

granularitystring required

How often the metrics are reported. The value must satisfy the following regular expression: /^all|(([1-9]\d* )?(aligned )?(day|week|month|year))$/. "all" produces a single interval [date_from, date_to]. "aligned week/month/year" produces intervals cut by calendar week/month/year borders, for example, when date_from is 2020-01-15 and date_to is 2020-03-10, the intervals will be 2020-01-15 - 2020-02-01 - 2020-03-01 - 2020-03-10.

jira_labelstring

Title of the assigned JIRA label, if group_by_jira_label was previously set to true. If is missing and group_by_jira_label was set to true then the metrics are calculated for issues without labels.

Example response

[
  {
    "granularity": "2 week",
    "values": [
      {
        "date": "2020-01-23",
        "values": [
          0.8008282,
          0.8008282
        ],
        "confidence_mins": [
          0.5,
          0.5
        ],
        "confidence_maxs": [
          1,
          1
        ],
        "confidence_scores": [
          75,
          75
        ]
      },
      {
        "date": "2020-01-23",
        "values": [
          0.8008282,
          0.8008282
        ],
        "confidence_mins": [
          0.5,
          0.5
        ],
        "confidence_maxs": [
          1,
          1
        ],
        "confidence_scores": [
          75,
          75
        ]
      }
    ]
  }
]

Changes

  • 63ec2eb2e4b3Revision changes
    • info

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

  • f9fdd9fbfc25Revision changes
    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status