Insights API (1.0.0)

Download OpenAPI specification:Download

The Insights API has end points that retrieves interaction data that enables you to monitor and track the performance of your Digital Person project.

Query Daily Logs

Returns Daily Log Sessions Events data

Query daily session event logs. You may filter the data for a specific session or project.

Authorizations:

ApiKeyAuth

query Parameters

logdate required	string The date for which the daily events are being polled. Date entries logged YYYY-MM-DD
session	string Limit results to specific session id
projectId	string Limit results to sessions with the specific projectId
exclude	string Comma-separated string containing properties to be excluded (only supports excluding 'events' currently)

Responses

Response samples

200

Content type

application/json

[{"organizationId": 123,
"session": "XXX-YYY-QQQ",
"timestamp": "2020-12-12T00:20:01.781Z",
"durationMillis": 15290,
"turnCount": 15,
"projectId": 123,
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36",
"configId": 12345,
"valence": -0.140079,
"videoOutAverageBitrate": 1701290.735525587,
"videoInAverageBitrate": 1701290.735525587,
"audioOutAverageBitrate": 1701290.735525587,
"audioInAverageBitrate": 1701290.735525587,
"events": [{"organizationId": 123,
"projectId": 123,
"eventType": "SessionStart",
"session": "XXX-YYY-QQQ",
"time": 1591027736010041,
"timestamp": "2020-12-12T00:20:01.781Z",
"configId": 12345,
"confusion": 0.0589,
"emotionalConfidence": 0.0589,
"negativity": 0.0589,
"positivity": 0.0589,
"speechState": "speaking",
"turn": "persona",
"userIsAttentive": 0.1804,
"userIsTalking": 0.1804,
"valence": 0.1804,
"FacePresent": 1,
"PersonaTurn_IsAttentive": 0.1804,
"PersonaTurn_IsTalking": 0.1804,
"Persona_Turn_Negativity": 0.1804,
"Persona_Turn_Positivity": 0.1804,
"Persona_Turn_Confusion": 0.1804,
"currentSpeechContext": {"id": "Greeting.TalkedToDHBefore",
"intent": "Chat_Greeting",
"tag": "TalkedToDHBefore",
"type": "Entry"
},
"analyticsMeCXV1": 0.1804,
"faceEmotionJoy": 0.1804,
"faceEmotionSad": 0.1804,
"faceEmotionFear": 0.1804,
"faceEmotionAnger": 0.1804,
"faceEmotionSurprise": 0.1804,
"faceEmotionDisgust": 0.1804,
"faceEmotionConfusion": 0.1804,
"faceEmotionExcitement": 0.1804,
"faceEmotionContempt": 0.1804,
"textEmotionJoy": 0.1804,
"textEmotionConcern": 0.1804,
"textEmotionSad": 0.1804,
"textEmotionAnger": 0.1804,
"textEmotionFear": 0.1804,
"textEmotionDisgust": 0.1804,
"textEmotionInterest": 0.1804,
"textEmotionSurprise": 0.1804,
"textEmotionCare": 0.1804,
"textEmotionDistress": 0.1804,
"textEmotionShame": 0.1804,
"textEmotionExcitement": 0.1804,
"textEmotionContempt": 0.1804,
"textEmotionRevelation": 0.1804,
"textEmotionSarcasm": 0.1804,
"textEmotionNeutral": 0.1804,
"UserTurn_IsAttentive": 0.1804,
"UserTurn_IsTalking": 0.1804,
"User_Turn_Negativity": 0.1804,
"User_Turn_Positivity": 0.1804,
"User_Turn_Confusion": 0.1804
}
]
}
]

Returns Daily Log Sessions Events data with pagination

Query daily session event logs. You may filter the data for a specific session or project and paginate results

Authorizations:

ApiKeyAuth

query Parameters

