DialogueFeedbackBundleRead

The full feedback bundle for a dialogue — its review, ratings, comments and kanban cards.

review object

anyOf

• FeedbackReviewRead
• null

idIdrequired

Unique numeric identifier of the record.

submitted_at objectrequired

anyOf

• date-time
• null

date-time

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

author_idAuthor Idrequired

ratings object[]

Array [

idIdrequired

Unique numeric identifier of the record.

option_idOption Idrequired

review_idReview Idrequired

scoreScorerequired

selected_suggestionsstring[]

created_atdate-timerequired

Creation time (UTC, ISO 8601).

]

dialogue_comment object

anyOf

• FeedbackCommentTreeRead
• null

textTextrequired

The comment text.

author_idAuthor Idrequired

stateFeedbackCommentState

Whether the comment is open or resolved.

Possible values: [open, resolved]

Default value: open

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

message_id object

ID of the message the comment is attached to, if message-scoped.

anyOf

• integer
• null

integer

msg_start_idx object

Start character index for an inline partial-message comment.

anyOf

• integer
• null

integer

msg_end_idx object

End character index for an inline partial-message comment.

anyOf

• integer
• null

integer

rating_id object

ID of the rating the comment is attached to, if rating-scoped.

anyOf

• integer
• null

integer

comment_id object

ID of the parent comment, if this is a reply.

anyOf

• integer
• null

integer

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

author objectrequired

A platform user (without credentials).

idIdrequired

Unique numeric identifier of the record.

usernameUsernamerequired

The user's login name.

email object

Email used to match this local user during Yandex ID OAuth login, if configured.

anyOf

• string
• null

string

roleUserRolerequired

The user's role — user, manager, or admin.

Possible values: [user, manager, admin]

is_activeIs Active

Whether this user is allowed to authenticate and use the platform.

Default value: true

created_atdate-timerequired

Creation time (UTC, ISO 8601).

company_idsinteger[]

Company memberships granted to this user. Admin users can access all companies.

message_context object

anyOf

• FeedbackCommentMessageContextRead
• null

idIdrequired

Unique numeric identifier of the record.

messageMessagerequired

file_caption object

anyOf

• string
• null

string

display_textDisplay Textrequired

quote object

anyOf

• string
• null

string

repliesundefined[]

kanban_card object

anyOf

• FeedbackKanbanCardRead
• null

comment_idComment Idrequired

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

columnFeedbackKanbanColumnrequired

Possible values: [new, grooming, in_progress, done]

orderOrderrequired

Possible values: >= 0

notesNotes

Default value:

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

inline_comments object[]

Array [

textTextrequired

The comment text.

author_idAuthor Idrequired

stateFeedbackCommentState

Whether the comment is open or resolved.

Possible values: [open, resolved]

Default value: open

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

message_id object

ID of the message the comment is attached to, if message-scoped.

anyOf

• integer
• null

integer

msg_start_idx object

Start character index for an inline partial-message comment.

anyOf

• integer
• null

integer

msg_end_idx object

End character index for an inline partial-message comment.

anyOf

• integer
• null

integer

rating_id object

ID of the rating the comment is attached to, if rating-scoped.

anyOf

• integer
• null

integer

comment_id object

ID of the parent comment, if this is a reply.

anyOf

• integer
• null

integer

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

author objectrequired

A platform user (without credentials).

idIdrequired

Unique numeric identifier of the record.

usernameUsernamerequired

The user's login name.

email object

Email used to match this local user during Yandex ID OAuth login, if configured.

anyOf

• string
• null

string

roleUserRolerequired

The user's role — user, manager, or admin.

Possible values: [user, manager, admin]

is_activeIs Active

Whether this user is allowed to authenticate and use the platform.

Default value: true

created_atdate-timerequired

Creation time (UTC, ISO 8601).

company_idsinteger[]

Company memberships granted to this user. Admin users can access all companies.

message_context object

anyOf

• FeedbackCommentMessageContextRead
• null

idIdrequired

Unique numeric identifier of the record.

messageMessagerequired

file_caption object

anyOf

• string
• null

string

display_textDisplay Textrequired

quote object

anyOf

• string
• null

string

repliesundefined[]

kanban_card object

anyOf

• FeedbackKanbanCardRead
• null

comment_idComment Idrequired

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

columnFeedbackKanbanColumnrequired

Possible values: [new, grooming, in_progress, done]

orderOrderrequired

Possible values: >= 0

notesNotes

Default value:

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

]

