분석 API 가져오기

API를 사용하여 의도 감지 및 작업 성능과 관련된 메트릭 데이터를 추출합니다. 찾은 의도와 관련된 메트릭 정보, 의도를 찾을 수 없음, 실패한 작업, 성공한 작업 및 성능 로그를 검색하는 데 사용할 수 있습니다

이 API를 사용하려면 앱은 메트릭의 봇 범위가 필요합니다.

POST https://{{host}}/api/public/bot/{{BotID}}/getAnalytics

경로 매개 변수

매개 변수	필수/선택 사항	설명
host	필수	환경 URL(예: https://bots.kore.ai)
BotID	필수	봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.

본문 매개 변수

매개 변수	필수/선택 사항	설명
type	필수	요청된 메트릭 유형은 다음과 같을 수 있습니다. successintent failintent successtask failtask performance
filters	필수	결과 집합을 필터링하기 위해 다음 세부 정보가 있는 개체
from	필수	레코드를 고려해야 하는 시작 타임스탬프입니다.
to	필수	레코드를 고려해야 하는 종료 타임스탬프입니다.
limit	필수	가져올 레코드 수입니다.
channel	선택 사항	메트릭에 대해 고려할 채널입니다.
channelUIds	선택 사항	메트릭에 포함될 사용자 ID(채널 지정).
isAmbiguous	선택 사항	모호한 의도를 포함할지 여부 – true 또는 false 로 설정합니다
isDeveloper	선택 사항	개발자 메트릭을 포함할지 여부 – true 또는 false로 설정합니다.
trained	선택 사항	학습된 의도를 포함할지 여부 – true 또는 false로 설정합니다.
taskId	선택 사항	작업 ID를 기준으로 필터링합니다.
userId	선택 사항	사용자 ID를 기준으로 필터링합니다.
tags	선택 사항	사용자 지정 태그를 기준으로 필터링합니다. Usage: "tags": { "and": [ { "name": "user", "values": ["uservalue"], "type": "user" }, { "name": "message", "values": ["mvalue"], "type": "message" } ] }
sort	선택 사항	결과를 정렬합니다. Usage: "sort": { "order": "<desc/asc>", "by": "<column name>" }
skip	선택 사항	결과 집합에서 건너뛴 레코드의 수입니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다,

auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl -X POST \
  https://{{host}}/api/public/bot/{{bot_id}}/getAnalytics \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \
  -d '{
       "type": "successintent",
       "filters": {
           "from": "2020-08-11T17:25:09.698Z",
           "to": "2020-08-21T17:25:09.698Z",
           "tags": {
                    "and": [
                     {
                      "name": "us2",
                      "values": [
                             "ss"
                             ],
                       "type": "user"
                       }
                      ]
                 },
        "channel": [
            "rtm"
        ],
        "channelUIds": [
            "test@kore.xyz"
        ],
        "isAmbiguous": false,
        "isDeveloper": true,
        "trained": false,
        "taskId": [
            "dg-xxxx"
        ],
        "userId": [
            "u-5e4xxx85-f12e-53e2-929e-01xx7156xxx8"
        ]
    },
    "limit": 50
}'

샘플 응답

{
    "moreAvailable": true,
    "totalCount": 49,
    "result": [
        {
            "messageId": "ms-439aa365-5240-52bf-ad10-bb0ef7b0d3c2",
            "utterance": "newTask",
            "intent": "newTask",
            "userId": "u-5e4xxx85-f12e-53e2-929e-01xx7156xxx8",
            "channelUId": "test@kore.xyz",
            "language": "en",
            "timestamp": "2020-08-20T18:49:19.877Z",
            "pinned": false,
            "channel": "rtm",
            "taskName": "newTask",
            "customTags": {
                "userTags": {
                    "name": "us2",
                    "value": "ss"
                },
                "sessionTags": [],
                "messageTags": []
            },
            "NLAnalysis": {}
        },
        {
            "messageId": "ms-2cc0b4aa-2f95-5524-8b7b-2442929b3cf5",
            "utterance": "newTask",
            "intent": "newTask",
            "userId": "u-5e4xxx85-f12e-53e2-929e-01xx7156xxx8",
            "channelUId": "test@kore.xyz",
            "language": "en",
            "timestamp": "2020-08-20T18:49:14.237Z",
            "pinned": false,
            "channel": "rtm",
            "taskName": "newTask",
            "customTags": {
                "userTags": {
                    "name": "us2",
                    "value": "ss"
                },
                "sessionTags": [],
                "messageTags": []
            },
            "NLAnalysis": {}
        }
    ]
}

On this Page