Getting the uploads list

Returns the list of uploaded RSS feeds for the last month.

  1. Request format
  2. Response format
  3. Response codes
  4. Example

Request format

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/turbo/tasks
 ? [task_type_filter=<string>]
 & [load_status_filter=<string>]
 & [offset=<int32>]
 & [limit=<int32>]
Path parameters
user-idUser ID. To get the value, use the GET /v4/user operation.
host-id
Site ID. Has the scheme:host:port format, where
  • scheme — The http or https protocol.
  • host — Site URL with or without www.
  • port — The port to connect to. For the http protocol — 80, for the https protocol — 443.

For example: https:example.com:443 or http:www.example.com:80.

You can also get the site ID using the operation GET /user/{user-id}/hosts.

Query parameters
task_type_filterFilter by the RSS feed upload mode. Possible values:
  • DEBUG
  • PRODUCTION
  • ALL

For example, filtering by DEBUG mode returns a list of tasks in the debug mode.

load_status_filterFilter by the RSS feed upload status. Possible values:
  • PROCESSING
  • OK
  • WARNING
  • ERROR

For example, filter by the PROCESSING status returns a list of tasks with the processing status.

offsetOffset in the list. The minimum value is 0.

The offset query parameter can be used together with the limit parameter, for example, to add pagination.

limitMaximum list items number. The minimum value is 1; the maximum value is 100.

The default value is 100.

Response format

The service returns data in either JSON (default) or XML format. To get the XML response, pass the HTTP header Accept: application/xml in the request.

{
  "tasks": [
    {
      "task_id": "string",
      "created_at": "YYYY-MM-DDThh:mm:ss±hh:mm",
      "load_status": "string"
    },
    ...
  ],
  "count": 1
}
task_id
The ID for the RSS feed upload task.
created_at
The date and time the RSS feed upload task was created.
load_status
The status of the RSS feed upload. Possible values:
  • PROCESSING — The file is validated for errors.
  • OK —The file is uploaded and doesn't contain errors.
  • WARNING — XML elements in the file aren't supported by Yandex or are specified incorrectly.
  • ERROR — The file contains errors (for example, duplicate XML elements).
count
Total number of tasks.

Response codes

Code Description
200 OK The request is successfully completed.
403 Forbidden
INVALID_USER_ID
The ID of the user who issued the token differs from the one specified in the request. The examples below {user_id} show the correct uid of the OAuth token owner.
Example response
{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
error_code
Error code.
available_user_id
ID of the user who allowed access.
error_message
Error message.
404 Not Found
HOST_NOT_VERIFIED
Site management rights are not verified.
Example response
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
error_code
Error code.
host_id
ID of the requested site.
error_message
Error message.

Example

Request:

curl -X GET \
  'https://api.webmaster.yandex.net/v3.2/user/12345678/hosts/https:example.com:443/turbo/tasks' \
  -H 'Authorization: OAuth oauth_token'

Response:

{
  "tasks": [
    {
      "task_id": "49a8f860-ebf7-11e8-b31a-ed044935f842",
      "created_at": "2018-11-19T15:33:16.006+03:00",
      "load_status": "OK"
    }
  ]
}