How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Prefect Metrics API

The Metrics API from Prefect — 6 operation(s) for metrics.

Prefect Metrics API is one of 63 APIs that Prefect publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and an AsyncAPI specification.

This API exposes 6 operations across 6 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

6 operations 6 paths 24 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.8.4
Resource Areas
1

Paths & Operations 6

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

Metrics 6
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/metrics/prefect/{metric}/timeseries
Read Prefect Metric Timeseries
read_prefect_metric_timeseries_api_accounts__account_id__workspaces__workspace_id__ui_metrics_prefect__metric__timeseries_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/metrics/prefect/{metric}
Read Prefect Metric Timeseries
read_prefect_metric_timeseries_api_accounts__account_id__workspaces__workspace_id__ui_metrics_prefect__metric__post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/metrics/prefect/{metric}/grouped
Read Prefect Metric Grouped
read_prefect_metric_grouped_api_accounts__account_id__workspaces__workspace_id__ui_metrics_prefect__metric__grouped_post 3 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/metrics/flow-runs/{flow_run_id}
Read Flow Run Resource Metrics
read_flow_run_resource_metrics_api_accounts__account_id__workspaces__workspace_id__metrics_flow_runs__flow_run_id__get 7 params → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/metrics/deployments/{deployment_id}/resource-peaks
Read Deployment Resource Peaks Endpoint
read_deployment_resource_peaks_endpoint_api_accounts__account_id__workspaces__workspace_id__metrics_deployments__deployment_id__resource_peaks_get 6 params → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/metrics/flow-runs/{flow_run_id}/names
List Available Flow Run Metrics
list_available_flow_run_metrics_api_accounts__account_id__workspaces__workspace_id__metrics_flow_runs__flow_run_id__names_get 4 params → 200422

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are GroupedMetricQuery-Output (8 properties), GroupedMetricQuery-Input (8 properties), TimeseriesMetricQuery-Output (7 properties), TimeseriesMetricQuery-Input (7 properties). Each schema is shown below with its type and property counts.

CountIf
object
3 properties 1 required
ResourceSpecification
object
A specification that may match zero, one, or many resources, used to target or select a set of resources in a query or automation. A resource must match at lea…
Maximum
object
1 property
TimeseriesMetricResponse
object
4 properties 4 required
DeploymentResourcePeaksResponse
object
1 property 1 required
Ratio
object
3 properties 2 required
Minimum
object
1 property
Quantile
object
2 properties 1 required
TimeseriesMetricQuery-Output
object
7 properties 3 required
Sum
object
1 property
GroupedMetricQuery-Input
object
8 properties 3 required
Count
object
1 property
GroupedMetricResponse
object
3 properties 3 required
GroupedMetricQuery-Output
object
8 properties 3 required
RelatedResource
object
A Resource with a specific role in an Event
Mean
object
1 property
ResourcePeak
object
4 properties 4 required
PrefectMetric
string
HTTPValidationError
object
1 property
TimeseriesMetricQuery-Input
object
7 properties 3 required
StandardDeviation
object
1 property
Ordering
object
2 properties 1 required
MapAggregate
object
For aggregating over a value in a map column.
3 properties 2 required
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-metrics-api-openapi.yml Raw ↑

Other APIs Prefect publishes across the network.

Prefect Server REST API
Prefect Python SDK
Prefect Account Billing API
Prefect Account Images API
Prefect Account Memberships API
Prefect Account Roles API
Prefect Account SSO API
Prefect Accounts API
Prefect AI API
Prefect Artifacts API
Prefect Asset Publications API
Prefect Asset Subscriptions API
Where this information came from

This is an independent, third-party profile of Prefect Metrics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.