Interface MetricsFacetParams

Facet count request. Jira Search has no REST group-by, so values are counted with one count-only JQL query per bucket.

interface MetricsFacetParams {
    concurrency?: number;
    field: string;
    from?: string;
    jql?: string;
    projects?: string[];
    to?: string;
    validateQuery?: boolean;
    values: (string | number)[];
}

Hierarchy (View Summary)

Properties

concurrency? field from? jql? projects? to? validateQuery? values

Properties

Optionalconcurrency

concurrency?: number

Optional maximum number of concurrent count requests

field

field: string

JQL field name, e.g. 'issuetype', 'status', 'priority', 'assignee'

Optionalfrom

from?: string

Lower date bound accepted by Jira JQL, e.g. '-30d' or '2026-06-01'

Optionaljql

jql?: string

Additional JQL combined with generated metric clauses using AND

Optionalprojects

projects?: string[]

Project keys or IDs to restrict the metric to

Optionalto

to?: string

Upper date bound accepted by Jira JQL, e.g. '2026-06-30'

OptionalvalidateQuery

validateQuery?: boolean

Whether Jira should validate each generated JQL query

values

values: (string | number)[]

Bucket values to count for the field

Settings

Member Visibility

On This Page

Properties