Skip to main content

​
Endpoint

POST /v1/analyses/{profileId}/analyze

​
Request

curl -X POST "http://client-omni-api.argosidentity.com/v1/analyses/{profileId}/analyze" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "targetItems": [
      { "itemId": "item_abc123" },
      { "itemId": "item_def456" }
    ]
  }'

​
Request Body

​
targetItems
array
required
Array of items to include in the analysis. Must contain at least one item.
​
targetItems[].itemId
string
required
Item ID to include in the analysis (item_ prefix). The item must belong to the specified profile and be in ACTIVE status.

​
Response (202 Accepted)

{
  "id": "analysis_xyz789"
}
​
id
string
required
Unique analysis ID (analysis_ prefix). Use this ID with GET /analyses/:analysisId to check analysis status and retrieve results.

​
Important Notes

Analysis runs asynchronously. The endpoint returns immediately with an analysis ID. Use GET /v1/analyses/:analysisId to poll for status and retrieve results once completed.
A maximum of 5 analyses are retained per profile. When this limit is exceeded, the oldest analysis is automatically deleted to make room for the new one.
  • All target items must be in ACTIVE status. Items in other statuses will be rejected.
  • Only one analysis can run at a time per profile. Attempting to start a second analysis while one is in progress will return a 409 error.

​
Error Codes

StatusCodeDescription
400INVALID_ITEM_IDSOne or more items do not exist or do not belong to the specified profile
404PROFILE_NOT_FOUNDThe specified profile was not found
409ANALYSIS_IN_PROGRESSAn analysis is already running for this profile