IrisAgent Feedback API Documentation

API Guide

Here is a curl command to call our feedback API:

curl --location \
'https://api1.irisagent.com/v1/reports/feedback?from=2024-07-01&to=2024-07-04&limit=10' \
--header 'X-Business-Id: REPLACE_ME_BUSINESS_ID'
  

The API inputs are as follows,

Field	Description
from	URL-encoded starting time string, e.g. 2021-01-01. This will match the time field of when the feedback vote was provided.
to	URL-encoded ending time string, e.g. 2021-01-01. This will match the time field of when the feedback vote was provided.
limit	Number of results to return. The default value is 1000.
REPLACE_ME_BUSINESS_ID	This is the ID provided by the IrisAgent team

The API output fields are as follows:

Field	Description
id	Unique ID of the feedback vote
acceptanceStatus	Status of the feedback vote. "accepted" means that the agent upvoted. "ignored" means that the agent downvoted. "pending" value is used when agent provides a textual feedback.
timestamp	UTC Time when the feedback vote was provided
type	Type of the item on which the feedback was provided. Possible values are "similar_cases", "resolution", "suggested_jira", "summary"
similarTicketId	Ticket ID of the similar case, if the type is "similar_cases"
sourceUserId	User ID of the agent who provided the feedback vote
ticketId	Ticket ID of the ticket on which the feedback was provided
textFeedback	Textual feedback provided by the agent, if the type is "pending". This field is empty for other types.

A sample output of the API:

{
  "data": [
    {
      "id": "6699e11db7c5974d1f74f850",
      "acceptanceStatus": "accepted",
      "timestamp": "2024-07-16T13:56:42.575Z",
      "type": "similar_cases",
      "similarTicketId": "236",
      "sourceUserId": "421221152",
      "ticketId": "2397",
      "textFeedback": "looks good"
    },
    {
      "id": "6699e11db7c5954d1f74f822",
      "acceptanceStatus": "accepted",
      "timestamp": "2024-07-16T13:56:37.833Z",
      "type": "resolution",
      "similarTicketId": "",
      "sourceUserId": "93221152",
      "ticketId": "232507",
      "textFeedback": "this is on point"
    },
    {
      "id": "6699e11db7c5974d1f74f822",
      "acceptanceStatus": "ignored",
      "timestamp": "2024-07-16T13:56:41.212Z",
      "type": "suggested_jira",
      "similarTicketId": "",
      "sourceUserId": "421391152",
      "ticketId": "2397",
      "textFeedback": "This Jira issue is obsolete"
    },
    {
      "id": "6699e11db7c5934d1f74f822",
      "acceptanceStatus": "accepted",
      "timestamp": "2024-07-16T13:56:39.883Z",
      "type": "similar_cases",
      "similarTicketId": "43620",
      "sourceUserId": "4211152",
      "ticketId": "2397"
    },
    {
      "id": "6699e11d44c5974d1f74f822",
      "acceptanceStatus": "ignored",
      "timestamp": "2024-07-16T13:56:38.545Z",
      "type": "summary",
      "sourceUserId": "493221152",
      "ticketId": "23507"
    }
  ]
}