Comments

Request

GET

https://api.wiki.yandex.net/v1/pages/{idx}/comments

Path parameters

Name	Description
idx	Type: integer

Query parameters

Name	Description
cursor	Type: string Example: ``
order_by	Type: string If specified, sort the results by this field in the `direction` direction Const: `created_at` Example: ``
order_direction	All of: OrderDirection OrderDirection Type: string An enumeration. Enum: `asc`, `desc` If the `order_by` field is specified, the sort direction Default: `asc` Example: ``
page_size	Type: integer Number of results per page. Default: `50` Min value: `1` Max value: `100`
status_filter	All of: CommentResolveStatus CommentResolveStatus Type: string An enumeration. Enum: `resolved`, `unresolved` Filter by comment status; accepts CommentResolveStatus (resolved, unresolved) Example: ``

Responses

200 OK

Body

application/json

{
  "results": [
    {
      "id": 0,
      "body": "example",
      "inline_text": "example",
      "parent_id": 0,
      "author": {
        "id": 0,
        "identity": null,
        "username": "example",
        "display_name": "example",
        "is_dismissed": true,
        "affiliation": "example"
      },
      "thread_id": 0,
      "created_at": "2025-01-01T00:00:00Z",
      "is_deleted": true,
      "resolve_status": "resolved",
      "reactions": [
        {
          "type": "like",
          "author": null,
          "created_at": "2025-01-01T00:00:00Z"
        }
      ],
      "thread_info": {
        "total_posts": 0,
        "last_comment": {
          "id": 0,
          "body": "example",
          "inline_text": "example",
          "parent_id": 0,
          "author": null,
          "thread_id": 0,
          "created_at": "2025-01-01T00:00:00Z",
          "is_deleted": true,
          "resolve_status": null,
          "reactions": [
            null
          ]
        }
      }
    }
  ],
  "next_cursor": "example",
  "prev_cursor": "example"
}

