Skip to content

Function: getApproximateIssueCountForBacklog()

ts
function getApproximateIssueCountForBacklog(client, parameters): Promise<{
[key: string]: unknown;
  count?: number;
}>;

Defined in: src/agile/api/board.ts:206

Returns the approximate count of all issues from the board's backlog, for the given board ID. This is equivalent to counting the issues on all pages returned by Get issues for backlog enhanced. Recent updates might not be immediately visible in the returned output. This only includes issues that the user has permission to view.

Parameters

ParameterTypeDescription
clientClient-
parameters{ boardId: number; jql?: string; }-
parameters.boardIdnumberThe ID of the board that has the backlog containing the requested issues.
parameters.jql?stringFilters results using a JQL query. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.

Returns

Promise<{ [key: string]: unknown; count?: number; }>