Skip to main content
GET
/
v1
/
risk
/
velocity
/
{subject_id}
Get velocity windows
curl --request GET \
  --url https://api.truthlocks.com/v1/risk/velocity/{subject_id} \
  --header 'X-API-Key: <api-key>'
{
  "subject_id": "<string>",
  "windows": [
    {
      "window": "<string>",
      "count": 123,
      "action": "<string>"
    }
  ]
}
Returns the current velocity windows for a subject across all tracked action types. Each action type includes counts for the four rolling windows (1 m, 5 m, 1 h, 24 h) and the computed velocity score. Use this endpoint to check a subject’s current velocity profile without recording a new action. See the velocity and anomaly scoring guide for the scoring model and integration patterns.

​
Request

​
subject_id
string
required
Identifier of the subject to query.

​
Response

​
subject_id
string
The subject that was queried.
​
actions
array
List of tracked action types for this subject. Each entry includes action_type, windows (with 1m, 5m, 1h, 24h counts), and velocity_score.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

​
subject_id
string
required

Subject identifier

Query Parameters

​
action
string

Filter by action type

Response

Velocity windows

​
subject_id
string
​
windows
object[]