Skip to main content
GET
/
v1
/
predictions
/
summary
Get Predictions Summary
curl --request GET \
  --url https://api.example.com/v1/predictions/summary \
  --header 'Authorization: Bearer <token>'
{
  "window": "<string>",
  "total_predictions": 123,
  "high_probability_count": 123,
  "by_impact": {},
  "generated_at": "<string>",
  "high_probability_threshold": 0.8,
  "total": 0,
  "high_probability": 0,
  "above_alert_threshold": 0,
  "avg_probability": 0,
  "latest_generated_at": "<string>",
  "by_pattern": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
window
string
default:30d
​
high_probability_threshold
number
default:0.8
Required range: 0 <= x <= 1

Response

Successful Response

Full predictions summary response. Includes both the predictions-page field names (total_predictions, high_probability_count) and the dashboard-spec canonical field names (total, high_probability, above_alert_threshold, avg_probability, latest_generated_at, by_pattern) as optional fields for backward compat.

​
window
string
required
​
total_predictions
integer
required
​
high_probability_count
integer
required
​
by_impact
By Impact · object
required
​
generated_at
string
required
​
high_probability_threshold
number
default:0.8
​
total
integer
default:0
​
high_probability
integer
default:0
​
above_alert_threshold
integer
default:0
​
avg_probability
number
default:0
​
latest_generated_at
string | null
​
by_pattern
By Pattern · object[]