logdate required	string The date for which the daily events are being polled. Date entries logged YYYY-MM-DD
session	string Limit results to specific session id
projectId	string Limit results to sessions with the specific projectId
exclude	string Comma-separated string containing properties to be excluded (only supports excluding 'events' currently)
page	number Default: 1 Page number to retrieve, defaults to 1
limit	number Default: 100 Limit number of results per page, defaults to 100

Responses

Response samples

200

Content type

application/json

{"combinedList": [{"organizationId": 123,
"session": "XXX-YYY-QQQ",
"timestamp": "2020-12-12T00:20:01.781Z",
"durationMillis": 15290,
"turnCount": 15,
"projectId": 123,
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36",
"configId": 12345,
"valence": -0.140079,
"videoOutAverageBitrate": 1701290.735525587,
"videoInAverageBitrate": 1701290.735525587,
"audioOutAverageBitrate": 1701290.735525587,
"audioInAverageBitrate": 1701290.735525587,
"events": [{"organizationId": 123,
"projectId": 123,
"eventType": "SessionStart",
"session": "XXX-YYY-QQQ",
"time": 1591027736010041,
"timestamp": "2020-12-12T00:20:01.781Z",
"configId": 12345,
"confusion": 0.0589,
"emotionalConfidence": 0.0589,
"negativity": 0.0589,
"positivity": 0.0589,
"speechState": "speaking",
"turn": "persona",
"userIsAttentive": 0.1804,
"userIsTalking": 0.1804,
"valence": 0.1804,
"FacePresent": 1,
"PersonaTurn_IsAttentive": 0.1804,
"PersonaTurn_IsTalking": 0.1804,
"Persona_Turn_Negativity": 0.1804,
"Persona_Turn_Positivity": 0.1804,
"Persona_Turn_Confusion": 0.1804,
"currentSpeechContext": {"id": "Greeting.TalkedToDHBefore",
"intent": "Chat_Greeting",
"tag": "TalkedToDHBefore",
"type": "Entry"
},
"analyticsMeCXV1": 0.1804,
"faceEmotionJoy": 0.1804,
"faceEmotionSad": 0.1804,
"faceEmotionFear": 0.1804,
"faceEmotionAnger": 0.1804,
"faceEmotionSurprise": 0.1804,
"faceEmotionDisgust": 0.1804,
"faceEmotionConfusion": 0.1804,
"faceEmotionExcitement": 0.1804,
"faceEmotionContempt": 0.1804,
"textEmotionJoy": 0.1804,
"textEmotionConcern": 0.1804,
"textEmotionSad": 0.1804,
"textEmotionAnger": 0.1804,
"textEmotionFear": 0.1804,
"textEmotionDisgust": 0.1804,
"textEmotionInterest": 0.1804,
"textEmotionSurprise": 0.1804,
"textEmotionCare": 0.1804,
"textEmotionDistress": 0.1804,
"textEmotionShame": 0.1804,
"textEmotionExcitement": 0.1804,
"textEmotionContempt": 0.1804,
"textEmotionRevelation": 0.1804,
"textEmotionSarcasm": 0.1804,
"textEmotionNeutral": 0.1804,
"UserTurn_IsAttentive": 0.1804,
"UserTurn_IsTalking": 0.1804,
"User_Turn_Negativity": 0.1804,
"User_Turn_Positivity": 0.1804,
"User_Turn_Confusion": 0.1804
}
]
}
],
"meta": {"totalPages": 0,
"totalSessions": 0,
"currentPage": 0,
"nextPage": 0,
"limitPerPage": 0
}
}

Events Summary

Returns Org Events Summary Report

calculates analytics report for the given Org Start Date and End Date

Authorizations:

ApiKeyAuth

query Parameters

projectId	number Project ID to retrieve from
startdate required	string Start Date YYYY-MM-DD
enddate	string End Date YYYY-MM-DD

Responses

Response samples

200

Content type

application/json

