Skip to main content

Get agent message feedback

GET 
/api/v2/Agent/:agentCode/feedback

Returns a paginated list of the feedback your users have submitted on this agent's messages, newest first.

Each record pairs the user message with the agent message it rates, together with the boolean feedback value, an optional free-text comment, and the channel and user identifier the execution was attributed to. Use startDate and endDate to bound the results by dateUtc, and sortDirection to order by that same field.

Request​

Path Parameters

    agentCode stringrequired

    Code of the agent whose message feedback is requested.

Query Parameters

    page int32

    Default value: 1

    The page number to retrieve. Default is 1.

    pageSize int32

    Default value: 20

    Number of items per page. Default is 20.

    startDate date-time

    Only return feedback recorded on or after this UTC date and time.

    endDate date-time

    Only return feedback recorded on or before this UTC date and time.

    sortDirection string

    Default value: desc

    Sort order applied to dateUtc. desc (the default) returns the newest feedback first, asc the oldest.

    culture string

    Use this param to override the culture of the response. Options: - en (default) - es

Responses​

Returns a paginated list of the agent's message feedback.

Schema

    items

    object[]

    nullable

  • Array [

    • links

    object[]

    nullable

  • Array [

    • method stringnullable
    url stringnullable
    rel stringnullable

  • ]

    • agentCode stringnullable
    id uuid
    conversationId uuidnullable
    agentMessageId uuid
    userMessage stringnullable
    agentMessage stringnullable
    channel stringnullable
    dateUtc date-time
    feedback boolean

    Whether the rating is positive. true is a thumbs up, false a thumbs down.

    comment stringnullable
    userIdentifier stringnullable

  • ]

    • total int64
    pageSize int32
    page int32

    links

    object[]

    nullable

  • Array [

    • method stringnullable
    url stringnullable
    rel stringnullable

  • ]

    • agentCode stringnullable
Loading...