Get organization analytics
Retrieve aggregate analytics and statistics for your organization’s trading accounts in a single call.
What you get
| Section | Description |
|---|---|
| summary | Total accounts, total traders, active lockouts |
| accounts.byStatus | Counts per status: not_started, in_progress, passed, failed, expired |
| accounts.byType | Counts per type: evaluation, sim_funded, competition |
| accounts.passRate | Pass rate = passed / (passed + failed) × 100 |
| accounts.passRateIncludingExpired | Stricter: passed / (passed + failed + expired) × 100 |
| accounts.avgCompletionDays | Average days to complete (pass or fail) |
| accounts.avgTimeToPassDays | Average days to pass |
| revenue | Total revenue, purchase count, average per account |
| payouts | Total paid out, payout count, average/largest payout, payout ratio (paid out ÷ revenue) |
| risk | Open profit liability across in-progress accounts, accounts in profit vs drawdown, lockout breakdown (per mode, per account status, and on live accounts) |
| violations | Violation reason breakdown for failed accounts |
| performance | Average P&L, drawdown, trades, win rate |
Filters
| Parameter | Type | Example | Description |
|---|---|---|---|
startDate | ISO 8601 | 2026-01-01 | Only accounts created on or after this date |
endDate | ISO 8601 | 2026-03-31 | Only accounts created on or before this date |
type | string | evaluation | Only accounts of this type (evaluation, sim_funded, competition) |
A range that ends now (its end is less than an hour ago, or later) is read in full hours: the start moves back to the full hour and the end covers everything up to now. A range that ended earlier is read exactly as sent.
All filters are optional. Omit all for all-time analytics across all account types.
Results refresh at most once a minute for the same filters; generatedAt tells you when they were computed.
Null values
Fields like passRate, avgCompletionDays, avgRevenuePerAccount, and performance return null when there is insufficient data to compute them (e.g. no completed accounts, no purchases, no performance data). This avoids misleading zero values.
Error codes
| HTTP | Code | When |
|---|---|---|
| 400 | VALIDATION_ERROR | startDate/endDate is not valid ISO 8601, or type is not evaluation, sim_funded, or competition |
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 403 | FORBIDDEN | Credentials do not belong to any organization |
| 500 | ANALYTICS_ERROR | Internal error |
Examples
# All-time analytics (API key)
curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics" \
-H "X-API-Key: hp_live_your_key_here"
# Q1 2026 evaluations only (API key)
curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics?startDate=2026-01-01&endDate=2026-03-31&type=evaluation" \
-H "X-API-Key: hp_live_your_key_here"
Authentication: send your organization API key in the X-API-Key header.
Access: read-only and full-access API keys. Dashboard members need view access to Analytics & audit log.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/analytics \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/analytics"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/analytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/analytics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/analytics")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "55555555-5555-4555-8555-555555555555",
"organizationName": "Acme Trading Co",
"generatedAt": "2026-03-29T15:00:00.000Z",
"filters": {
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-03-31T23:59:59.999Z",
"type": "evaluation"
},
"summary": {
"totalAccounts": 1250,
"totalTraders": 892,
"tradersWhoTraded": 640,
"activeLockouts": 15
},
"accounts": {
"byStatus": {
"notStarted": 120,
"inProgress": 450,
"passed": 180,
"failed": 420,
"expired": 80
},
"byType": {
"evaluation": 900,
"sim_funded": 300,
"competition": 50
},
"passRate": 30,
"passRateIncludingExpired": 24,
"avgCompletionDays": 12.5,
"avgTimeToPassDays": 18.3,
"medianTimeToPassDays": 12,
"avgTimeToFailDays": 6.4,
"medianTimeToFailDays": 3
},
"revenue": {
"totalRevenue": 187500,
"currency": "USD",
"totalPurchases": 1250,
"avgRevenuePerAccount": 150,
"revenueRecorded": 127,
"revenueEstimated": 287463,
"estimatedPurchases": 2997,
"revenueBasis": "plan_list_price"
},
"payouts": {
"totalPaidOut": 48200,
"currency": "USD",
"payoutCount": 31,
"avgPayout": 1554.84,
"largestPayout": 5000,
"accountsWithPayouts": 18,
"payoutRatio": 25.7,
"payoutRatioBasis": "plan_list_price"
},
"risk": {
"openProfitLiability": 63400,
"fundedAccountsInProfit": 41,
"largestOpenProfit": 8210.5,
"evalOpenProfit": 184273,
"accountsNearBreach": 37,
"accountsNearTarget": 22,
"avgLossRoom": 812.4,
"accountsInProfit": 120,
"accountsInDrawdown": 210,
"activeLockouts": 15,
"activeLockoutsByAccountStatus": {
"failed": 2,
"inProgress": 12,
"notStarted": 1
},
"actionableLockouts": 13,
"lockoutsByMode": {
"admin": 5,
"trade_clock": 8,
"timed": 2
},
"lockoutsByLockedBy": {
"admin": 5,
"user": 8,
"system": 2
}
},
"funnel": {
"purchased": 2997,
"started": 2941,
"passed": 253,
"funded": 274,
"paidOut": 23
},
"violations": {
"Max loss": 1180,
"Max drawdown": 260,
"Daily loss limit": 95,
"Consistency rule": 12,
"Unknown / legacy": 35
},
"violationsDistinctRaw": 1383,
"performance": {
"avgPnl": 245.5,
"avgMaxDrawdown": 1250.75,
"avgTradesPerAccount": 47.3,
"avgWinRate": 38.2,
"medianPnl": -410,
"totalTrades": 150987,
"accountsTraded": 2440
},
"byPlan": [
{
"planId": "88888888-8888-4888-8888-888888888882",
"planName": "Rapid 25K - Eval",
"accountSize": 25000,
"price": 109,
"accounts": 1663,
"inProgress": 590,
"passed": 140,
"failed": 900,
"passRatePct": 13.5,
"revenueEstimated": 181267,
"payouts": 0,
"openProfit": 52310
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Date must be a valid ISO 8601 string (e.g. 2026-01-01 or 2026-01-01T00:00:00.000Z)",
"code": "VALIDATION_ERROR"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired token",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "You do not belong to any organization",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"statusCode": 500,
"error": "Internal Server Error",
"message": "An error occurred fetching analytics",
"code": "ANALYTICS_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The report took too long right now; try again later",
"code": "REPORT_TIMEOUT"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Headers
Query Parameters
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/analytics \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/analytics"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/analytics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hyperprop.com/platform/v1/organization/analytics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hyperprop.com/platform/v1/organization/analytics")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"organizationId": "55555555-5555-4555-8555-555555555555",
"organizationName": "Acme Trading Co",
"generatedAt": "2026-03-29T15:00:00.000Z",
"filters": {
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-03-31T23:59:59.999Z",
"type": "evaluation"
},
"summary": {
"totalAccounts": 1250,
"totalTraders": 892,
"tradersWhoTraded": 640,
"activeLockouts": 15
},
"accounts": {
"byStatus": {
"notStarted": 120,
"inProgress": 450,
"passed": 180,
"failed": 420,
"expired": 80
},
"byType": {
"evaluation": 900,
"sim_funded": 300,
"competition": 50
},
"passRate": 30,
"passRateIncludingExpired": 24,
"avgCompletionDays": 12.5,
"avgTimeToPassDays": 18.3,
"medianTimeToPassDays": 12,
"avgTimeToFailDays": 6.4,
"medianTimeToFailDays": 3
},
"revenue": {
"totalRevenue": 187500,
"currency": "USD",
"totalPurchases": 1250,
"avgRevenuePerAccount": 150,
"revenueRecorded": 127,
"revenueEstimated": 287463,
"estimatedPurchases": 2997,
"revenueBasis": "plan_list_price"
},
"payouts": {
"totalPaidOut": 48200,
"currency": "USD",
"payoutCount": 31,
"avgPayout": 1554.84,
"largestPayout": 5000,
"accountsWithPayouts": 18,
"payoutRatio": 25.7,
"payoutRatioBasis": "plan_list_price"
},
"risk": {
"openProfitLiability": 63400,
"fundedAccountsInProfit": 41,
"largestOpenProfit": 8210.5,
"evalOpenProfit": 184273,
"accountsNearBreach": 37,
"accountsNearTarget": 22,
"avgLossRoom": 812.4,
"accountsInProfit": 120,
"accountsInDrawdown": 210,
"activeLockouts": 15,
"activeLockoutsByAccountStatus": {
"failed": 2,
"inProgress": 12,
"notStarted": 1
},
"actionableLockouts": 13,
"lockoutsByMode": {
"admin": 5,
"trade_clock": 8,
"timed": 2
},
"lockoutsByLockedBy": {
"admin": 5,
"user": 8,
"system": 2
}
},
"funnel": {
"purchased": 2997,
"started": 2941,
"passed": 253,
"funded": 274,
"paidOut": 23
},
"violations": {
"Max loss": 1180,
"Max drawdown": 260,
"Daily loss limit": 95,
"Consistency rule": 12,
"Unknown / legacy": 35
},
"violationsDistinctRaw": 1383,
"performance": {
"avgPnl": 245.5,
"avgMaxDrawdown": 1250.75,
"avgTradesPerAccount": 47.3,
"avgWinRate": 38.2,
"medianPnl": -410,
"totalTrades": 150987,
"accountsTraded": 2440
},
"byPlan": [
{
"planId": "88888888-8888-4888-8888-888888888882",
"planName": "Rapid 25K - Eval",
"accountSize": 25000,
"price": 109,
"accounts": 1663,
"inProgress": 590,
"passed": 140,
"failed": 900,
"passRatePct": 13.5,
"revenueEstimated": 181267,
"payouts": 0,
"openProfit": 52310
}
]
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Date must be a valid ISO 8601 string (e.g. 2026-01-01 or 2026-01-01T00:00:00.000Z)",
"code": "VALIDATION_ERROR"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Invalid or expired token",
"code": "UNAUTHORIZED"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "You do not belong to any organization",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"statusCode": 500,
"error": "Internal Server Error",
"message": "An error occurred fetching analytics",
"code": "ANALYTICS_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The report took too long right now; try again later",
"code": "REPORT_TIMEOUT"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}