Class MetricsResource

Lightweight Jira metrics derived from public Jira Data Center REST/JQL.

Index

Methods

count facet userContributions

Methods

count

count(params?: MetricsCountParams): Promise<JiraIssueCount>
Counts issues matching a JQL query.

Jira Data Center does not expose a dedicated count endpoint; this uses POST /rest/api/latest/search with maxResults: 0.
Parameters
- params: MetricsCountParams = {}
Returns Promise<JiraIssueCount>
- Defined in src/resources/MetricsResource.ts:38

facet

facet(params: MetricsFacetParams): Promise<JiraIssueFacetCounts>
Counts a list of values for one JQL field.
Parameters
- params: MetricsFacetParams
Returns Promise<JiraIssueFacetCounts>
- Defined in src/resources/MetricsResource.ts:58

userContributions

userContributions(
usernames: string | string[],
params?: UserContributionMetricsParams,
): Promise<JiraUserContributionMetricsResponse>
Counts lightweight contribution dimensions for one or more users.

updated uses Jira's updatedBy() JQL function. worklogIssues counts issues with worklogs by the user, not individual worklog rows.
Parameters
- usernames: string | string[]
- params: UserContributionMetricsParams = {}
Returns Promise<JiraUserContributionMetricsResponse>
- Defined in src/resources/MetricsResource.ts:83