인증
API 토큰을 발급받고자 하는 경우 여기서 기존 API 문서를 확인해 보자.
사용빈도 제한
론칭 시 “하드 엔드포인트” 버킷에 해당 엔드포인트를 적용한다. 이는 초당 요청 1건, 분당 요청 30건의 사용빈도 제한을 뜻한다.
사용빈도 제한은 최대 시간 범위와 마찬가지로 향후 변경될 수 있기 때문에 사용빈도 제한 초과 에러 처리 과정을 구축하는 것을 권한다. “사용빈도 제한 에러 응답” 섹션을 참고하자.
코칭 데이터 가져오기
요청 기간 내 (최대 90일) 생성 혹은 진행되었던 코칭 세션 및 관련 데이터(코칭 포인트, 할 일 목록 등)를 내보내 보자.
요청 헤더
API 토큰 키(apiToken key) 아래 요청 헤더에 API 토큰을 포함할 수 있다.
요청 본문 (JSON)
{
startDate: "2021-12-01", // the date to start the export, formatted [year]-[month]-[day]
endDate: "2022-01-25", // the end date for the export, must be within 90 days of the start date
timeAxis: "meetingDate" // which date to use when filtering; meetingDate or createdAt
}
성공적 응답
Status 200 OK
[ { // basic coaching session data _id: string, coachingFormName: string,
coachingTemplateId: string, coachingTemplateName: string, meetingFormat: string,
formCreatorId: string, formCreatorName: string,
coachName: string, coachId: string,
agentId: string, agentName: string,
// Lifecycle Summary createdAt: Date, updatedAt: Date, sharedWithAgent: boolean, meetingDate: Date, agentConfirmed: boolean, coachConfirmed: boolean, coachNotes: string, agentNotes: string, isDeleted: boolean
// Lifecycle Details activityLog: [ { userId: string, userEmail: string, actionType: string, descriptions: string[], timestamp: Date, ipAddress: string, }, ... ],
// Associated Coaching Points coachingPoints: [ { _id: string, coachingFormIds: string[], type: string, //strength, opportunity or n/a classification: string, // general, qa, csat or productivity
ticketId: string, subject: string,
rubricName: string, // if the coaching point concerns a specific grading rubric... criteriaName: string, // and criteria kpiName: string, // or is tied to a kpi, such as average handle time score: string, // the score for the associated grading rubric, criteria, kpi or csat
agentNotes: string, coachNotes: string,
// Lifecycle Summary createdAt: Date, updatedAt: Date, isDeleted: boolean }, ... ],
// Associated To-Dos todos: [ { _id: string, actionString: string, coachingFormIds: string[], completedAt: Date, createdAt: Date, creatorId: string, creatorName: string, description: string, link: string, status: string, title: string, type: string, updatedAt: Date, isDeleted: boolean }, ... ], }, ... ]
|
에러 응답
Status 400 ERROR
{ error: "[error message]", } |
사용빈도 제한 에러 응답
Status 429 ERROR
{ error: "Too many requests in the past [second/minute].", } |