Skip to content
Overspace ORION API

Quickstart

This guide walks you through retrieving a Quantified Resilience Score (QR Score) from the API.

Prerequisites

Section titled “Prerequisites”
  • A Client ID and API key for the organization you’re assessing (see Authentication)

1. Get the current score

Section titled “1. Get the current score”
Terminal window
curl https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/score \
  -H "x-api-key: your-api-key"

Response:

{
  "clientId": "osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "scoreDate": "2026-03-18",
  "score": 68,
  "grade": "Strengthen"
}

2. Get the pillar breakdown

Section titled “2. Get the pillar breakdown”

See which of the four pillars is driving the score:

Terminal window
curl https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/pillars \
  -H "x-api-key: your-api-key"

Response:

{
  "clientId": "osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "scoreDate": "2026-03-18",
  "pillarScores": {
    "structuralIntegrity": 72,
    "failureResistance": 65,
    "deviceHealth": 58,
    "recoveryCapability": 75
  }
}

3. Check the trend

Section titled “3. Check the trend”

See how the score has changed over the last 90 days:

Terminal window
curl "https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/trend?days=90" \
  -H "x-api-key: your-api-key"

Response:

{
  "clientId": "osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "trend": [
    { "scoreDate": "2026-03-18", "score": 68 },
    { "scoreDate": "2026-03-17", "score": 67 },
    { "scoreDate": "2026-03-16", "score": 67 }
  ]
}

Next steps

Section titled “Next steps”