Generate an issue report

This request lets you generate a report containing issues that match the specified search criteria.

https://api.tracker.yandex.net/v3/entities/report/

Request format

Before making the request, get access to the API.

To generate a report, make an HTTP request using the POST method. The request body contains report parameters and criteria for searching issues.

POST /v3/entities/report/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth token>
Content-Type: application/json
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
  "fields": {
    "summary": "Issue export",
    "parameters": {
      "type": "issueFilterExport",
      "format": "xlsx",
      "filter": {
        "query": "Queue: SUPPORT \"Sort by\": Updated DESC",
        "sorts": [
          {
            "orderBy": "updated",
            "orderAsc": false
          }
        ]
      },
      "fields": [
        "priority",
        "type",
        "key",
        "summary",
        "assignee",
        "status",
        "updated"
      ]
    }
  }
}

Example 1: Generating a report using the query language

• Issue report in XLSX format.
• The report contains issues from the SUPPORT queue.
• Results are sorted by the update date in descending order.
• The report includes the following fields: priority, type, key, summary, assignee, status, update date.

POST /v3/entities/report/ HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Org-ID: 1234******

{
  "fields": {
    "summary": "SUPPORT queue issue export",
    "parameters": {
      "type": "issueFilterExport",
      "format": "xlsx",
      "filter": {
        "query": "Queue: SUPPORT \"Sort by\": Updated DESC",
        "sorts": [
          {
            "orderBy": "updated",
            "orderAsc": false
          }
        ]
      },
      "fields": [
        "priority",
        "type",
        "key",
        "summary",
        "assignee",
        "status",
        "updated"
      ]
    }
  }
}

Example 2: Generating a report using a filter object

• Issue report in XLSX format.
• The report is generated using the following parameters: issues from the TREK queue that have no assignee.
• The report includes key issue fields.

POST /v3/entities/report/ HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Cloud-Org-ID: ab1c******

{
  "fields": {
    "summary": "Issues with no assignee",
    "parameters": {
      "type": "issueFilterExport",
      "format": "xlsx",
      "filter": {
        "filter": {
          "queue": "TREK",
          "assignee": "empty()"
        }
      },
      "fields": [
        "key",
        "summary",
        "status",
        "priority",
        "created"
      ]
    }
  }
}

Example 3: Generating a report using a saved filter

• Issue report in XLSX format.
• The report is created based on a saved filter with ID 12345.
• The report includes key issue fields.

POST /v3/entities/report/ HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth y0__xAbc******
Content-Type: application/json
X-Org-ID: 1234******

{
  "fields": {
    "summary": "Report based on a saved filter",
    "parameters": {
      "type": "issueFilterExport",
      "format": "xlsx",
      "filter": {
        "filterId": 12345
      }
      "fields": [
        "key",
        "summary",
        "status",
        "assignee",
        "priority",
        "updated"
      ]
    }
  }
}

Response format

{
    "self": "https://api.tracker.yandex.net/v3/entities/report/68f68b553cdc3969e0445570",
    "id": "68f68b553cdc3969e0445570",
    "version": 1,
    "shortId": 142,
    "entityType": "report",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/8000000000000004",
        "id": "8000000000000004",
        "display": "User Name",
        "cloudUid": "aje71i6t2tuvanuoimem",
        "passportUid": 1234567890
    },
    "createdAt": "2025-10-20T19:19:49.120+0000",
    "updatedAt": "2025-10-20T19:19:49.120+0000"
}