latestOpenAPI 3.0.32026-08-12367267.0 KB
cda4b2b11372
Session statistical summery
This endpoint retrieves a statistical summary of a session, providing key metrics and insights.
Parameters:
- companyKey (string, required) - The company's secret key.
- sessionId (string, required) - The unique identifier of the session.
post/get-session-statistical-summary
Request body
Example request
{
"companyKey": "your-company-secret-key",
"sessionId": "example-session-id-12345"
}Response
Success
Example response
{
"result": {
"sessionStartDate": "2021-11-07T13:31:45.140Z",
"sessionTimeSpan": 30000,
"scanDocumentStartTime": "2021-11-07T13:31:45.140Z",
"scanDocumentEndTime": "2021-11-07T13:31:45.140Z",
"scanDocumentAttempts": 2,
"scanDocumentFailReason": null,
"livenessStartTime": "2021-11-07T13:31:45.140Z",
"livenessEndTime": "2021-11-07T13:31:45.140Z",
"livenessFailReasons": null,
"sessionTerminationStep": null,
"sessionTerminationReasons": null
}
}