> ## 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 hourly activity by weekday > When your firm is busiest: accounts sold, revenue and amount paid out per weekday and hour, for the last 7 days and the 7 days before, so you can compare the two weeks hour by hour. ## Shape Each metric has a `current` grid (the last 7 days) and a `previous` grid (the 7 days before). A grid has 168 numbers, one per hour of the week, starting Monday 00:00: index = day × 24 + hour, where day 0 is Monday and day 6 is Sunday. Hours are in the `timeZone` you pass. | Metric | Unit | Description | |--------|------|-------------| | `accountsSold` | accounts | Trading accounts created from purchases | | `revenue` | your currency | Amount paid for those accounts, or the plan's list price when no price was recorded | | `paidOut` | your currency | Payouts made to traders; reversed payouts are excluded | The periods roll with the request time, so every weekday-hour cell is counted exactly once per period. ## Filters | Parameter | Type | Example | Description | |-----------|------|---------|-------------| | `timeZone` | IANA time zone | `America/Chicago` | Time zone for weekdays and hours. Defaults to `UTC` | ## Error codes | HTTP | Code | When | |------|------|------| | 400 | `VALIDATION_ERROR` | timeZone is not a valid IANA time zone | | 401 | `UNAUTHORIZED` | Missing or invalid API key | | 403 | `FORBIDDEN` | Credentials do not belong to any organization | | 500 | `HOURLY_ACTIVITY_ERROR` | Internal error | ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics/hourly?timeZone=America/Chicago" \ -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/hourly 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/hourly: get: tags: - Analytics summary: Get hourly activity by weekday description: >- When your firm is busiest: accounts sold, revenue and amount paid out per weekday and hour, for the last 7 days and the 7 days before, so you can compare the two weeks hour by hour. ## Shape Each metric has a `current` grid (the last 7 days) and a `previous` grid (the 7 days before). A grid has 168 numbers, one per hour of the week, starting Monday 00:00: index = day × 24 + hour, where day 0 is Monday and day 6 is Sunday. Hours are in the `timeZone` you pass. | Metric | Unit | Description | |--------|------|-------------| | `accountsSold` | accounts | Trading accounts created from purchases | | `revenue` | your currency | Amount paid for those accounts, or the plan's list price when no price was recorded | | `paidOut` | your currency | Payouts made to traders; reversed payouts are excluded | The periods roll with the request time, so every weekday-hour cell is counted exactly once per period. ## Filters | Parameter | Type | Example | Description | |-----------|------|---------|-------------| | `timeZone` | IANA time zone | `America/Chicago` | Time zone for weekdays and hours. Defaults to `UTC` | ## Error codes | HTTP | Code | When | |------|------|------| | 400 | `VALIDATION_ERROR` | timeZone is not a valid IANA time zone | | 401 | `UNAUTHORIZED` | Missing or invalid API key | | 403 | `FORBIDDEN` | Credentials do not belong to any organization | | 500 | `HOURLY_ACTIVITY_ERROR` | Internal error | ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics/hourly?timeZone=America/Chicago" \ -H "X-API-Key: hp_live_your_key_here" ``` **Authentication:** send your organization API key in the `X-API-Key` header. operationId: getV1OrganizationAnalyticsHourly parameters: - description: IANA time zone for weekdays and hours. Defaults to UTC. name: timeZone in: query schema: type: string maxLength: 64 responses: '200': description: Success — hourly grids for the last 7 days and the 7 days before content: '*/*': schema: $ref: '#/components/schemas/HourlyActivityResponse' '400': description: Validation error — timeZone is not a valid IANA time zone content: '*/*': schema: $ref: '#/components/schemas/Model234' '401': description: Unauthorized — missing or invalid API key content: '*/*': schema: $ref: '#/components/schemas/Model235' '403': description: >- Forbidden — authenticated user is not associated with any organization content: '*/*': schema: $ref: '#/components/schemas/Model236' '500': description: Internal error content: '*/*': schema: $ref: '#/components/schemas/Model237' security: - X-API-Key: [] components: schemas: HourlyActivityResponse: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model233' Model234: 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: '"timeZone" must be a valid IANA time zone' code: type: string description: Machine-readable error code — switch on this, not on message text example: VALIDATION_ERROR Model235: 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 Model236: 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 Model237: type: object properties: statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: Failed to fetch hourly activity code: type: string example: HOURLY_ACTIVITY_ERROR Model233: type: object properties: organizationId: type: string example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: type: string example: Acme Trading generatedAt: type: string example: '2026-10-11T10:30:00.000Z' x-format: isoDate: true timeZone: type: string example: America/Chicago current: $ref: '#/components/schemas/Model225' previous: $ref: '#/components/schemas/previous' metrics: $ref: '#/components/schemas/metrics' Model225: type: object description: The last 7 days properties: from: type: string example: '2026-10-04T10:30:00.000Z' x-format: isoDate: true to: type: string example: '2026-10-11T10:30:00.000Z' x-format: isoDate: true previous: type: object description: The 7 days before properties: from: type: string example: '2026-09-27T10:30:00.000Z' x-format: isoDate: true to: type: string example: '2026-10-04T10:30:00.000Z' x-format: isoDate: true metrics: type: object description: '168 values per grid, Monday 00:00 first: index = day × 24 + hour' properties: accountsSold: $ref: '#/components/schemas/accountsSold' revenue: $ref: '#/components/schemas/Model230' paidOut: $ref: '#/components/schemas/paidOut' accountsSold: type: object properties: current: $ref: '#/components/schemas/Model226' previous: $ref: '#/components/schemas/Model227' Model230: type: object properties: current: $ref: '#/components/schemas/Model228' previous: $ref: '#/components/schemas/Model229' paidOut: type: object properties: current: $ref: '#/components/schemas/Model231' previous: $ref: '#/components/schemas/Model232' Model226: type: array x-constraint: length: 168 items: type: number Model227: type: array x-constraint: length: 168 items: type: number Model228: type: array x-constraint: length: 168 items: type: number Model229: type: array x-constraint: length: 168 items: type: number Model231: type: array x-constraint: length: 168 items: type: number Model232: type: array x-constraint: length: 168 items: type: number 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 - [Changelog](/changelog.md) - [Get daily billing activity](/platform-api/billing/get-daily-billing-activity.md) - [Get daily payout activity](/platform-api/payouts/get-daily-payout-activity.md) - [Get daily lockout activity](/platform-api/lockouts/get-daily-lockout-activity.md) - [Get daily webhook delivery activity](/platform-api/webhooks/get-daily-webhook-delivery-activity.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.