Entity Details API

Overview

The Entity Details API is a RESTful endpoint that enables you to retrieve comprehensive information about a specific entity when you know its unique identifier. This endpoint is particularly useful when detailed information is required for a known entity, such as when investigating security incidents or analyzing user behavior patterns.

The API is accessed through the GET /api/entity/<entity_id>.

Path parameters

The API requires the following path parameter:

Response structure

The API returns detailed information for the requested entity, including:

• Entity identifier
• Associated username
• Current risk score
• Latest risk score
• Entity activity timestamps
• Additional entity-related attributes

Response example

The following example shows a typical API response for an entity:

{
  "risk_threshold": 50.0,
  "entities": [
    {
      "entity_id": 12345,
      "username": "john.doe",
      "risk_score": 78.5,
      "latest_risk": 82.0,
      "first_seen": "2026-05-10T08:15:00Z",
      "last_seen": "2026-06-15T14:30:00Z"
    }
  ]
}

The response fields include:

• risk_threshold indicates the effective risk threshold applied to the query.
• entities contains an array with the requested entity details.
• entity_id is the unique identifier for the entity.
• username is the username associated with the entity.
• risk_score represents the current risk score for the entity.
• latest_risk shows the most recent risk score calculated for the entity.
• first_seen indicates when the entity was first observed in the system.
• last_seen shows the most recent activity timestamp for the entity.

Error handling

The API returns standard HTTP status codes to indicate the result of the request: