Extract API

Freshchat Extract API를 사용하여 중요한 이벤트를 추적할 수 있습니다. 기본 제공되는 제품 내 보고서 외에도, 다양한 주요 지표와 지원 SLA에 대한 보고서를 몇 분 내에 사용자 정의된 원시 보고서로 다운로드할 수 있습니다.

원시 보고서의 유형

Extract API를 사용하여 다음 보고서를 다운로드할 수 있습니다.

대화 생성
대화 에이전트 할당
대화 그룹 할당
메시지 전송
첫 응답 시간
응답 시간
해결 시간
대화 해결 라벨
대화 해결됨
에이전트 활동
에이전트 Intelliassign 활동
CSAT 점수
팀 성과 보고서
상호작용 보고서

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

API 엔드포인트에 접근하기

엔드포인트 API에서 도메인 이름을 교체하십시오: https://<Domain Name>.freshchat.com/v2/reports/raw/ 예를 들어, 엔드포인트가 https://mercasto.freshchat.com/v2/reports/raw/인 경우, 'Mercasto'가 도메인 이름입니다.

API 페이로드 전달

헤더에 Bearer 토큰(API 토큰)을 전달해야 합니다. API 토큰을 얻는 방법을 알고 싶다면, 여기를 클릭하세요.

POST 요청

GET 요청에 사용할 페이로드는 다음과 같습니다. 예를 들어, UTC 기준으로 오전 12시부터 오후 11시 59분까지 생성된 대화를 얻으려면 페이로드는 다음과 같습니다:

{
  "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 점수
agent-performance	시간대별 에이전트 성과의 전체적인 뷰
classic	모든 상호작용 관련 세부사항의 포괄적인 뷰

GET 요청

GET 요청을 처리하려면 엔드포인트 API에 Job ID를 업데이트하십시오.

{
  "Id": "dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927",
  "link": {
    "rel": "extracts",
    "Href": "/reports/raw/dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927"
  }
}

이 예제에서 "dhc1e5bb-27sb-4d64-b20d-c7f6q63a7927"은 Job 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여야 합니다.
보고서가 생성되는 데 최대 한 시간이 걸릴 수 있습니다.
분당 하나의 POST 요청만 처리할 수 있습니다.

추출 API