Saltar al contenido principal

​
Endpoint

GET /v1/analyses/{profileId}/analyses

​
Solicitud

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

ParameterTypeRequiredDefaultDescripción
statusstringFiltrar por estado del análisis: pending, processing, completed, failed
sortstringcreatedAtCampo de ordenación: createdAt, completedAt, requestedAt
orderstringdescOrden: asc, desc
cursorstringCursor de paginación de la respuesta anterior
limitnumber20Número de resultados por página (máx. 50)

​
Respuesta (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"
    }
  ]
}

​
Campos de la respuesta

​
count
number
requerido
Número total de elementos en la página actual de la respuesta
​
nextCursor
string | null
requerido
Cursor para la siguiente página. Páselo como parámetro cursor en la siguiente solicitud. null cuando no hay más resultados.
​
items
array
requerido
Array de objetos resumen de análisis

​
Campos del item

​
id
string
requerido
ID único del análisis (prefijo analysis_)
​
profileId
string
requerido
ID del profile al que pertenece este análisis
​
folderId
string | null
requerido
ID del folder objetivo (null para análisis de profile completo)
​
engineId
string | null
requerido
ID del engine utilizado (null cuando se usa el engine predeterminado)
​
status
string
requerido
Estado del análisis: pending / processing / completed / failed
​
verificationStatus
string
requerido
Estado final de verificación: pending_review / approved / rejected
​
riskAssessment
object
requerido
Resumen de evaluación de riesgo
​
riskAssessment.riskLevel
string
requerido
Nivel de riesgo: low / medium / high
​
riskAssessment.riskScore
number
requerido
Puntuación de riesgo (0-100, mayor = más riesgoso)
​
processingTimeMs
number
requerido
Tiempo de procesamiento en milisegundos
​
error
string | null
requerido
Mensaje de error (null si fue exitoso)
​
requestedAt
string
requerido
Hora de solicitud del análisis (ISO 8601)
​
completedAt
string | null
requerido
Hora de finalización del análisis (ISO 8601, null si no se ha completado)
​
createdAt
string
requerido
Hora de creación del registro (ISO 8601)

​
Paginación

Este endpoint utiliza paginación basada en cursor. Para recuperar todos los resultados:
  1. Realice la solicitud inicial sin el parámetro cursor.
  2. Si la respuesta incluye un nextCursor no nulo, páselo como parámetro cursor en la siguiente solicitud.
  3. Repita hasta que nextCursor sea null.
El endpoint de lista devuelve objetos resumen. Para recuperar los detalles completos del análisis, incluyendo extracted data, findings y audit logs, use GET /analyses/:analysisId.

​
Códigos de error

StatusCodeDescripción
404PROFILE_NOT_FOUNDEl profile especificado no fue encontrado