{"id":48933,"date":"2022-11-20T04:50:33","date_gmt":"2022-11-20T04:50:33","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=48933"},"modified":"2023-07-26T06:06:47","modified_gmt":"2023-07-26T05:06:47","slug":"feedback-survey-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/feedback-survey-api\/","title":{"rendered":"Feedback Survey API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To fetch the feedback survey scores provided by the user in the conversation with a virtual assistant and push the data for visualization on the Feedback Analytics<\/b> module using the Survey Type<\/i><\/b> and Survey Name<\/i><\/b>.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\n https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/saveFeedback<\/code><\/span><\/p>\n

 <\/td>\n<\/tr>\n

Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Metrics<\/li>\n
  • Admin Console: Bot Analytics > Feedback Analytics<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nType<\/b><\/th>\n<\/tr>\n
    host<\/b><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nstring, required<\/td>\n<\/tr>\n
    BotId<\/b><\/td>\nBot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/p>\n

    Note<\/b>: This is required only for Bot Builder API scope of Proactive Messages.<\/td>\n

    		string, required<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n

    curl --location 'https:\/\/{{host}}\/api\/1.1\/public\/bot\/{{botId}}\/saveFeedback' \\
    \n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\
    \n--header 'Content-Type: application\/json' \\
    \n--data-raw '{
    \n\"channelUId\":\"qatesting@vomoto.com\",
    \n\"name\":\"Thumb\",
    \n\"score\":0,
    \n\"channel\":\"rtm\",
    \n\"type\":\"THUMB\",
    \n\"language\":\"en\",
    \n\"message\":\"\"
    \n}'<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

    \r\n\t\t
    \r\n\t\t\t

    Request Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nType<\/b><\/th>\n<\/tr>\n
    channelUId<\/span><\/td>\nThe ID of the user on the channel where the feedback survey was triggered. Can be the user’s email id or enterprise assigned unique id.<\/td>\nstring, required<\/td>\n<\/tr>\n
    name<\/span><\/td>\nThe name of the survey provided by the user.<\/td>\nstring, required<\/td>\n<\/tr>\n
    score<\/span><\/td>\nThe feedback survey score provided by the user as a response.<\/td>\nnumber, required<\/td>\n<\/tr>\n
    channel<\/td>\nThe channel used for the feedback survey.<\/td>\nstring, required<\/td>\n<\/tr>\n
    type<\/td>\nOne of the feedback survey types THUMB, NPS, or CSAT.<\/td>\nstring, required<\/td>\n<\/tr>\n
    language<\/td>\nThe language in which the Feedback survey is triggered.<\/td>\nstring, required<\/td>\n<\/tr>\n
    message<\/td>\nThe message prompted to the user during the feedback survey.<\/td>\nstring, required<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t

    \r\n\t\t
    \r\n\t\t\t

    Sample Response<\/span><\/h2>\n

    {
    \n\"botId\": \"st-053cd130-f983-577a-8aad-2504aebd60b9\",
    \n\"channel\": \"rtm\",
    \n\"language\": \"en\",
    \n\"score\": 0,
    \n\"timestamp\": \"2023-03-23T07:07:43.538Z\",
    \n\"createdOn\": \"2023-03-23T07:07:43.538Z\",
    \n\"timestampValue\": 1679555263538,
    \n\"type\": \"THUMB\",
    \n\"name\": \"Thumb\",
    \n\"channelUId\": \"qatesting@vomoto.com\",
    \n\"orgId\": \"o-89b0abd5-19af-5017-a80a-6fc6bfc7a638\",
    \n\"accountId\": \"60dbef1bc2f5c25106cdb57d\",
    \n\"userId\": \"u-f5d97fb8-8767-5b6c-a28d-09e9ac281e12\",
    \n\"_id\": \"641bfabf0353f52d915f7a87\",
    \n\"__v\": 0
    \n}<\/code><\/p>\n

    Response Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nType<\/b><\/th>\n<\/tr>\n
    botId<\/span><\/td>\nThe ID of the virtual assistant for which feedback was given. You can access it from the virtual assistant\u2019s General Settings<\/b> page.<\/td>\nstring, required<\/td>\n<\/tr>\n
    channel<\/span><\/td>\nThe channel on which the user responds to the feedback survey.<\/td>\nstring, required<\/td>\n<\/tr>\n
    language<\/span><\/td>\nThe language in which the feedback survey is triggered.<\/td>\nstring, required<\/td>\n<\/tr>\n
    score<\/td>\nThe feedback score.<\/td>\nnumber, required<\/td>\n<\/tr>\n
    timestamp<\/td>\nFeedback response date converted into timestamp format.<\/td>\ndate (ISO Date format YYYY-MM-DDThh:mm:ss.mmmZ), required<\/td>\n<\/tr>\n
    createdOn<\/td>\nFeedback creation date converted into timestamp format.<\/td>\ndate (ISO Date format YYYY-MM-DDThh:mm:ss.mmmZ), required<\/td>\n<\/tr>\n
    timestampValue<\/td>\nCreation date converted into timestamp numeric format.<\/td>\nnumber, required<\/td>\n<\/tr>\n
    type<\/span><\/td>\nThe feedback survey type.<\/td>\nstring, required<\/td>\n<\/tr>\n
    name<\/span><\/td>\nThe feedback survey name.<\/td>\nstring, required<\/td>\n<\/tr>\n
    channelUId<\/span><\/td>\nThe end-user\u2019s channel user identifier.<\/td>\nstring, required<\/td>\n<\/tr>\n
    orgId<\/span><\/td>\nOrganization id the bot belongs to.<\/td>\nstring, required<\/td>\n<\/tr>\n
    accountId<\/span><\/td>\nAccount id the bot belongs to.<\/td>\nstring, required<\/td>\n<\/tr>\n
    userId<\/span><\/td>\nUser id the bot belongs to.<\/td>\nstring, required<\/td>\n<\/tr>\n
    _Id<\/span><\/td>\nUnique identifier for the message record.<\/td>\nstring, required<\/td>\n<\/tr>\n
    __v<\/span><\/td>\nThe value is always 0. Does not have any significance as of now.<\/td>\ninteger, optional<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

     <\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To fetch the feedback survey scores provided by the user in the conversation with a virtual assistant and push the data for visualization on the Feedback Analytics module using the Survey Type and Survey Name.   Method POST Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/saveFeedback   Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API...","protected":false},"author":21,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-48933","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/48933","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=48933"}],"version-history":[{"count":28,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/48933\/revisions"}],"predecessor-version":[{"id":58388,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/48933\/revisions\/58388"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=48933"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=48933"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=48933"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}