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	`POST`: Issue Count.

IssueCountResponse attributes

Represents the number of issues in a search result.

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.

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

Sample request

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

Sample request body

                {
                  "folder":
                  {
                    "$type":"Project",
                    "id":"81-1"
                  },
                  "query":"for: john.smith ",
                  "unresolvedOnly":false
                }
            

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.

Sample request

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

Sample request body

                {
                  "folder":
                  {
                    "$type":"Project",
                    "id":"81-1"
                  },
                  "query":"for: john.smith ",
                  "unresolvedOnly":false
                }
            

Sample response body

                {
                  "count": -1,
                  "$type": "IssueCountResponse"
                }
            

Last modified: 24 February 2023