Skip to main content

​
Endpoint

GET /v1/analyses/{profileId}/analyses

​
Request

curl -X GET "http://client-omni-api.argosidentity.com/v1/analyses/{profileId}/analyses?status=completed&sort=createdAt&order=desc&limit=20" \
  -H "x-api-key: your-api-key-here"

​
Query Parameters

ParameterTypeRequiredDefaultDescription
statusstringFilter by analysis status: pending, processing, completed, failed
sortstringcreatedAtSort field: createdAt, completedAt, requestedAt
orderstringdescSort order: asc, desc
cursorstringPagination cursor returned from a previous response
limitnumber20Number of results per page (max 50)

​
Response (200 OK)

{
  "count": 3,
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI1LTA1LTAxVDEyOjAwOjAwWiJ9",
  "items": [
    {
      "id": "analysis_abc123",
      "profileId": "profile_xyz789",
      "folderId": null,
      "engineId": null,
      "status": "completed",
      "verificationStatus": "approved",
      "riskAssessment": {
        "riskLevel": "low",
        "riskScore": 12
      },
      "processingTimeMs": 4523,
      "error": null,
      "requestedAt": "2025-05-01T12:00:00Z",
      "completedAt": "2025-05-01T12:00:04Z",
      "createdAt": "2025-05-01T12:00:00Z"
    }
  ]
}

​
Response Fields

​
count
number
required
Total number of items in the current response page
​
nextCursor
string | null
required
Cursor for the next page. Pass this as the cursor query parameter to fetch the next page. null when there are no more results.
​
items
array
required
Array of analysis summary objects

​
Item Fields

​
id
string
required
Unique analysis ID (analysis_ prefix)
​
profileId
string
required
Profile ID this analysis belongs to
​
folderId
string | null
required
Target folder ID (null for full-profile analysis)
​
engineId
string | null
required
Engine ID used (null when using default engine)
​
status
string
required
Analysis status: pending / processing / completed / failed
​
verificationStatus
string
required
Final verification status: pending_review / approved / rejected
​
riskAssessment
object
required
Risk assessment summary
​
riskAssessment.riskLevel
string
required
Risk level: low / medium / high
​
riskAssessment.riskScore
number
required
Risk score (0–100, higher = riskier)
​
processingTimeMs
number
required
Processing time in milliseconds
​
error
string | null
required
Error message (null on success)
​
requestedAt
string
required
Analysis request time (ISO 8601)
​
completedAt
string | null
required
Analysis completion time (ISO 8601, null if not completed)
​
createdAt
string
required
Record creation time (ISO 8601)

​
Pagination

This endpoint uses cursor-based pagination. To retrieve all results:
  1. Make the initial request without a cursor parameter.
  2. If the response includes a non-null nextCursor, pass it as the cursor query parameter in the next request.
  3. Repeat until nextCursor is null.
The list endpoint returns summary objects. To retrieve full analysis details including extracted data, findings, and audit logs, use GET /analyses/:analysisId.

​
Error Codes

StatusCodeDescription
404PROFILE_NOT_FOUNDThe specified profile was not found