Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Selecting records by parameters

Written by
Updated at February 19, 2024

Use this request to fetch data about the time spent by a specific user or during a certain period. You can make a GET or POST request.

GET request format

To get records of time spent, use the HTTP GET request:

GET /v2/worklog?createdBy=<user_ID_or_name>&createdAt=from:<start>&createdAt=to:<end>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Request parameters

Additional parameters

Parameter Description Data type
createdBy ID or username of the record author. This is an optional parameter. String
createdAt=from Start of the time range the records were created in. Format: YYYY-MM-DDThh:mm:ss.sss±hhmm
Optional parameter.		 String
createdAt=to End of the time range the records are created in. Format: YYYY-MM-DDThh:mm:ss.sss±hhmm
Optional parameter.		 String

POST request format

To get records of time spent, use an HTTP POST request:

POST /v2/worklog/_search
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
  "createdBy": "veikus",
  "createdAt": {
    "from": "2018-06-06T08:42:15.258",
    "to": "2018-06-06T08:42:20.258"
  }
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Request body parameters
Parameter Description Data type
createdBy ID or username of the record author. This is an optional parameter. String
createdAt Object with information about the record creation date and time. This is an optional parameter. Object

createdAt object fields

Parameter Description Data type
from Start of the time range the records were created in. Format: YYYY-MM-DDThh:mm:ss.sss±hhmm String
to End of the time range the records are created in. Format: YYYY-MM-DDThh:mm:ss.sss±hhmm String

Response format

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

The response body contains a JSON array with records about the time spent, which were selected according to the specified parameters.

[
{
  "self": "https://https://api.tracker.yandex.net/v2/issues/TEST-324/worklog/1",
  "id": 1,
  "version": 1402121720882,
  "issue": {
    "self": "https://https://api.tracker.yandex.net/v2/issues/TEST-324",
    "id": "515ec9eae4b09cfa********",
    "key": "TEST-324",
    "display": "important issue"
  },
  "comment": "important comment",
  "createdBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/66********",
    "id": "veikus",
    "display": "Artem Veikus"
  },
  "updatedBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/66********",
    "id": "veikus",
    "display": "Artem Veikus"
  },
  "createdAt": "2018-06-06T08:42:06.258+0000",
  "updatedAt": "2018-06-06T08:42:06.258+0000",
  "start": "2018-06-06T08:41:58.000+0000",
  "duration": "P3W"
 },
  ...
]
Response parameters
Parameter Description Data type
self Address of the API resource with a record of the time spent on the issue. String
id ID of the record of time spent. String
version Record version. Each change to the record increases its version number. String
issue Block with information about the issue. Object
comment Text of the comment to the record. The comment is saved to the Time Spent report. String
createdBy Object with information about the record author. Object
updatedBy Object with information about the user who updated the record last. Object
createdAt Record creation date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
updatedAt Record update date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
start Date and time when work on the issue started, in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
duration Time spent, in PnYnMnDTnHnMnS, PnW format, according to the ISO 8601. String
issueobject fields
Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
key Issue key. String
display Issue name displayed. String

createdBy 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

updatedBy 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

If the request is processed incorrectly, the API returns a message with error details:

400
One or more request parameters have an invalid value.
403
Insufficient rights 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.
404
The requested object was not found. You may have specified an invalid object ID or key.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.
Previous
Getting all records for an issue
Next
Getting global fields