Getting entity event history

The request allows you to get a paginated entity event history.

GET

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>/events/_relative

Query format

Before making a request, get permission to access the API.

To get the paginated event history, use an HTTP GET request.

GET /v3/entities/<entity_type>/<entity_ID>/events/_relative
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 or X-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
<entity_type>	Entity type: project portfolio goal	String
<entity_ID>	Entity ID. To get the ID, see the entity list. You can use the `id` or `shortId` parameter as the ID.	String

Request parameters

If no parameters are specified, the full list of events is displayed.

Additional parameters

Parameter	Description	Data type
perPage	Sets the maximum number of events in the response. The default value is 50.	Number
from	ID of the event after which the list starts to be generated. The event itself is not included in the list. Not used together with the `selected` parameter.	String
selected	ID of the event around which the list is generated. Not specified together with the `from` parameter. The list is generated in the following order (for `perPage=5`): Event with the specified ID. Event that precedes the first event. Event that follows the first event. Event that precedes the second event. Event that follows the third event.	String
newEventsOnTop	Reverses the order of events in the list. The default value is `false`.	Boolean
direction	Sets the order of events in the list: `forward` (default) `backward`: Inverts the `newEventsOnTop` parameter value	String

Example: Getting a list of events

An HTTP GET method is used.

The response displays information about three events.

The list starts with the event following <event_1_ID>.
GET https://api.tracker.yandex.net/v3/entities/project/<project_ID>/events/_relative?perPage=3&from=<ID_of_event_1>

Response format

Request executed successfully

Request failed

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about the entity events in JSON format.

{
    "events": [
        {
            "id": "65a26b254dbe6212********",
            "author": {
                "self": "https://api.tracker.yandex.net/v3/users/19********",
                "id": "19********",
                "display": "Full name",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": "16********"
            },
            "date": "2024-01-13T10:51:17.821+0000",
            "transport": "v3",
            "display": "Issue updated",
            "changes": [
                {
                    "diff": "<added>Full_name</added>",
                    "field": {
                        "id": "teamUsers",
                        "display": "Participants"
                    }
                }
            ]
        },
        {
            "id": "65a26b264dbe6215********",
            "author": {
                "self": "https://api.tracker.yandex.net/v3/users/19********",
                "id": "19********",
                "display": "Full name",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": "16********"
            },
            "date": "2024-01-13T10:51:17.954+0000",
            "transport": "v3",
            "display": "Comment added",
            "changes": [
                {
                    "diff": "<added>First comment added</added>",
                    "field": {
                        "id": "comment.text",
                        "display": "Comment text",
                        "addedSummonees": [
                            {
                                "self": "https://api.tracker.yandex.net/v3/users/19********",
                                "id": "19********",
                                "display": "Full name",
                                "cloudUid": "ajeppa7dgp71********",
                                "passportUid": "16********"
                            }
                        ],
                        "email": None
                    },
                    "commentUrl": ""
                }
            ]
        },
        {
            "id": "65a26b384dbe6216********",  
            "author": {
                "self": "https://api.tracker.yandex.net/v3/users/19********",
                "id": "19********",
                "display": "Full name",
                "cloudUid": "ajeppa7dgp71********",
                "passportUid": "16********"
            },
            "date": "2024-01-13T10:51:36.807+0000",
            "transport": "v3",
            "display": "File added",
            "changes": [
                {
                    "diff": "<added>Adding file to a comment.</added>",
                    "field": {
                        "id": "comment.text",
                        "display": "Comment text",
                        "email": None
                    },
                    "commentUrl": ""
                },
                {
                    "diff": "<added>image.jpg</added>",
                    "field": {
                        "id": "issue.attachments",
                        "display": "Attachments"
                    }
                }
            ]
        }
    ],
    "hasNext": True,
    "hasPrev": True
}

Response parameters

Parameter	Description	Data type
events	Array of objects with information about the events	Array of objects
hasNext	Indicates the presence of subsequent entries in the list.	Boolean
hasPrev	Indicates the presence of previous entries in the list.	Boolean

events array object fields

Parameter	Description	Data type
id	Event ID	String
author	Object with the event author information	Map item
date	Event creation date and time in the format: `YYYY-MM-DDThh:mm:ss.sss±hhmm`	String
transport	Service parameter	String
display	Displayed event name	String
changes	Array of objects with information about the changes. Composition and contents of object fields depend on the parameter you change.	Array of objects

author object fields

Parameter	Description	Data type
self	Address of the API resource with information about the user	String
id	User ID.	String
display	Displayed user name	String
passportUid	Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID.	Number
cloudUid	Unique user ID in Yandex Cloud Organization	String

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.

404: The requested object was not found. You may have specified an invalid object ID or key.

422: JSON validation error, the request is rejected.

Was the article helpful?

Bulk changes to entities

Adding a comment