rating_comments object[]

Array [

textTextrequired

The comment text.

author_idAuthor Idrequired

stateFeedbackCommentState

Whether the comment is open or resolved.

Possible values: [open, resolved]

Default value: open

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

message_id object

ID of the message the comment is attached to, if message-scoped.

anyOf

• integer
• null

integer

msg_start_idx object

Start character index for an inline partial-message comment.

anyOf

• integer
• null

integer

msg_end_idx object

End character index for an inline partial-message comment.

anyOf

• integer
• null

integer

rating_id object

ID of the rating the comment is attached to, if rating-scoped.

anyOf

• integer
• null

integer

comment_id object

ID of the parent comment, if this is a reply.

anyOf

• integer
• null

integer

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

author objectrequired

A platform user (without credentials).

idIdrequired

Unique numeric identifier of the record.

usernameUsernamerequired

The user's login name.

email object

Email used to match this local user during Yandex ID OAuth login, if configured.

anyOf

• string
• null

string

roleUserRolerequired

The user's role — user, manager, or admin.

Possible values: [user, manager, admin]

is_activeIs Active

Whether this user is allowed to authenticate and use the platform.

Default value: true

created_atdate-timerequired

Creation time (UTC, ISO 8601).

company_idsinteger[]

Company memberships granted to this user. Admin users can access all companies.

message_context object

anyOf

• FeedbackCommentMessageContextRead
• null

idIdrequired

Unique numeric identifier of the record.

messageMessagerequired

file_caption object

anyOf

• string
• null

string

display_textDisplay Textrequired

quote object

anyOf

• string
• null

string

repliesundefined[]

kanban_card object

anyOf

• FeedbackKanbanCardRead
• null

comment_idComment Idrequired

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

columnFeedbackKanbanColumnrequired

Possible values: [new, grooming, in_progress, done]

orderOrderrequired

Possible values: >= 0

notesNotes

Default value:

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

]

kanban_cards object[]

Array [

comment_idComment Idrequired

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

columnFeedbackKanbanColumnrequired

The kanban column the card is in (new, grooming, in_progress, done).

Possible values: [new, grooming, in_progress, done]

orderOrderrequired

Ordering of the card within its column.

Possible values: >= 0

notesNotes

Free-form notes on the card.

Default value:

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

comment objectrequired

A reviewer comment on a dialogue, with its nested replies. A comment is scoped to exactly one of: a message (optionally a character range within it), a rating, or another comment; otherwise it is dialogue-level.

textTextrequired

The comment text.

author_idAuthor Idrequired

stateFeedbackCommentState

Whether the comment is open or resolved.

Possible values: [open, resolved]

Default value: open

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

message_id object

ID of the message the comment is attached to, if message-scoped.

anyOf

• integer
• null

integer

msg_start_idx object

Start character index for an inline partial-message comment.

anyOf

• integer
• null

integer

msg_end_idx object

End character index for an inline partial-message comment.

anyOf

• integer
• null

integer

rating_id object

ID of the rating the comment is attached to, if rating-scoped.

anyOf

• integer
• null

integer

comment_id object

ID of the parent comment, if this is a reply.

anyOf

• integer
• null

integer

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

author objectrequired

A platform user (without credentials).

idIdrequired

Unique numeric identifier of the record.

usernameUsernamerequired

The user's login name.

email object

Email used to match this local user during Yandex ID OAuth login, if configured.

anyOf

• string
• null

string

roleUserRolerequired

The user's role — user, manager, or admin.

Possible values: [user, manager, admin]

is_activeIs Active

Whether this user is allowed to authenticate and use the platform.

Default value: true

created_atdate-timerequired

Creation time (UTC, ISO 8601).

company_idsinteger[]

Company memberships granted to this user. Admin users can access all companies.

message_context object

anyOf

• FeedbackCommentMessageContextRead
• null

idIdrequired

Unique numeric identifier of the record.

messageMessagerequired

file_caption object

anyOf

• string
• null

string

display_textDisplay Textrequired

quote object

anyOf

• string
• null

string

repliesundefined[]

kanban_card object

anyOf

• FeedbackKanbanCardRead
• null

comment_idComment Idrequired

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

columnFeedbackKanbanColumnrequired

Possible values: [new, grooming, in_progress, done]

orderOrderrequired

Possible values: >= 0

notesNotes

Default value:

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

]

