Developer Portal for YouTrack and Hub Help

Issue Count

This resource lets you get the number of issues returned by a search.

Resource

/api/issuesGetter/count

Returned entity

IssueCountResponse. For the description of the entity attributes, see Supported Fields section.

Supported methods

IssueCountResponse attributes

Represents the number of issues in a search result.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the IssueCountResponse entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The ID of the IssueCountResponse. Read-only.

count

Long

The number of issues found by the search.

If this number equals -1, it means that YouTrack hasn't finished counting the issues yet. Wait for a bit and repeat the request.

Can be null.

unresolvedOnly

Boolean

true when the Hide resolved issues control is enabled. Can be null.

query

String

The search query. Can be null.

folder

IssueFolder

The currently selected search context. Can be null.

Get Issue Count

Get the number of issues found by a search.

Required fields: query.

Although the goal of this request is to get data, you need to pass the search query that you want to get the number of issues for. GET requests don't take request body, so you need to send a POST request in this case.

In the request body, specify the search that you want to get the number of issues for. When you need to get the count of all issues without filtering them with a query, pass an empty object in the request body: {}. YouTrack REST API doesn't support POST requests without a request body.

If the response returns "count": -1, it means that YouTrack hasn't finished counting the issues yet. Wait for a bit and repeat the request.

Request syntax

POST /api/issuesGetter/count?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of IssueCountResponse attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample 1

In this sample, we send a POST request to get the number of issues returned by the search with for: john.smith project: NP #Unresolved set as the search query.

In the response, we get the number of issues that this search returns.

Sample request

https://example.youtrack.cloud/api/issuesGetter/count?fields=count

Sample request body

{ "query":"for: john.smith project: NP #Unresolved" }

Sample response body

{ "count":29, "$type":"IssueCountResponse" }

Sample 2

If the response returns "count": -1, it means that YouTrack hasn't finished counting the issues yet. Wait for a bit and repeat the request.

In this sample, we send a POST request to get the number of issues returned by the search with for: john.smith project: NP #Unresolved set as the search query.

In the response, we get "count": -1, so we'll need to repeat the request after a while to get the actual number.

Sample request

https://example.youtrack.cloud/api/issuesGetter/count?fields=count

Sample request body

{ "query":"for: john.smith project: NP #Unresolved" }

Sample response body

{ "count": -1, "$type": "IssueCountResponse" }
Last modified: 15 March 2024