Raw Data API v2 - Kore.ai Docs

Back to API List An updated version of the Raw Data API that provides additional conversation data for deeper insights into Agent AI interactions and conversation flows.

API Details

Field	Value
Method	`GET`, `POST` — Use GET for complete data; POST for filtered data.
Endpoint	`https://{{host}}/agentassist/api/v1/public/{{streamid}}/v2/agentassistinteractions?from=YYYY-MM-DD-HH24:mm:SS&to=YYYY-MM-DD-HH24:mm:SS&offset=NNNNN&limit=0..100`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` — See How to generate the JWT Token
API Scope	`AgentAssist Analytics` — See Associate API Scopes

Query Parameters

Parameter	Required	Description
`from`	Yes	Start date and time of the interactions in `YYYY-MM-DD HH24:mm:SS` format.
`to`	Yes	End date and time of the interactions in `YYYY-MM-DD HH24:mm:SS` format.
`includeAgenticData=true`	No	Include this flag to retrieve `agenticActivities` data.

Header Parameters

Parameter	Required	Description
`accountId`	Yes	The account ID associated with the API request.
`auth`	Yes	Authentication token in the format `Bearer <token>`.

Sample Request

curl --location --max-time 15 --request GET \
'https://{{host}}/agentassist/api/v1/public/st-eef6ef35-35e5-52d7-99d6-1e8ab7fxxxxxxx/v2/agentassistinteractions?from=2026-02-25&to=2026-02-25&includeAgenticData=true' \
--header 'accountId: 664b33a620bd0892exxxxxxx' \
--header 'auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'Content-Type: application/json' \
--data '{
    "sessionIds": ["685bc2a0b74c8d12bxxxxxxx"]
}'

Request Body Parameters

Parameter	Required	Description
`sessionIds`	No	Array of session IDs to filter specific AI Agent sessions.

Sample Response

{
    "numResults": 3,
    "hasMore": false,
    "data": [
        {
            "conversationID": "conv-XXXXXXX",
            "botSessionID": "session-XXXXXXX",
            "channel": "chat",
            "segmentID": "ac-11111111-2222-3333-4444-555555555555",
            "agent": {
                "firstName": "REDACTED",
                "lastName": "REDACTED",
                "email": "redacted@example.com",
                "name": "REDACTED AGENT",
                "agentId": "agent-XXXX"
            },
            "tags": [
                {
                    "type": "message",
                    "name": "intent",
                    "value": "refund_request",
                    "messageID": "ms-aaaa1111-bbbb-2222-cccc-333333333333",
                    "createdAt": "2026-02-25T09:33:25.937Z"
                }
            ],
            "segmentStartTime": "2026-02-25T09:33:10.120Z",
            "segmentEndTime": "2026-02-25T09:36:02.880Z",
            "agentActions": [
                {
                    "actionType": "SearchBarEntry",
                    "action": {
                        "searchPhrase": "[REDACTED_QUERY]",
                        "typingStartTime": "2026-02-25T09:33:30.120Z",
                        "executionStartTime": "2026-02-25T09:33:30.500Z",
                        "displayTime": "2026-02-25T09:33:32.000Z",
                        "suggestionsShown": ["Suggestion 1", "Suggestion 2"],
                        "suggestionUsed": 1,
                        "phraseInput": "[REDACTED_INPUT]",
                        "correctionsPresented": 2,
                        "correctionsAccepted": 1,
                        "countDisplayedAnswers": {
                            "countDialogTasks": 1,
                            "countFaqs": 0,
                            "countAnswers": 1,
                            "countFiles": 0,
                            "countWebPages": 0,
                            "countFromNonNativeDataSource": 0
                        },
                        "suggestions": {
                            "dialogs": [{ "name": "Cancel Account" }],
                            "answers": [
                                {
                                    "content": "[REDACTED_GENERATED_ANSWER]",
                                    "positionId": "dg-1234567890",
                                    "sources": [
                                        {
                                            "title": "Refund Policy",
                                            "url": "https://example.com/refund"
                                        }
                                    ],
                                    "internalFlag": false
                                }
                            ]
                        }
                    },
                    "used": [
                        {
                            "targetType": "Answer",
                            "target": {
                                "answer": {
                                    "status": "Sent",
                                    "usedTime": "2026-02-25T09:33:40.000Z",
                                    "showMoreClicked": false,
                                    "answerLinkClicked": [],
                                    "positionId": "dg-1234567890",
                                    "feedback": {
                                        "response": "up",
                                        "reasonCode": ["Correct Intent"],
                                        "comment": "[REDACTED]"
                                    }
                                }
                            }
                        }
                    ]
                }
            ],
            "proActiveSuggestions": [
                {
                    "utterance": "[REDACTED_CUSTOMER_UTTERANCE]",
                    "suggestions": { "dialogs": [], "answers": [] },
                    "displayTime": "2026-02-25T09:33:20.000Z",
                    "countDisplayedAnswers": {
                        "countDialogTasks": 0,
                        "countFaqs": 0,
                        "countAnswers": 1,
                        "countFiles": 0,
                        "countWebPages": 0,
                        "countFromNonNativeDataSource": 0
                    },
                    "used": []
                }
            ],
            "queueInfo": { "queueId": "qu-XXXX", "queueName": "SupportQueue" },
            "countScrollUp": 2,
            "countScrollDn": 3,
            "isWelcomeMsgRead": true,
            "linksClicked": [
                { "url": "https://example.com/help", "timestamp": "2026-02-25T09:34:00.000Z" }
            ],
            "playbookRuntimeData": [
                {
                    "_id": "playbookRuntime-XXXX",
                    "playbookId": "acl-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "type": "primary",
                    "triggerType": "auto",
                    "language": "en",
                    "order": "sequential",
                    "openedAt": "2026-02-25T09:33:15.221Z",
                    "closedAt": "2026-02-25T09:34:03.254Z",
                    "adheredSteps": 5,
                    "adherenceRate": 100,
                    "stages": [],
                    "totalStages": { "stage-1": 3 }
                }
            ],
            "coachingRuntimeData": [
                {
                    "_id": "coachingRuntime-XXXX",
                    "ruleId": "acr-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "ruleName": "Greeting Compliance",
                    "messageId": "ms-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "triggeredAt": "2026-02-25T09:33:25.430Z",
                    "actionType": "nudge",
                    "actionId": "action-XXXX",
                    "expression": "positive",
                    "message": { "title": "Use Standard Greeting", "body": "[REDACTED]" },
                    "emails": [],
                    "adherence": { "criteria": "Greeting template used" },
                    "isAdhered": true,
                    "adheredAt": "2026-02-25T09:33:42.430Z"
                }
            ],
            "agenticActivities": [
                {
                    "utterance": "[REDACTED_CUSTOMER_UTTERANCE]",
                    "requestId": "aa-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "requestTime": "2026-02-25T09:33:20.000Z",
                    "reqStatus": "200",
                    "response": [{ "type": "suggestion", "content": "[REDACTED_RESPONSE]" }],
                    "responseTime": "2026-02-25T09:33:21.200Z",
                    "resStatus": 200,
                    "sessionInfo": { "botSessionID": "session-XXXXXXX" },
                    "participantId": "participant-XXXX",
                    "streaming": false,
                    "usageDetails": { "usedType": "send" },
                    "feedback": { "response": "up" }
                }
            ]
        }
    ]
}

Response Body Parameters

Parameter	Type	Description
`numResults`	Integer	Number of results in this response.
`hasMore`	Boolean	Indicates if more pages are available.
`data`	Array	Each object represents a conversation segment handled by one primary agent.
`data[].conversationID`	String	Unique conversation ID (from customer).
`data[].botSessionID`	String	Unique session ID (from Kore). Example: `667fc3b587b5fd0fbf97d4de`
`data[].channel`	String	Channel name. Example: `chat`
`data[].segmentID`	String	Unique segment ID prefixed with `ac-`.
`data[].agent`	Object	Primary agent servicing this segment.
`data[].agent.firstName`	String	Agent first name.
`data[].agent.lastName`	String	Agent last name.
`data[].agent.email`	String	Agent email address.
`data[].agent.name`	String	Agent full name.
`data[].agent.agentId`	String	Unique agent ID.
`data[].tags`	Array	Tags emitted by the AI Agent during this segment.
`data[].tags[].type`	String	Tag type: `user`, `message`, or `session`.
`data[].tags[].name`	String	Tag key defined by the AI Agent developer.
`data[].tags[].value`	String	Tag value.
`data[].tags[].messageID`	String	Message ID prefixed with `ms-`.
`data[].tags[].createdAt`	String (UTC)	Timestamp when the tag was emitted.
`data[].segmentStartTime`	String (UTC)	Segment start time.
`data[].segmentEndTime`	String (UTC)	Segment end time.
`data[].agentActions`	Array	Agent actions (search or dialog task execution).
`data[].agentActions[].actionType`	String	Action type. Example: `SearchBarEntry`, `LibrarySelection`
`data[].agentActions[].action`	Object	Details of the search attempt (for `SearchBarEntry` type).
`data[].agentActions[].used`	Array	Objects used (`Sent`, `Copied`, `Executed`, `Feedback`, `Clicked`).
`data[].agentActions[].used[].targetType`	String	Type of used object. Example: `DialogTask`, `FAQ`, `Answer`, `File`, `WebPage`
`data[].agentActions[].used[].target`	Object	Details of the dialog task or data source used.
`data[].proActiveSuggestions`	Array	Suggestions proactively shown by Agent AI.
`data[].proActiveSuggestions[].utterance`	String	Customer utterance that triggered suggestions.
`data[].proActiveSuggestions[].displayTime`	String (UTC)	Time suggestions were displayed.
`data[].proActiveSuggestions[].countDisplayedAnswers`	Object	Count of suggestions displayed by type (dialogs, FAQs, answers, files, web pages, non-native).
`data[].proActiveSuggestions[].used`	Array	Suggestions used by the agent.
`data[].playbookRuntimeData`	Array	Playbook runtime execution data.
`data[].playbookRuntimeData[].playbookId`	String	Playbook ID.
`data[].playbookRuntimeData[].type`	String	Playbook type. Example: `primary`
`data[].playbookRuntimeData[].triggerType`	String	Trigger source. Example: `auto`
`data[].playbookRuntimeData[].openedAt`	String (UTC)	Playbook start time.
`data[].playbookRuntimeData[].closedAt`	String (UTC)	Playbook end time.
`data[].playbookRuntimeData[].adheredSteps`	Integer	Number of steps adhered to.
`data[].playbookRuntimeData[].adherenceRate`	Number	Overall adherence rate as a percentage.
`data[].coachingRuntimeData`	Array	Coaching rule execution details.
`data[].coachingRuntimeData[].ruleId`	String	Coaching rule ID.
`data[].coachingRuntimeData[].ruleName`	String	Coaching rule name.
`data[].coachingRuntimeData[].triggeredAt`	String (UTC)	Time rule was triggered.
`data[].coachingRuntimeData[].actionType`	String	Coaching action type. Example: `nudge`, `hint`
`data[].coachingRuntimeData[].isAdhered`	Boolean	Whether the agent adhered to the coaching action.
`data[].agenticActivities`	Array	Agent AI request/response activity details. Returned when `includeAgenticData=true`.
`data[].agenticActivities[].utterance`	String	User utterance sent to Agent AI.
`data[].agenticActivities[].requestId`	String	Unique request ID.
`data[].agenticActivities[].reqStatus`	String	HTTP request status. Example: `200`
`data[].agenticActivities[].responseTime`	String (UTC)	Time response was received.
`data[].agenticActivities[].resStatus`	Integer	HTTP response status code.
`data[].agenticActivities[].streaming`	Boolean	Indicates if streaming was enabled.
`queueInfo.queueId`	String	Queue ID.
`queueInfo.queueName`	String	Queue name.
`countScrollUp`	Integer	Number of scroll-up clicks by the agent.
`countScrollDn`	Integer	Number of scroll-down clicks by the agent.
`isWelcomeMsgRead`	Boolean	Indicates if the Welcome Message was read.
`linksClicked`	Array	URLs clicked by the agent with timestamps.

​API Details

​Query Parameters

​Header Parameters

​Sample Request

​Request Body Parameters

​Sample Response

​Response Body Parameters

API Details

Query Parameters

Header Parameters

Sample Request

Request Body Parameters

Sample Response

Response Body Parameters