인증
API 토큰을 발급받고자 하는 경우 여기서 기존 API 문서를 확인해 보자.
사용빈도 제한
론칭 시 “이지 엔드포인트” 버킷에 해당 엔드포인트를 적용한다. 이는 초당 요청 10건, 분당 요청 100건의 속도 제한을 뜻한다.
사용빈도 제한은 아래의 요청당 아이템 최대 건수와 마찬가지로 향후 변경될 수 있기 때문에 사용빈도 제한 초과 에러 처리 과정을 구축하는 것을 권한다. “사용빈도 제한 에러 응답” 섹션을 참고하자.
푸시 벌크 CSAT 점수
마에스트로QA로 여러 CSAT 점수를 일괄적으로 가져와 보자(요청당 아이템 최대 100건).
요청 헤더
API 토큰 키(apiToken key)에서 요청 헤더에 API 토큰을 포함할 수 있다.
요청 본문 (JSON)
{ data: [ { submitted_at: string, // the iso formatted datetime the survey response was submitted [year]-[month]-[day]T[hour]:[minute]:[second]Z ex. 2017-12-13T05:00:00Z ticket_id: string, // the id of the ticket in the helpdesk system (such as Zendesk) agent_id: string, // the id of the agent in the helpdesk system - optional agent_email: string, // the email of the agent in the helpdesk system - optional score: int, // the csat score; qualtrics setups often have this as a multiple choice answer to one of the first questions in the survey comment: string, // optional customer comment; qualtrics setups often have this as a text answer to a follow up question score_label: string, // optional - textual equivalent to the numeric score - i.e. "Strongly Agree" min_score: int, // recommended, but optional - the minimum score achievable - defaults to 1 max_score: int, // recommended, but optional - the maximum score achievable - defaults to 5 clarifying_answers: [ // optional - other clarifying survey answers, if your qualtrics survey contains more than the 2 typical csat questions { question: string, // the question asked comment: string, //optional score: int, //optional score_label: string, // optional min_score: int, //optional - defaults to 1 max_score: int, // optional - defaults to 5 } ], }, ... // 100 items / request max ] } |
선택 사항으로 표시된 항목은 모두 제외할 수 있다. min_score와 max_score 항목은 향후 CSAT 점숫값의 범위를 변경하는 등 향후 사용을 위해 반드시 포함하는 것을 강력히 권고한다.
ticket_id와 agent_id, agent_email 항목은 마에스트로QA가 제출된 CSAT 점수를 올바른 티켓 및 상담원에게 배정하기 위해 사용함을 유의하자. 이는 또한 헬프데스크(젠데스크 혹은 세일즈포스 등) 셋업 식별자로 사용되어야 한다.
퀄트릭스 설문조사의 경우, ticket_id를 찾는 가장 쉬운 방법은 이를 퀄트릭스 설문조사 배포의 externalDataReference로 포함하는 것이다.
또한 agent_id나 agent_email을 보내는 것을 권한다(externalDataReference 생성을 설정할 수 있는 경우, ticket_id와 agent_id 모두 externalDataReference 내에 인코딩하고 호출할 수 있다). agent_id와 agent_email 모두 보내지 않은 경우, 아이템이 입력되지 않아 에러가 발생한다. 둘 다 보낸 경우 agent_id가 우선한다.
성공적 응답
Status 201 CREATED
{ status: "completed", total: 2, results: [ // zendesk inspired { "action": "create", "_id": “5840ec43ac414d9c9”, // internal maestro id "status": "Created", "success": true, }, { "action": "create", "status": "Failed: [[Error Message]]", "success": false, }, ] } |
|
에러 응답
Status 400 ERROR
{ error: "[error message]", } |
사용빈도 제한 에러 응답
Status 429 ERROR
{ error: "Too many requests in the past [second/minute].", } |