Select 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 request format
To get records of time spent, use the HTTP GET
request method:
GET /v2/worklog?createdBy=<user ID or name>&createdAt=from:<start of the time range>&createdAt=to:<end of the time range>
Host: https://api.tracker.yandex.net
Authorization: OAuth <token>
X-Org-ID: <organization ID>
-
Host
API host address:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <token value>
format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Organization ID.
Additional parameters
Parameter | Description | Data type |
---|---|---|
createdBy | ID or username of the record author. Optional parameter. | String |
createdAt=from | Start of the time range the records are 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 <token>
X-Org-ID: <organization ID>
{
"createdBy": "veikus",
"createdAt": {
"from": "2018-06-06T08:42:15.258",
"to": "2018-06-06T08:42:20.258"
}
}
-
Host
API host address:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <token value>
format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Organization ID.
Parameter | Description | Data type |
---|---|---|
createdBy | ID or username of the record author. Optional parameter. | String |
createdAt | Object with information about the record creation date and time. Optional parameter. | Object |
Object fields createdAt
Parameter | Description | Data type |
---|---|---|
from | Start of the time range the records are 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://api.tracker.yandex.net/v2/issues/TEST-324/worklog/1",
"id": 1,
"version": 1402121720882,
"issue": {
"self": "https://api.tracker.yandex.net/v2/issues/TEST-324",
"id": "515ec9eae4b09cfa984e2047",
"key": "TEST-324",
"display": "important issue"
},
"comment": "important comment",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000014909",
"id": "veikus",
"display": "Artem Veikus"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000014909",
"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"
},
...
]
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 |
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 |
Object fields createdBy
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user. | String |
id | User ID. | String |
display | User's name displayed. | String |
Object fields updatedBy
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user. | String |
id | User ID. | String |
display | User's name displayed. | String |
If a request fails, the response message contains details of the errors encountered:
- 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.