Analysis
Path parameters
strTokenstringRequired
The login token
strMemoriIDstringRequired
The ID of the Memori object
Body
querystring | nullableOptional
Query to be matched with User objects in the analysis. Required.
thresholdnumber · float | nullableOptional
Threshold between 0.0 and 1.0. User objects whose match level is below this threshold will be discarded. If null, all User objects will be returned.
Responses
200
Success
application/json
post
POST /api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"query": "text",
"threshold": 1
}
200
Success
{
"status": {
"analysisType": "text",
"query": "text",
"analysisWarningsCount": 1,
"analysisWarnings": [
{
"warningType": "text",
"text": "text"
}
],
"processID": "text",
"memoriID": "text",
"processUserName": "text",
"processType": "text",
"status": "text",
"error": "text",
"totalElements": 1,
"processedElements": 1,
"progress": 1,
"processSpecsJSON": "text",
"begin": "2025-07-23T11:34:57.675Z",
"end": "2025-07-23T11:34:57.675Z",
"eta": 1,
"creationTimestamp": "2025-07-23T11:34:57.675Z",
"lastChangeTimestamp": "2025-07-23T11:34:57.675Z"
},
"requestID": 1,
"requestDateTime": "2025-07-23T11:34:57.675Z",
"resultCode": 1,
"resultMessage": "text"
}
Path parameters
strTokenstringRequired
The login token
strAnalysisIDstringRequired
The Analysis process ID
frominteger · int32Required
The 0-based index of the first Match object to list
howManyinteger · int32Required
The number of the Match objects to list
thresholdnumber · floatOptional
Optional threshold between 0.0 and 1.0: Match objects below the threshold are excluded from the list
Responses
200
Success
application/json
get
GET /api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold} HTTP/1.1
Host:
Accept: */*
200
Success
{
"count": 1,
"matches": [
{
"userQueryMatchID": "text",
"analysisID": "text",
"memoriID": "text",
"engineUserID": "text",
"userName": "text",
"tenantName": "text",
"userEmail": "text",
"match": 1
}
],
"requestID": 1,
"requestDateTime": "2025-07-23T11:34:57.675Z",
"resultCode": 1,
"resultMessage": "text"
}