Getting the list of original texts

Returns a list of all of the site's original texts uploaded to Yandex.Webmaster.

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

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/original-texts/[?offset={offset}&limit={limit}]

Path parameters

Name Required Type Default value Description
user-id Yes int64 User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method.
host-id Yes host id The site ID. To get it, use the GET /user/{user-id}/hosts method.

Query parameters

Name Required Type Default value Description
offset No int32 0 Offset in the received list. The minimum value is 0.
limit No int32 10 Page size (1-100).

Response format

Examples

{
  "original_texts": [
    {
      "id": "explicit error message",
      "content_snippet": "explicit error message",
      "date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ],
  "count": 1,
  "quota_remainder": 1
}
Name Required Type Description
id Yes string The original text ID.
content_snippet Yes string The original text fragment.
date No datetime Date when the original text was added.
count Yes int32 The number of original texts added.
quota_remainder Yes int32 The remainder of the daily quota for the number of added texts.

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
200 OK
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Site management rights are not verified.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}