> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 | | **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`) | All filters are optional. Omit all for all-time analytics across all account types. ## 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 ```bash # 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. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/analytics openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/analytics: get: tags: - Analytics summary: Get organization analytics description: >- 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 | | **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`) | All filters are optional. Omit all for all-time analytics across all account types. ## 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 ```bash # 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. operationId: getV1OrganizationAnalytics parameters: - description: >- Filter accounts created on or after this date (ISO 8601). Examples: `2026-01-01`, `2026-01-01T00:00:00.000Z` x-format: isoDate: true name: startDate in: query schema: type: string - description: >- Filter accounts created on or before this date (ISO 8601). Examples: `2026-03-31`, `2026-03-31T23:59:59.999Z` x-format: isoDate: true name: endDate in: query schema: type: string - description: >- Filter by account type. Only accounts of this type are included in all metrics. name: type in: query schema: type: string enum: - evaluation - sim_funded - competition responses: '200': description: Success — Returns aggregate analytics for your organization content: '*/*': schema: $ref: '#/components/schemas/Model38' '400': description: Validation error — invalid date format, date range, or account type content: '*/*': schema: $ref: '#/components/schemas/Model39' '401': description: Unauthorized — missing or invalid API key content: '*/*': schema: $ref: '#/components/schemas/Model40' '403': description: >- Forbidden — authenticated user is not associated with any organization content: '*/*': schema: $ref: '#/components/schemas/Model41' '500': description: Internal error content: '*/*': schema: $ref: '#/components/schemas/Model42' security: - X-API-Key: [] components: schemas: Model38: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model37' Model39: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: >- Date must be a valid ISO 8601 string (e.g. 2026-01-01 or 2026-01-01T00:00:00.000Z) code: type: string description: Machine-readable error code — switch on this, not on message text example: VALIDATION_ERROR Model40: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired token code: type: string example: UNAUTHORIZED Model41: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: You do not belong to any organization code: type: string example: FORBIDDEN Model42: type: object properties: statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An error occurred fetching analytics code: type: string example: ANALYTICS_ERROR Model37: type: object properties: organizationId: type: string description: Your organization ID example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 x-format: guid: true organizationName: type: string description: Your organization display name example: Acme Trading Co generatedAt: type: string description: ISO 8601 timestamp when this response was generated (always UTC) example: '2026-03-29T15:00:00.000Z' x-format: isoDate: true filters: $ref: '#/components/schemas/filters' summary: $ref: '#/components/schemas/summary' accounts: $ref: '#/components/schemas/accounts' revenue: $ref: '#/components/schemas/revenue' payouts: $ref: '#/components/schemas/payouts' risk: $ref: '#/components/schemas/risk' funnel: $ref: '#/components/schemas/funnel' violations: $ref: '#/components/schemas/violations' violationsDistinctRaw: type: integer description: >- How many distinct raw violation strings the categories were folded from example: 1383 performance: $ref: '#/components/schemas/performance' byPlan: $ref: '#/components/schemas/byPlan' filters: type: object description: Echoes back the filters applied to this analytics request properties: startDate: type: string description: Start date filter applied (null if not set) example: '2026-01-01T00:00:00.000Z' endDate: type: string description: End date filter applied (null if not set) example: '2026-03-31T23:59:59.999Z' type: type: string description: Account type filter applied (null if not set) example: evaluation summary: type: object description: High-level summary counts properties: totalAccounts: type: integer description: Total number of trading accounts matching the filters example: 1250 totalTraders: type: integer description: >- Total registered traders in the organization (unaffected by date/type filters) example: 892 tradersWhoTraded: type: integer description: Accounts that have placed at least one trade (matching the filters) example: 640 activeLockouts: type: integer description: Number of currently active lockouts across matching accounts example: 15 accounts: type: object description: Account breakdown, pass rates, and timing metrics properties: byStatus: $ref: '#/components/schemas/byStatus' byType: $ref: '#/components/schemas/byType' passRate: type: number description: >- Percentage of completed accounts that passed. Formula: passed / (passed + failed) × 100. Excludes expired, in_progress, and not_started. Returns null if no accounts have completed. example: 30 passRateIncludingExpired: type: number description: >- Stricter pass rate that treats expired as non-pass. Formula: passed / (passed + failed + expired) × 100. Returns null if denominator is zero. example: 24 avgCompletionDays: type: number description: >- Average calendar days from started_at to completed_at for passed + failed accounts. Returns null if no accounts have both timestamps. example: 12.5 avgTimeToPassDays: type: number description: >- Average calendar days from started_at to completed_at for passed accounts only. Returns null if no passed accounts have both timestamps. example: 18.3 medianTimeToPassDays: type: number description: Median calendar days to pass example: 12 avgTimeToFailDays: type: number description: >- Average calendar days from started_at to completed_at for failed accounts example: 6.4 medianTimeToFailDays: type: number description: Median calendar days to fail example: 3 revenue: type: object description: Revenue and purchase metrics properties: totalRevenue: type: number description: >- Sum of price_paid across all matching purchases (USD). Excludes $0 / free purchases. example: 187500 currency: type: string description: Revenue currency — always USD example: USD totalPurchases: type: integer description: Number of paid purchases (price_paid > 0) example: 1250 avgRevenuePerAccount: type: number description: revenueEstimated / estimatedPurchases. Returns null if no purchases. example: 150 revenueRecorded: type: number description: >- Sum of price_paid the organization recorded on its purchases. Firms that bill on their own site usually record 0. example: 127 revenueEstimated: type: number description: >- Revenue with the plan list price substituted wherever no price was recorded — the same basis as the firm P&L report. example: 287463 estimatedPurchases: type: integer description: Purchases counted in revenueEstimated example: 2997 revenueBasis: $ref: '#/components/schemas/revenueBasis' payouts: type: object description: Payout (balance withdrawal) aggregates for matching accounts properties: totalPaidOut: type: number description: >- Sum of all executed payouts (balance withdrawals) for matching accounts (USD). Date filters apply to the payout date. example: 48200 currency: type: string example: USD payoutCount: type: integer description: Number of executed payouts example: 31 avgPayout: type: number description: totalPaidOut / payoutCount. Null if no payouts. example: 1554.84 largestPayout: type: number description: Largest single payout. Null if no payouts. example: 5000 accountsWithPayouts: type: integer description: Distinct accounts that received at least one payout example: 18 payoutRatio: type: number description: >- totalPaidOut ÷ revenue × 100 — the share of purchase revenue paid back out to traders. Uses recorded revenue when the organization records prices, otherwise plan list prices (see payoutRatioBasis). Null if no revenue. example: 25.7 payoutRatioBasis: $ref: '#/components/schemas/payoutRatioBasis' risk: type: object description: Live risk exposure metrics properties: openProfitLiability: type: number description: >- Sum of (current balance − initial balance) across in-progress FUNDED accounts currently in profit — what you could owe if every one of them requested a payout now. Evaluation profit is excluded (see evalOpenProfit). example: 63400 fundedAccountsInProfit: type: integer description: Funded accounts contributing to openProfitLiability example: 41 largestOpenProfit: type: number description: Largest single funded-account open profit example: 8210.5 evalOpenProfit: type: number description: >- Profit sitting on in-progress evaluation accounts — not payable, shown for context example: 184273 accountsNearBreach: type: integer description: >- In-progress accounts within 10% of their binding loss limit (max loss or drawdown floor) example: 37 accountsNearTarget: type: integer description: In-progress evaluations at or beyond 90% of their profit target example: 22 avgLossRoom: type: number description: >- Average dollars of room left before the binding loss limit, across in-progress accounts with a rule example: 812.4 accountsInProfit: type: integer description: In-progress accounts above their initial balance example: 120 accountsInDrawdown: type: integer description: In-progress accounts below their initial balance example: 210 activeLockouts: type: integer description: Currently active lockouts (same number as summary.activeLockouts) example: 15 lockoutsByMode: $ref: '#/components/schemas/lockoutsByMode' lockoutsByLockedBy: $ref: '#/components/schemas/lockoutsByLockedBy' funnel: type: object description: Lifecycle funnel across the matching accounts properties: purchased: type: integer description: Accounts matching the filters example: 2997 started: type: integer description: Accounts that left not_started example: 2941 passed: type: integer description: Evaluations passed example: 253 funded: type: integer description: Funded / sim-funded accounts example: 274 paidOut: type: integer description: Accounts that received at least one payout example: 23 violations: type: object description: >- Failed accounts by rule category (Max loss, Max drawdown, Daily loss limit, Consistency rule, Inactivity, Expired, Position size, Restricted trading window, Holding restriction, Manual / firm decision, Other, Unknown / legacy). Reasons are normalised: the dollar figures in the underlying violation text are not part of the key. Empty object if no failures. example: Max loss: 1180 Max drawdown: 260 Daily loss limit: 95 Consistency rule: 12 Unknown / legacy: 35 performance: type: object description: >- Aggregate performance metrics across your accounts. Returns null if no accounts have performance data. properties: avgPnl: type: number description: >- Average total P&L (from performance_data.total_pnl) across all accounts with performance data example: 245.5 avgMaxDrawdown: type: number description: >- Average max drawdown (from performance_data.max_drawdown) across all accounts with performance data example: 1250.75 avgTradesPerAccount: type: number description: Average total_trades per account example: 47.3 avgWinRate: type: number description: >- Winning trades ÷ all trades across matching accounts × 100 (trade-weighted, not an average of per-account rates) example: 38.2 medianPnl: type: number description: Median total P&L per account example: -410 totalTrades: type: integer description: All trades across matching accounts example: 150987 accountsTraded: type: integer description: Accounts with at least one trade example: 2440 byPlan: type: array description: >- Per trading plan: accounts, outcomes, estimated revenue, payouts and open profit items: $ref: '#/components/schemas/Model36' byStatus: type: object description: Account counts broken down by status properties: notStarted: type: integer description: Accounts created but never started trading example: 120 inProgress: type: integer description: Accounts currently being traded example: 450 passed: type: integer description: Accounts that hit their profit target example: 180 failed: type: integer description: Accounts that violated a rule (drawdown, daily loss, max loss, etc.) example: 420 expired: type: integer description: Accounts that reached their end date without passing or failing example: 80 byType: type: object description: >- Account counts broken down by type. Keys are account types, values are counts. example: evaluation: 900 sim_funded: 300 competition: 50 revenueBasis: type: string description: Which basis the dashboard should present and the payout ratio uses example: plan_list_price enum: - recorded - plan_list_price payoutRatioBasis: type: string example: plan_list_price enum: - recorded - plan_list_price lockoutsByMode: type: object description: Active lockouts broken down by mode example: admin: 5 trade_clock: 8 timed: 2 lockoutsByLockedBy: type: object description: Active lockouts broken down by who created them example: admin: 5 user: 8 system: 2 Model36: type: object properties: planId: type: string example: d5de82c1-2ad6-4acc-8050-db455bb7e235 planName: type: string example: Rapid 25K - Eval accountSize: type: number example: 25000 price: type: number example: 109 accounts: type: integer example: 1663 inProgress: type: integer example: 590 passed: type: integer example: 140 failed: type: integer example: 900 passRatePct: type: number example: 13.5 revenueEstimated: type: number example: 181267 payouts: type: number example: 0 openProfit: type: number example: 52310 securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Get your organization profile](/platform-api/organization-profile/get-your-organization-profile.md) - [Get purchases for your organization](/platform-api/purchases/get-purchases-for-your-organization.md) - [Get organization audit log](/platform-api/logs-and-health/get-organization-audit-log.md) - [Get traders for your organization](/platform-api/traders/get-traders-for-your-organization.md) - [Get trading plans for your organization](/platform-api/trading-plans/get-trading-plans-for-your-organization.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.