Journeys API

Get Journey Prediction

get

Retrieves the data for a specific journey. Also includes the associated user in relationships.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

journey_idstringRequired

The ID of the user journey whose data is being retrieved.

Responses

200

Successful response with journey data and associated user in relationships.

application/json

401

Unauthorized

application/json

404

Resource not found.

application/json

get

/journeys/{journey_id}

HTTPcURLJavaScriptPython

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

{
  "trace_id": "text",
  "data": [
    {
      "type": "journey",
      "id": "text",
      "attributes": {
        "predictions": [
          {
            "risk_type": "text",
            "risk_score": 1,
            "risk_level": "LOW",
            "explanation": "text",
            "created_at": "2025-12-25T03:48:00.859Z",
            "updated_at": "2025-12-25T03:48:00.859Z",
            "model_version": "text"
          }
        ]
      }
    }
  ]
}