{"fromDate": "2020-05-01",
"toDate": "2022-05-01",
"totalConversation": 123,
"totalConversationTimeInMs": 5123.12,
"averageDurationInMs": 123.12,
"averageTurns": 5,
"lastConversationDate": "2020-06-01T16:48:11.934Z",
"lastConfigId": 1001,
"organizationId": 1,
"projects": [{"fromDate": "2020-05-01",
"toDate": "2022-05-01",
"totalConversation": 123,
"totalConversationTimeInMs": 5123.12,
"averageDurationInMs": 123.12,
"averageTurns": 5,
"lastConversationDate": "2020-06-01T16:48:11.934Z",
"lastConfigId": 1001,
"projectId": 1
}
]
}

Conversation Nodes Summary

Returns conversation nodes summary for the user's org.

calculates conversation nodes summary for the user's org based on start date and optional queries such as end date, session and project Id.

Authorizations:

ApiKeyAuth

query Parameters

projectId required	number Limit results to sessions with the given projectId
startdate required	string Start Date YYYY-MM-DD
enddate	string End Date YYYY-MM-DD
session	string Limit results to specific session id
format	string (ConversationNodesSummaryFormats) Enum: "full" "graph" Format of response data to be returned
focusedName	string Example: focusedName=Greeting.TalkedToDHBefore.Chat_Greeting Return a specific node data based on the node's 'Name' property.

Responses

Response samples

200

Content type

application/json

