Get plan performance by purchase month
Which plans and which months’ buyers make money. Accounts are grouped by the month they were created and by plan, with their revenue, outcomes, the payouts executed on them to date and the traders’ net profit and loss.
Key fields
| Field | Description |
|---|---|
revenue | The price you recorded on the purchase, else the plan’s list price; never a list price for funded accounts |
payouts / net / payoutRatioPct | Payouts on these accounts to date, revenue − payouts, and payouts ÷ revenue |
outcomes / passRatePct | Where the accounts stand now |
traderPnl | Net profit and loss of the closed trades on these accounts (from pnlCoveredFrom) |
months lists each month with its plans; plans sums every month per plan; totals sums everything. Test accounts are excluded. Results are recomputed at most every 15 minutes, so they can be up to 30 minutes old.
Example
curl "https://api.hyperprop.com/platform/v1/organization/risk/cohorts?months=6" \
-H "X-API-Key: hp_live_your_key_here"
Permissions: requires view access to “Analytics”.
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/risk/cohorts \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/cohorts"
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/risk/cohorts', 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/risk/cohorts",
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/risk/cohorts"
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/risk/cohorts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/cohorts")
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",
"generatedAt": "2026-11-14T08:00:00.000Z",
"currency": "USD",
"fromMonth": "2025-12",
"pnlCoveredFrom": "2026-08-14",
"months": [
{
"month": "2026-10",
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188,
"plans": [
{
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "100K Pro",
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188
}
]
}
],
"plans": [
{
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "100K Pro",
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188
}
],
"totals": {
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "This API key does not have admin permissions",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "Failed to build the cohort report",
"code": "COHORTS_ERROR"
}{
"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/risk/cohorts \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/risk/cohorts"
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/risk/cohorts', 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/risk/cohorts",
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/risk/cohorts"
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/risk/cohorts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/risk/cohorts")
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",
"generatedAt": "2026-11-14T08:00:00.000Z",
"currency": "USD",
"fromMonth": "2025-12",
"pnlCoveredFrom": "2026-08-14",
"months": [
{
"month": "2026-10",
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188,
"plans": [
{
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "100K Pro",
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188
}
]
}
],
"plans": [
{
"planId": "7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6",
"planName": "100K Pro",
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188
}
],
"totals": {
"accounts": 1306,
"revenue": 651694,
"payouts": 12400,
"net": 639294,
"netPerAccount": 489.5,
"payoutRatioPct": 1.9,
"outcomes": {
"inProgress": 1240,
"passed": 3,
"failed": 52,
"expired": 5
},
"passRatePct": 5.45,
"funded": 41,
"payoutCount": 9,
"accountsWithPayouts": 4,
"traderPnl": -372928.4,
"trades": 18220,
"accountsTraded": 1188
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "This API key does not have admin permissions",
"code": "INSUFFICIENT_PERMISSIONS"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "Failed to build the cohort report",
"code": "COHORTS_ERROR"
}{
"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"
}