Quickstart

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

Prerequisites

• A Client ID and API key for the organization you’re assessing (see Authentication)

1. Get the current score

cURL

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

JavaScript

const res = await fetch(
  'https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/score',
  { headers: { 'x-api-key': process.env.API_KEY } },
);
const score = await res.json();

Python

import os
import requests

response = requests.get(
    "https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/score",
    headers={"x-api-key": os.environ["API_KEY"]},
    timeout=10,
)
score = response.json()

Response:

{
  "clientId": "osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "scoreDate": "2026-03-18",
  "score": 84,
  "grade": "Optimize"
}

2. Get the pillar breakdown

See which of the four pillars is driving the score:

cURL

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

JavaScript

const res = await fetch(
  'https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/pillars',
  { headers: { 'x-api-key': process.env.API_KEY } },
);
const pillars = await res.json();

Python

import os
import requests

response = requests.get(
    "https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/pillars",
    headers={"x-api-key": os.environ["API_KEY"]},
    timeout=10,
)
pillars = response.json()

Response:

{
  "clientId": "osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "scoreDate": "2026-03-18",
  "pillarScores": {
    "structuralIntegrity": 84,
    "failureResistance": 82,
    "deviceHealth": 86,
    "recoveryCapability": 84
  }
}

3. Check the trend

See how the score has changed over the last year:

cURL

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

JavaScript

const res = await fetch(
  'https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/trend?days=365',
  { headers: { 'x-api-key': process.env.API_KEY } },
);
const trend = await res.json();

Python

import os
import requests

response = requests.get(
    "https://api.overspace.io/orion/v1/customers/osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d/trend",
    headers={"x-api-key": os.environ["API_KEY"]},
    params={"days": 365},
    timeout=10,
)
trend = response.json()

Response (excerpt; the API returns a point for every scored day):

{
  "clientId": "osc_x7k2q9_9f8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
  "trend": [
    { "scoreDate": "2026-03-18", "score": 84 },
    { "scoreDate": "2026-03-17", "score": 84 },
    { "scoreDate": "2026-03-16", "score": 83 },
    { "scoreDate": "2026-03-15", "score": 83 },
    { "scoreDate": "2026-03-14", "score": 82 }
  ]
}

Deeper in this organization’s 365-point series, the score climbs from 46 (Improve) to 84 (Optimize) over four quarters. See Security Transformation for the full story, including the October dip.

Next steps

• QR Score overview: what the score measures
• Pillar breakdown: a deep dive into each pillar
• Full API reference: all available endpoints