> ## 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 webhook endpoint delivery and latency metrics

> Returns daily performance telemetry for one webhook endpoint:

- delivered vs errors (failed + currently retrying) and pending counts
- average and p95 endpoint response time in milliseconds
- overall success rate and latency summary for the selected range

Use this to power endpoint observability dashboards and identify reliability or
latency regressions without downloading the full delivery history.

**Example:**
```http
GET /platform/v1/organization/webhooks/d2f3a1c0-8e7b-4f6a-9c5d-1234567890ab/metrics?startDate=2026-07-01&endDate=2026-07-31
X-API-Key: hp_live_...
```

Date buckets are UTC and the entire `endDate` day is included.

**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/webhooks/{webhookId}/metrics
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/webhooks/{webhookId}/metrics:
    get:
      tags:
        - Webhooks
      summary: Get webhook endpoint delivery and latency metrics
      description: >-
        Returns daily performance telemetry for one webhook endpoint:


        - delivered vs errors (failed + currently retrying) and pending counts

        - average and p95 endpoint response time in milliseconds

        - overall success rate and latency summary for the selected range


        Use this to power endpoint observability dashboards and identify
        reliability or

        latency regressions without downloading the full delivery history.


        **Example:**

        ```http

        GET
        /platform/v1/organization/webhooks/d2f3a1c0-8e7b-4f6a-9c5d-1234567890ab/metrics?startDate=2026-07-01&endDate=2026-07-31

        X-API-Key: hp_live_...

        ```


        Date buckets are UTC and the entire `endDate` day is included.


        **Permissions:** requires **view** access to "Webhooks".


        **Authentication:** send your organization API key in the `X-API-Key`
        header.
      operationId: getV1OrganizationWebhooksWebhookidMetrics
      parameters:
        - description: Webhook ID
          x-format:
            guid: true
          name: webhookId
          in: path
          required: true
          schema:
            type: string
        - x-format:
            isoDate: true
          name: startDate
          in: query
          required: false
          schema:
            type: string
        - x-format:
            isoDate: true
          name: endDate
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Daily endpoint delivery and response-time metrics
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model442'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '403':
          description: Access denied
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model47'
        '404':
          description: Webhook not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model368'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model442:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model441'
    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
    Model368:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Webhook not found
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: NOT_FOUND
    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
    Model441:
      type: object
      properties:
        generatedAt:
          type: string
          x-format:
            isoDate: true
        webhook:
          $ref: '#/components/schemas/Model164'
        filters:
          $ref: '#/components/schemas/Model437'
        activity:
          $ref: '#/components/schemas/Model439'
        summary:
          $ref: '#/components/schemas/Model440'
    Model164:
      type: object
      properties:
        id:
          type: string
          description: Unique webhook ID
          example: d2f3a1c0-8e7b-4f6a-9c5d-1234567890ab
          x-format:
            guid: true
        url:
          type: string
          description: Endpoint URL that receives webhook POSTs
          example: https://your-server.com/webhooks/hyperprop
          x-format:
            uri: true
        events:
          $ref: '#/components/schemas/Model163'
        description:
          type: string
          description: Optional label to identify this webhook
          example: Production webhook
        isActive:
          type: boolean
          description: >-
            Whether the webhook is currently active. Disabled webhooks receive
            no events.
          example: true
        failureCount:
          type: number
          description: >-
            Consecutive delivery failures. Resets to 0 on any successful
            delivery or re-enable. Auto-disables at 25.
          example: 0
        disabledAt:
          type: string
          description: Timestamp when the webhook was auto-disabled, if applicable.
          example: '2026-03-28T22:00:00.000Z'
        disabledReason:
          type: string
          description: Reason the webhook was disabled, if applicable.
          example: Auto-disabled after 25 consecutive delivery failures
        lastTriggeredAt:
          type: string
          description: Timestamp of the last delivery attempt
          example: '2026-03-28T21:30:00.000Z'
        createdAt:
          type: string
          example: '2026-03-28T21:00:00.000Z'
        updatedAt:
          type: string
          example: '2026-03-28T21:30:00.000Z'
    Model437:
      type: object
      properties:
        startDate:
          type: string
        endDate:
          type: string
    Model439:
      type: array
      items:
        $ref: '#/components/schemas/Model438'
    Model440:
      type: object
      properties:
        total:
          type: integer
          example: 320
        delivered:
          type: integer
          example: 309
        errors:
          type: integer
          example: 11
        successRate:
          type: number
          example: 96.56
        avgResponseTime:
          type: number
          example: 214
        p95ResponseTime:
          type: number
          example: 690
    Model163:
      type: array
      description: Event types this webhook subscribes to. Use ["*"] for all.
      example:
        - account.created
        - account.status_changed
      items:
        type: string
    Model438:
      type: object
      properties:
        date:
          type: string
          example: '2026-07-21'
        delivered:
          type: integer
          example: 42
        errors:
          type: integer
          example: 3
        pending:
          type: integer
          example: 0
        total:
          type: integer
          example: 45
        avgResponseTime:
          type: number
          example: 245
        p95ResponseTime:
          type: number
          example: 730
  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 integration health (alerts, errors, insights)](/platform-api/logs-and-health/get-integration-health-alerts-errors-insights.md)
- [Inspect a webhook event and all delivery attempts](/platform-api/webhooks/inspect-a-webhook-event-and-all-delivery-attempts.md)
- [Redeliver a webhook delivery](/platform-api/webhooks/redeliver-a-webhook-delivery.md)
- [Send a test event](/platform-api/webhooks/send-a-test-event.md)
- [View webhook delivery history](/platform-api/webhooks/view-webhook-delivery-history.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.