Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hookdeck Metrics API

Query aggregated metrics for events, requests, and attempts — success counts, failure counts, response time, throughput, and SLA bands grouped by source, destination, or connection. Backs the dashboard analytics and downstream observability bridges.

Hookdeck Metrics API is one of 17 APIs that Hookdeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metrics, Observability, and Event Gateways. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.hookdeck.com/2025-07-01.

7 operations 7 paths 2 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hookdeck.com/2025-07-01
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Hookdeck Metrics API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Metrics 7

Query aggregated metrics for events, requests, and attempts with time-based grouping and filtering.

GET
/metrics/requests
Query request metrics
queryRequestMetrics 5 params → 200
GET
/metrics/events
Query event metrics
queryEventMetrics 5 params → 200
GET
/metrics/attempts
Query attempt metrics
queryAttemptMetrics 5 params → 200
GET
/metrics/events-by-issue
Query event metrics grouped by individual issue
queryEventsByIssueMetrics 5 params → 200
GET
/metrics/queue-depth
Query queue depth metrics
queryQueueDepthMetrics 5 params → 200
GET
/metrics/transformations
Query transformation execution metrics
queryTransformationMetrics 5 params → 200
GET
/metrics/events-pending-timeseries
Query events pending timeseries metrics
queryEventsPendingTimeseriesMetrics 5 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are MetricDataPoint (3 properties), MetricsResponse (2 properties). Each schema is shown below with its type and property counts.

MetricsResponse
object
Metrics query response with data and metadata
2 properties
MetricDataPoint
object
A single metric data point with time bucket, dimensions, and metrics
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hookdeck-metrics-api-openapi.yml Raw ↑

Other APIs Hookdeck publishes across the network.

Hookdeck Connections API
Hookdeck Sources API
Hookdeck Destinations API
Hookdeck Events API
Hookdeck Requests API
Hookdeck Transformations API
Hookdeck Bookmarks API
Hookdeck Issues API
Hookdeck Integrations API
Hookdeck Notifications API
Hookdeck Attempts API
Hookdeck Bulk cancel events API