Survey API Calls description

Hi,

I'm trying to full understand all the API calls available for surveys.

About

  • /api/v2/quality/surveys/{surveyId}

Described as Get a survey for a conversation, and the input is surveyId?? shouldn't be it conversationId? What the purpose of this call?

  • /api/v2/quality/surveys/scoring

It's described as score survey, and has also input necessary to score a survey, but no interactionId/conversationId to link to, so how does that makes sense? Scoring a survey only makes sense if it's interaction binded, not in a general way

Hello,

The GET /api/v2/quality/surveys/{surveyId} is indeed expecting a surveyId.
I assume that the description says "Get a survey for a conversation" as a survey is always triggered out of a conversation.
I mean a Policy (survey) being evaluated and matched after a conversation, which triggers the creation of a survey.

The survey is not "included" in a conversation context, like you would have for a call/chat/callback/email/....
You can get the id of a survey, attached/linked to a conversation, getting the conversation details (Analytics API).
I mean:
GET /api/v2/analytics/conversations/{conversationId}/details
GET /api/v2/analytics/conversations/details
POST /api/v2/analytics/conversations/details/query

I am not familiar with the POST /api/v2/quality/surveys/scoring

But to answer the survey via API, you would use PUT /api/v2/quality/surveys/scorable
See here for some info: https://developer.mypurecloud.de/forum/t/example-of-successful-request-to-score-qm-survey/7151

The customerSurveyUrl is available while processing Architect Survey Invite flow, as an Architect built-in variable.

Regards,

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.