Viewing logs of an auto action
You can retrieve logs with information about all auto action runs or logs for a specific auto action run along with a list of found issues:
- Get information about all auto action runs.
- Get information about a specific auto action run along with a list of found issues.
You can view logs only for auto actions that configure automatic issue updates.
Getting information about all auto action runs
GET
https://api.tracker.yandex.net/v3/queues/<queue_key>/autoactions/<autoaction_ID>/logs
Request format
Before making a request, get permission to access the API.
To get the logs, use an HTTP GET
request:
GET /v3/queues/<queue_key>/autoactions/<autoaction_ID>/logs
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers
-
Host
: Address of the node that provides the API. -
Authorization
: Authorization token about these formats:-
OAuth <OAuth_token>
: For authorization using the OAuth 2.0 protocol. Learn more -
Bearer <IAM_token>
: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
-
-
X-Org-ID
orX-Cloud-Org-ID
: Organization ID.-
Use the
X-Org-ID
header if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-ID
header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.
-
Resource
Parameter | Description | Data type |
---|---|---|
<queue_key> | Queue ID or key. The queue key is case-sensitive. | String |
<auto_action_ID> | Auto action ID | String |
Response format
If the request is successful, the API returns a response with code 200 OK
.
The response body contains the results in JSON format.
[
{
"id": "6819cc43d8f6f0**********",
"launchTime": "2025-05-06T08:45:55.778+0000",
"searchHits": 3,
"successes": 3,
"failures": 0,
"searchFailed": false
},
...
]
Response parameters
Parameter | Description | Data type |
---|---|---|
id | ID of the auto action run. | String |
launchTime | Start time of the auto action run in YYYY-MM-DDThh:mm:ss.sss±hhmm format. |
String |
searchHits | Number of issues processed by the auto action. | Number |
successes | Number of issues where the auto action was triggered. | Number |
failures | Number of issues where the auto action wasn't triggered. | Number |
searchFailed | This parameter indicates whether the auto action processed at least one issue:
|
Boolean |
If the request is processed incorrectly, the API returns a response with an error code:
- 400
- One or more request parameters have an invalid value.
- 401
- The user is not authorized. Make sure that actions described in the API access section are performed.
- 403
- You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
Getting information about a specific auto action run
GET
https://api.tracker.yandex.net/v3/queues/<queue_key>/autoactions/<autoaction_ID>/logs/<autoaction_activation_ID>
Request format
Before making a request, get permission to access the API.
To get the logs, use an HTTP GET
request:
GET /v3/queues/<queue_key>/autoactions/<autoaction_ID>/logs/<auto_action_run_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers
-
Host
: Address of the node that provides the API. -
Authorization
: Authorization token about these formats:-
OAuth <OAuth_token>
: For authorization using the OAuth 2.0 protocol. Learn more -
Bearer <IAM_token>
: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
-
-
X-Org-ID
orX-Cloud-Org-ID
: Organization ID.-
Use the
X-Org-ID
header if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-ID
header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.
-
Resource
Parameter | Description | Data type |
---|---|---|
<queue_key> | Queue ID or key. The queue key is case-sensitive. | String |
<auto_action_ID> | Auto action ID | String |
<auto_action_run_ID> | ID of the auto action run. | String |
Response format
If the request is successful, the API returns a response with code 200 OK
.
The response body contains the results in JSON format.
[
{
"id": 0,
"issueReference": {
"self": "https://api.tracker.yandex.net/v3/issues/TEST-1",
"id": "66f682f13f442b**********",
"version": 0,
"key": "TEST-1",
"display": "Issue name"
},
"status": {
"value": "success",
"display": "Success"
}
},
...
]
Response parameters
Parameter | Description | Data type |
---|---|---|
id | The ID represents the sequence number of the auto action run. Indexing begins at zero. | Number |
issueReference | Information about the issue. | Map object |
status | Information about the request status. | Map object |
Object fields issueReference
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the issue. | String |
id | Issue ID. | String |
version | Issue version. Each change to the issue parameters increases its version number. Issue edits will be disabled if the version number reaches the threshold value of 10100 (for robots) or 11100 (for users). |
Number |
key | Issue key. | String |
display | Display name of the issue. | String or object |
status
object fields
Parameter | Description | Data type |
---|---|---|
value | Status value. | String |
display | Display name of the status. | String or object |
If the request is processed incorrectly, the API returns a response with an error code:
- 400
- One or more request parameters have an invalid value.
- 401
- The user is not authorized. Make sure that actions described in the API access section are performed.
- 403
- You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.