DialogueFeedbackBundleRead

{
  "review": {
    "id": 0,
    "submitted_at": "2024-07-29T15:51:28.071Z",
    "dialogue_id": 0,
    "author_id": 0
  },
  "ratings": [
    {
      "id": 0,
      "option_id": 0,
      "review_id": 0,
      "score": 0,
      "selected_suggestions": [
        "string"
      ],
      "created_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "dialogue_comment": {
    "text": "string",
    "author_id": 0,
    "state": "open",
    "dialogue_id": 0,
    "message_id": 0,
    "msg_start_idx": 0,
    "msg_end_idx": 0,
    "rating_id": 0,
    "comment_id": 0,
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "author": {
      "id": 0,
      "username": "string",
      "email": "string",
      "role": "user",
      "is_active": true,
      "created_at": "2024-07-29T15:51:28.071Z",
      "company_ids": [
        0
      ]
    },
    "message_context": {
      "id": 0,
      "message": "string",
      "file_caption": "string",
      "display_text": "string",
      "quote": "string"
    },
    "replies": [
      null
    ],
    "kanban_card": {
      "comment_id": 0,
      "dialogue_id": 0,
      "column": "new",
      "order": 0,
      "notes": "",
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  },
  "inline_comments": [
    {
      "text": "string",
      "author_id": 0,
      "state": "open",
      "dialogue_id": 0,
      "message_id": 0,
      "msg_start_idx": 0,
      "msg_end_idx": 0,
      "rating_id": 0,
      "comment_id": 0,
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "author": {
        "id": 0,
        "username": "string",
        "email": "string",
        "role": "user",
        "is_active": true,
        "created_at": "2024-07-29T15:51:28.071Z",
        "company_ids": [
          0
        ]
      },
      "message_context": {
        "id": 0,
        "message": "string",
        "file_caption": "string",
        "display_text": "string",
        "quote": "string"
      },
      "replies": [
        null
      ],
      "kanban_card": {
        "comment_id": 0,
        "dialogue_id": 0,
        "column": "new",
        "order": 0,
        "notes": "",
        "id": 0,
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z"
      }
    }
  ],
  "rating_comments": [
    {
      "text": "string",
      "author_id": 0,
      "state": "open",
      "dialogue_id": 0,
      "message_id": 0,
      "msg_start_idx": 0,
      "msg_end_idx": 0,
      "rating_id": 0,
      "comment_id": 0,
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "author": {
        "id": 0,
        "username": "string",
        "email": "string",
        "role": "user",
        "is_active": true,
        "created_at": "2024-07-29T15:51:28.071Z",
        "company_ids": [
          0
        ]
      },
      "message_context": {
        "id": 0,
        "message": "string",
        "file_caption": "string",
        "display_text": "string",
        "quote": "string"
      },
      "replies": [
        null
      ],
      "kanban_card": {
        "comment_id": 0,
        "dialogue_id": 0,
        "column": "new",
        "order": 0,
        "notes": "",
        "id": 0,
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z"
      }
    }
  ],
  "kanban_cards": [
    {
      "comment_id": 0,
      "dialogue_id": 0,
      "column": "new",
      "order": 0,
      "notes": "",
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "comment": {
        "text": "string",
        "author_id": 0,
        "state": "open",
        "dialogue_id": 0,
        "message_id": 0,
        "msg_start_idx": 0,
        "msg_end_idx": 0,
        "rating_id": 0,
        "comment_id": 0,
        "id": 0,
        "created_at": "2024-07-29T15:51:28.071Z",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "author": {
          "id": 0,
          "username": "string",
          "email": "string",
          "role": "user",
          "is_active": true,
          "created_at": "2024-07-29T15:51:28.071Z",
          "company_ids": [
            0
          ]
        },
        "message_context": {
          "id": 0,
          "message": "string",
          "file_caption": "string",
          "display_text": "string",
          "quote": "string"
        },
        "replies": [
          null
        ],
        "kanban_card": {
          "comment_id": 0,
          "dialogue_id": 0,
          "column": "new",
          "order": 0,
          "notes": "",
          "id": 0,
          "created_at": "2024-07-29T15:51:28.071Z",
          "updated_at": "2024-07-29T15:51:28.071Z"
        }
      }
    }
  ]
}