> ## 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 integration health (alerts, errors, insights) > Computed health overview of your integration, Stripe-Workbench style: - **alerts** — things needing action now: auto-disabled webhook endpoints, endpoints accumulating consecutive failures, deliveries currently in the automatic retry cycle, deliveries that exhausted retries in the last 24h. - **errors** — API request error groups from the last 7 days (route + status + error code + count), sourced from the request log. - **insights** — recommendations: missing webhook registration, low delivery success rate, high API latency, noisiest failing route. - **summary** — 7-day webhook success rate, delivery counts, API request and error counts, and average API latency. **Permissions:** requires **view** access to "Webhooks". **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/health 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/health: get: tags: - Logs and health summary: Get integration health (alerts, errors, insights) description: >- Computed health overview of your integration, Stripe-Workbench style: - **alerts** — things needing action now: auto-disabled webhook endpoints, endpoints accumulating consecutive failures, deliveries currently in the automatic retry cycle, deliveries that exhausted retries in the last 24h. - **errors** — API request error groups from the last 7 days (route + status + error code + count), sourced from the request log. - **insights** — recommendations: missing webhook registration, low delivery success rate, high API latency, noisiest failing route. - **summary** — 7-day webhook success rate, delivery counts, API request and error counts, and average API latency. **Permissions:** requires **view** access to "Webhooks". **Authentication:** send your organization API key in the `X-API-Key` header. operationId: getV1OrganizationHealth responses: '200': description: Computed integration health content: '*/*': schema: $ref: '#/components/schemas/Model79' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model47' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model79: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model78' Model9: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model47: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model78: type: object properties: generatedAt: type: string x-format: isoDate: true alerts: $ref: '#/components/schemas/alerts' errors: $ref: '#/components/schemas/errors' insights: $ref: '#/components/schemas/insights' summary: $ref: '#/components/schemas/Model77' alerts: type: array items: $ref: '#/components/schemas/Model74' errors: type: array items: $ref: '#/components/schemas/Model75' insights: type: array items: $ref: '#/components/schemas/Model76' Model77: type: object properties: webhookSuccessRate7d: type: number example: 93.33 deliveries7d: type: integer failedDeliveries7d: type: integer retryingNow: type: integer apiRequests7d: type: integer apiErrors7d: type: integer apiAvgLatencyMs: type: number example: 120 Model74: type: object properties: id: type: string example: webhook-disabled-d2f3a1c0 severity: $ref: '#/components/schemas/Model73' title: type: string example: Webhook endpoint auto-disabled description: type: string Model75: type: object properties: route: type: string example: POST /platform/v1/organization/lockouts statusCode: type: integer example: 400 errorCode: type: string example: VALIDATION_ERROR count: type: integer example: 12 lastSeenAt: type: string x-format: isoDate: true Model76: type: object properties: id: type: string example: low-success-rate title: type: string description: type: string Model73: type: string enum: - critical - warning 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 - [Partner integrations](/guides/partner-integrations.md) - [Introduction](/introduction.md) - [Get organization audit log](/platform-api/logs-and-health/get-organization-audit-log.md) - [List API request logs](/platform-api/logs-and-health/list-api-request-logs.md) - [Get monthly firm P&L (revenue vs payouts vs platform costs)](/platform-api/analytics/get-monthly-firm-p&l-revenue-vs-payouts-vs-platform-costs.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.