User API

Get User Prediction and Related Predictions

get

Retrieves the aggregated data for a single user, including their risk score and a list of related predictions.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

The ID of the user whose data is being retrieved.

Query parameters

max_items_per_typeintegerOptional

The maximum number of items per type to return

Example: 10

min_low_weight_type_countintegerOptional

The minimum number of low weight types to consider

Example: 3

connection_typesstringOptional

Comma-separated list of connection types (e.g., "ip,client_id,ja3,bing_gan,journey_id")

Example: ip,client_id,ja3,bing_gan,journey_id

fields[user]stringOptional

Comma-separated list of user fields (e.g., "analytics,predictions,customer_graph_analytics,explanation")

Example: analytics,predictions,customer_graph_analytics,explanation

Responses

200

Successful response with user data and related predictions.

application/json

401

Unauthorized

application/json

404

Resource not found.

application/json

get

/users/{user_id}

HTTPcURLJavaScriptPython

GET /data-api/v2/users/{user_id} HTTP/1.1
Host: server.telemetry.services.yofi.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "trace_id": "text",
  "data": [
    {
      "type": "user",
      "id": "text",
      "attributes": {
        "predictions": [
          {
            "risk_type": "text",
            "risk_score": 1,
            "risk_level": "LOW",
            "explanation": "text",
            "created_at": "2025-12-26T08:06:28.384Z",
            "updated_at": "2025-12-26T08:06:28.384Z",
            "model_version": "text"
          }
        ],
        "analytics": {
          "bot_journeys_count": 1,
          "browser_fingerprints_count": 1,
          "client_id_count": 1,
          "ip_count": 1,
          "journeys_count": 1,
          "max_users_per_journey": 1,
          "network_fingerprints_count": 1,
          "risky_ip_count": 1,
          "sessions_count": 1
        },
        "customer_graph_analytics": {
          "bot_journeys_count": 1,
          "browser_fingerprints_count": 1,
          "client_id_count": 1,
          "connected_bot_customers_in_graph": 1,
          "connected_customers_count": 1,
          "connected_risky_customers_in_graph": 1,
          "ip_count": 1,
          "journeys_count": 1,
          "max_user_per_browser_fingerprint": 1,
          "max_user_per_client_id": 1,
          "max_user_per_ip": 1,
          "max_user_per_journey": 1,
          "max_user_per_network_fingerprint": 1,
          "network_fingerprints_count": 1,
          "shared_browser_fingerprint": 1,
          "shared_browser_fingerprint_ratio": 1,
          "shared_client_id": 1,
          "shared_client_id_ratio": 1,
          "shared_ip": 1,
          "shared_ip_ratio": 1,
          "shared_journey": 1,
          "shared_journey_ratio": 1,
          "shared_network_fingerprint": 1,
          "shared_network_fingerprint_ratio": 1
        }
      },
      "relationships": {
        "journeys": {
          "data": [
            {
              "type": "journey",
              "id": "text"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "journey",
      "id": "text",
      "attributes": {
        "predictions": [
          {
            "risk_type": "text",
            "risk_score": 1,
            "risk_level": "LOW",
            "explanation": "text",
            "created_at": "2025-12-26T08:06:28.384Z",
            "updated_at": "2025-12-26T08:06:28.384Z",
            "model_version": "text"
          }
        ]
      }
    }
  ]
}