[{"sessionId": "XXX-YYY-QQQ",
"startDate": "2020-01-01",
"endDate": "2021-01-01",
"organizationId": "1",
"conversationNodes": [{"id": "Greeting.TalkedToDHBefore",
"intent": "Chat_Greeting",
"tag": "TalkedToDHBefore",
"type": "Entry",
"name": "Greeting.TalkedToDHBefore.Chat_Greeting",
"category": "Greeting",
"innerCategory": "TalkedToDHBefore",
"timestamp": "2020-12-12T00:20:01.781Z",
"currentSpeechContext": "{\"id\":\"Greeting.TalkedToDHBefore\",\"intent\":\"Chat_Greeting\",\"tag\":\"TalkedToDHBefore\",\"type\":\"Entry\"}",
"hits": 15,
"eqData": {"analyticsMeCXV1": 0.1804,
"faceEmotionJoy": 0.1804,
"faceEmotionSad": 0.1804,
"faceEmotionFear": 0.1804,
"faceEmotionAnger": 0.1804,
"faceEmotionSurprise": 0.1804,
"faceEmotionDisgust": 0.1804,
"faceEmotionConfusion": 0.1804,
"faceEmotionExcitement": 0.1804,
"faceEmotionContempt": 0.1804,
"textEmotionJoy": 0.1804,
"textEmotionConcern": 0.1804,
"textEmotionSad": 0.1804,
"textEmotionAnger": 0.1804,
"textEmotionFear": 0.1804,
"textEmotionDisgust": 0.1804,
"textEmotionInterest": 0.1804,
"textEmotionSurprise": 0.1804,
"textEmotionCare": 0.1804,
"textEmotionDistress": 0.1804,
"textEmotionShame": 0.1804,
"textEmotionExcitement": 0.1804,
"textEmotionContempt": 0.1804,
"textEmotionRevelation": 0.1804,
"textEmotionSarcasm": 0.1804,
"textEmotionNeutral": 0.1804,
"UserTurn_IsAttentive": 0.1804,
"UserTurn_IsTalking": 0.1804,
"User_Turn_Negativity": 0.1804,
"User_Turn_Positivity": 0.1804,
"User_Turn_Confusion": 0.1804
},
"prevNodes": [{"id": "Greeting.TalkedToDHBefore",
"intent": "Chat_Greeting",
"tag": "TalkedToDHBefore",
"type": "Entry",
"name": "Greeting.TalkedToDHBefore.Chat_Greeting",
"category": "Greeting",
"innerCategory": "TalkedToDHBefore",
"currentSpeechContext": "{\"id\":\"Greeting.TalkedToDHBefore\",\"intent\":\"Chat_Greeting\",\"tag\":\"TalkedToDHBefore\",\"type\":\"Entry\"}",
"pairHits": 15,
"eqData": {"analyticsMeCXV1": 0.1804,
"faceEmotionJoy": 0.1804,
"faceEmotionSad": 0.1804,
"faceEmotionFear": 0.1804,
"faceEmotionAnger": 0.1804,
"faceEmotionSurprise": 0.1804,
"faceEmotionDisgust": 0.1804,
"faceEmotionConfusion": 0.1804,
"faceEmotionExcitement": 0.1804,
"faceEmotionContempt": 0.1804,
"textEmotionJoy": 0.1804,
"textEmotionConcern": 0.1804,
"textEmotionSad": 0.1804,
"textEmotionAnger": 0.1804,
"textEmotionFear": 0.1804,
"textEmotionDisgust": 0.1804,
"textEmotionInterest": 0.1804,
"textEmotionSurprise": 0.1804,
"textEmotionCare": 0.1804,
"textEmotionDistress": 0.1804,
"textEmotionShame": 0.1804,
"textEmotionExcitement": 0.1804,
"textEmotionContempt": 0.1804,
"textEmotionRevelation": 0.1804,
"textEmotionSarcasm": 0.1804,
"textEmotionNeutral": 0.1804,
"UserTurn_IsAttentive": 0.1804,
"UserTurn_IsTalking": 0.1804,
"User_Turn_Negativity": 0.1804,
"User_Turn_Positivity": 0.1804,
"User_Turn_Confusion": 0.1804
}
}
],
"nextNodes": [{"id": "Greeting.TalkedToDHBefore",
"intent": "Chat_Greeting",
"tag": "TalkedToDHBefore",
"type": "Entry",
"name": "Greeting.TalkedToDHBefore.Chat_Greeting",
"category": "Greeting",
"innerCategory": "TalkedToDHBefore",
"currentSpeechContext": "{\"id\":\"Greeting.TalkedToDHBefore\",\"intent\":\"Chat_Greeting\",\"tag\":\"TalkedToDHBefore\",\"type\":\"Entry\"}",
"pairHits": 15,
"eqData": {"analyticsMeCXV1": 0.1804,
"faceEmotionJoy": 0.1804,
"faceEmotionSad": 0.1804,
"faceEmotionFear": 0.1804,
"faceEmotionAnger": 0.1804,
"faceEmotionSurprise": 0.1804,
"faceEmotionDisgust": 0.1804,
"faceEmotionConfusion": 0.1804,
"faceEmotionExcitement": 0.1804,
"faceEmotionContempt": 0.1804,
"textEmotionJoy": 0.1804,
"textEmotionConcern": 0.1804,
"textEmotionSad": 0.1804,
"textEmotionAnger": 0.1804,
"textEmotionFear": 0.1804,
"textEmotionDisgust": 0.1804,
"textEmotionInterest": 0.1804,
"textEmotionSurprise": 0.1804,
"textEmotionCare": 0.1804,
"textEmotionDistress": 0.1804,
"textEmotionShame": 0.1804,
"textEmotionExcitement": 0.1804,
"textEmotionContempt": 0.1804,
"textEmotionRevelation": 0.1804,
"textEmotionSarcasm": 0.1804,
"textEmotionNeutral": 0.1804,
"UserTurn_IsAttentive": 0.1804,
"UserTurn_IsTalking": 0.1804,
"User_Turn_Negativity": 0.1804,
"User_Turn_Positivity": 0.1804,
"User_Turn_Confusion": 0.1804
}
}
]
}
]
}
]

API Token

Returns Analytics User API Token.

Retrieve an API token based on user/pass

Authorizations:

basicAuth

Responses

Response samples

200

Content type

application/json

{"accessToken": "yeABCDEF...",
"expiresIn": 300,
"tokenType": "Bearer"
}