Freshchat의 Extract API로 중요한 이벤트 추적하기

Extract API를 사용하여 Freshchat에서 더 많은 것을 얻을 수 있습니다. 기본 제공되는 제품 내 보고서 외에도 Freshchat Extract API를 사용하여 다양한 주요 지표와 지원 서비스 수준 협약(SLA)에 대한 맞춤형 원시 보고서를 몇 분 안에 다운로드할 수 있습니다.

원시 보고서의 종류

Extract API로 다운로드할 수 있는 12가지 다른 원시 보고서가 있습니다,

대화 생성됨
대화 상담원 배정됨
대화 그룹 배정됨
메시지 전송됨
첫 응답 시간
응답 시간
해결 시간
대화 해결 라벨
대화 해결됨
상담원 활동
상담원 Intelliassign 활동
CSAT 점수

Extract API를 사용하여 원시 보고서 다운로드하는 방법

1단계: API 엔드포인트 접근

엔드포인트 API에서 도메인 이름을 대체하십시오

https://<Domain Name>.freshchat.com/v2/reports/raw/

예를 들어,

엔드포인트가, https://mercasto.freshchat.com/v2/reports/raw/인 경우, 'Mercasto'가 도메인 이름입니다.

2단계: API 페이로드

헤더에 Bearer 토큰(API 토큰)을 전달해야 합니다.

API 토큰을 얻는 방법에 대해 알아보려면, 여기를 클릭하세요

Post 요청

Get 요청에 사용할 페이로드입니다. 예를 들어, 12:00 AM부터 11:59 PM UTC 사이에 생성된 대화를 얻으려면 페이로드는 다음과 같습니다

{

 "start": "2020-09-03T00:01:00.000Z",

 "end": "2020-09-03T23:59:00.000Z",

 "event": "Conversation-Created",

 "format": "csv"

}

페이로드에 사용할 이벤트 이름

페이로드 이벤트 이름	설명
Conversation-Created	새로운 대화 생성됨
Conversation-Agent-Assigned	상담원에게 배정된 대화
Conversation-Group-Assigned	그룹에 배정된 대화
Message-Sent	상담원이 보낸 메시지
First-Response-Time	대화의 첫 응답 시간
Response-Time	대화의 첫 응답 시간
Resolution-Time	대화의 해결 시간
Conversation-Resolution-Label	해결된 대화 라벨
Conversation-Resolved	해결된 대화
Agent-Activity	Freshchat에서의 상담원 활동
Agent-Intelliassign-Activity	Intelliassign에서의 상담원 활동
CSAT-Score	CSAT 점수

Get 요청

Get 요청을 처리하려면, 엔드포인트 API에서 작업 ID를 업데이트해야 합니다.

{

    “Id”: “dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927”,

    “link”: {

         “rel”: “extracts”,

          “Href”: “/reports/raw/dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927”

}

이 예에서, “dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927”은 작업 ID이며 엔드포인트 API는 https://mercasto.freshchat.com/v2/reports/raw/dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927

GET 요청이 처리된 후, 반환된 코드의 URL에서 보고서를 다운로드할 수 있습니다.

{

   "id": "dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927",

   "status": "COMPLETED",

   "interval": "2020-09-14 00:01:00.0 2020-09-14 23:59:00.0",

   "links": [

       {

           "link": {

               "rel": "extraction",

               "href": "https://csat-reports.s3-us-east-2.amazonaws.com/extraction/52a6f9sfd9sdf553d2c8bkjhkh896b5b1203afd250f6cb3LiKQkphA09ML%2F3gfsFOusBsdfdsg%fdhgfd&dgdfg2%2BvqB64CkVv2gQMzOxjSsmEqTI%2ByMS1T0UW3G8cOKmesDhaCredential=ASIA2RGYHGREDSFSDFUCOUYXCCZ24%2F20200915%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=2234e3f85d10c2d3ec434b5a97d5j8d83f6df4gf6b9f9f03d372e7026b9e3d699026abe0694730c0dd4"

           },

           "from": "2020-09-14T00:01:00.000Z",

           "to": "2020-09-14T23:59:00.000Z",

           "status": "COMPLETED"

       }

   ]

}

중요한 점:

원시 보고서는 CSV 형식으로만 다운로드할 수 있습니다.
페이로드에 사용되는 시간대는 UTC여야 합니다.
보고서 생성에는 최대 1시간이 걸릴 수 있습니다.
1분당 하나의 POST 요청만 처리할 수 있습니다.

API 추출