Name	Description
results	Type: CommentSchemaExt[] Example [ { "id": 0, "body": "example", "inline_text": "example", "parent_id": 0, "author": { "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "thread_id": 0, "created_at": "2025-01-01T00:00:00Z", "is_deleted": true, "resolve_status": "resolved", "reactions": [ { "type": "like", "author": null, "created_at": "2025-01-01T00:00:00Z" } ], "thread_info": { "total_posts": 0, "last_comment": { "id": 0, "body": "example", "inline_text": "example", "parent_id": 0, "author": null, "thread_id": 0, "created_at": "2025-01-01T00:00:00Z", "is_deleted": true, "resolve_status": null, "reactions": [ null ] } } } ]
next_cursor	Type: string Example: `example`
prev_cursor	Type: string Example: `example`

UserIdentity

User identifier

Name

Description

cloud_uid

Type: string

User identifier in the cloud (for the external instance)

Example: example

uid

Type: string

User identifier in Yandex (for the internal instance)

Example: example

Example

{
  "uid": "example",
  "cloud_uid": "example"
}

UserSchema

Information about the user

Name	Description
affiliation	Type: string User affiliation (for example, `yandex`, `external`) Example: `example`
display_name	Type: string User display name Example: `example`
id	Type: integer Internal user identifier
is_dismissed	Type: boolean The user has been dismissed
username	Type: string User login Example: `example`
identity	All of 1 type UserIdentity Type: UserIdentity User identifier Example `{ "uid": "example", "cloud_uid": "example" }` User identifier in the system Example `{ "uid": "example", "cloud_uid": "example" }`

Example

{
  "id": 0,
  "identity": {
    "uid": "example",
    "cloud_uid": "example"
  },
  "username": "example",
  "display_name": "example",
  "is_dismissed": true,
  "affiliation": "example"
}

CommentResolveStatus

Comment resolve status:

resolved — the comment is resolved
unresolved — the comment is not resolved

Type: string

Enum: resolved, unresolved

ReactionType

Comment reaction type:

like — like
hooray — hooray
confused — confused
heart — heart
rocket — rocket
eyes — eyes
fire — fire
ok — ok
facepalm — facepalm
check — check mark
laugh — laugh
dislike — dislike

Type: string

Enum: like, hooray, confused, heart, rocket, eyes, fire, ok, facepalm, check, laugh, dislike

CommentReactionSchema

Name	Description
author	Type: UserSchema Information about the user Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }`
created_at	Type: string<date-time> Example: `2025-01-01T00:00:00Z`
type	Type: ReactionType Comment reaction type: `like` — like `hooray` — hooray `confused` — confused `heart` — heart `rocket` — rocket `eyes` — eyes `fire` — fire `ok` — ok `facepalm` — facepalm `check` — check mark `laugh` — laugh `dislike` — dislike Enum: `like`, `hooray`, `confused`, `heart`, `rocket`, `eyes`, `fire`, `ok`, `facepalm`, `check`, `laugh`, `dislike`

Example

{
  "type": "like",
  "author": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "created_at": "2025-01-01T00:00:00Z"
}

CommentSchema

A comment on the page

Name	Description
author	All of 1 type UserSchema Type: UserSchema Information about the user Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }` Comment author Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }`
body	Type: string Comment text Example: `example`
created_at	Type: string<date-time> Date and time the comment was created Example: `2025-01-01T00:00:00Z`
id	Type: integer Unique comment identifier
is_deleted	Type: boolean Comment deletion flag
reactions	Type: CommentReactionSchema[] Reactions to the comment Example `[ { "type": "like", "author": { "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "created_at": "2025-01-01T00:00:00Z" } ]`
resolve_status	All of 1 type CommentResolveStatus Type: CommentResolveStatus Comment resolve status: `resolved` — the comment is resolved `unresolved` — the comment is not resolved Enum: `resolved`, `unresolved` Comment resolve status Example: `resolved`
inline_text	Type: string The text the comment is attached to (for inline comments) Example: `example`
parent_id	Type: integer The ID of the parent comment (for replies in a thread)
thread_id	Type: integer Comment thread ID

Example

{
  "id": 0,
  "body": "example",
  "inline_text": "example",
  "parent_id": 0,
  "author": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "thread_id": 0,
  "created_at": "2025-01-01T00:00:00Z",
  "is_deleted": true,
  "resolve_status": "resolved",
  "reactions": [
    {
      "type": "like",
      "author": null,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}

ThreadSchema

Name

Description

last_comment

Type: CommentSchema

A comment on the page

Example

{
  "id": 0,
  "body": "example",
  "inline_text": "example",
  "parent_id": 0,
  "author": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "thread_id": 0,
  "created_at": "2025-01-01T00:00:00Z",
  "is_deleted": true,
  "resolve_status": "resolved",
  "reactions": [
    {
      "type": "like",
      "author": null,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}

total_posts

Type: integer

Example

{
  "total_posts": 0,
  "last_comment": {
    "id": 0,
    "body": "example",
    "inline_text": "example",
    "parent_id": 0,
    "author": {
      "id": 0,
      "identity": null,
      "username": "example",
      "display_name": "example",
      "is_dismissed": true,
      "affiliation": "example"
    },
    "thread_id": 0,
    "created_at": "2025-01-01T00:00:00Z",
    "is_deleted": true,
    "resolve_status": "resolved",
    "reactions": [
      {
        "type": "like",
        "author": null,
        "created_at": "2025-01-01T00:00:00Z"
      }
    ]
  }
}

CommentSchemaExt

Name	Description
author	Type: UserSchema Information about the user Example `{ "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }`
body	Type: string Example: `example`
created_at	Type: string<date-time> Example: `2025-01-01T00:00:00Z`
id	Type: integer
is_deleted	Type: boolean
reactions	Type: CommentReactionSchema[] Example `[ { "type": "like", "author": { "id": 0, "identity": { "uid": "example", "cloud_uid": "example" }, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "created_at": "2025-01-01T00:00:00Z" } ]`
resolve_status	Type: CommentResolveStatus Comment resolve status: `resolved` — the comment is resolved `unresolved` — the comment is not resolved Enum: `resolved`, `unresolved`
inline_text	Type: string Example: `example`
parent_id	Type: integer
thread_id	Type: integer
thread_info	Type: ThreadSchema Example `{ "total_posts": 0, "last_comment": { "id": 0, "body": "example", "inline_text": "example", "parent_id": 0, "author": { "id": 0, "identity": null, "username": "example", "display_name": "example", "is_dismissed": true, "affiliation": "example" }, "thread_id": 0, "created_at": "2025-01-01T00:00:00Z", "is_deleted": true, "resolve_status": "resolved", "reactions": [ { "type": "like", "author": null, "created_at": "2025-01-01T00:00:00Z" } ] } }`

Example

{
  "id": 0,
  "body": "example",
  "inline_text": "example",
  "parent_id": 0,
  "author": {
    "id": 0,
    "identity": {
      "uid": "example",
      "cloud_uid": "example"
    },
    "username": "example",
    "display_name": "example",
    "is_dismissed": true,
    "affiliation": "example"
  },
  "thread_id": 0,
  "created_at": "2025-01-01T00:00:00Z",
  "is_deleted": true,
  "resolve_status": "resolved",
  "reactions": [
    {
      "type": "like",
      "author": null,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "thread_info": {
    "total_posts": 0,
    "last_comment": {
      "id": 0,
      "body": "example",
      "inline_text": "example",
      "parent_id": 0,
      "author": null,
      "thread_id": 0,
      "created_at": "2025-01-01T00:00:00Z",
      "is_deleted": true,
      "resolve_status": null,
      "reactions": [
        null
      ]
    }
  }
}

Was the article helpful?

Overview

Create Comment