Selecting records by parameters

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

https://api.tracker.yandex.net/v3/worklog?createdBy=<user_login_or_ID>&createdAt=from:<start>&createdAt=to:<end>

GET request format

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

GET /v3/worklog?createdBy=<user_login_or_ID>&createdAt=from:<start>&createdAt=to:<end>
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.

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 interval during which the records were created, in `YYYY-MM-DDThh:mm:ss.sss±hhmm`format. This is an optional parameter. When using this parameter, specify the `createdBy` value.	String
createdAt=to	End of the time interval during which the records were created, in `YYYY-MM-DDThh:mm:ss.sss±hhmm`format. This is an optional parameter. When using this parameter, specify the `createdBy` value.	String

POST request format

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

POST /v3/worklog/_search
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-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.
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.

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.	Map item

createdAt object fields

Parameter	Description	Data type
from	Start of the time interval during which the records were created, in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format	String
to	End of the time interval during which the records were created, in `YYYY-MM-DDThh:mm:ss.sss±hhmm` format	String

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 a JSON array with records about the time spent, which were selected according to the specified parameters.

[
{
  "self": "https://api.tracker.yandex.net/v3/issues/TEST-324/worklog/1",
  "id": 1,
  "version": 1402121720882,
  "issue": {
    "self": "https://api.tracker.yandex.net/v3/issues/TEST-324",
    "id": "515ec9eae4b09cfa********",
    "key": "TEST-324",
    "display": "important issue"
  },
  "comment": "important comment",
  "createdBy": {
    "self": "https://api.tracker.yandex.net/v3/users/66********",
    "id": "veikus",
    "display": "Artem Veikus"
  },
  "updatedBy": {
    "self": "https://api.tracker.yandex.net/v3/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 issue details.	Map item
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.	Map item
updatedBy	Object with information about the user who updated the record last.	Map item
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

`issue`object 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: 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.

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

500: Internal service error. Try again later.

503: The API service is temporarily unavailable.

Was the article helpful?

Getting all records for an issue

Getting a list of external applications