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

Xata Metrics API

Operations for retrieving observability metrics for a branch

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

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

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.xata.tech.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.xata.tech
Authentication
OpenID Connect, API Key, OAuth 2.0, API Key
Contact
help@xata.io
Resource Areas
1

Authentication & Security 4

Xata Metrics API declares 4 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.xata.io/realms/xata/.well-known/openid-configuration. An API key is passed in the header as Authorization (apiKey). It supports OAuth 2.0 (xata) using the implicit flow, exposing 13 scopes. An API key is passed in the header as Connection-String (branchConnectionString).

  • apiKey — API key authentication using Bearer token format: Bearer
  • branchConnectionString — Branch PostgreSQL connection string (postgres://user:pass@{branch}.{region}.xata.tech/db), including the embedded password. The hostname selects the target bra…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Metrics 1

Operations for retrieving observability metrics for a branch

POST
/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/metrics
Retrieve branch metrics
branchMetrics 3 params body → 2004004014045XXdefault

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are BranchMetricsRequest (5 properties), BranchMetrics (3 properties), MetricSeries (3 properties), BranchMetricResult (3 properties). Each schema is shown below with its type and property counts.

BranchMetricResult
object
Time-series for a single metric.
3 properties 3 required
BranchMetricName
string
Name of a branch metric exposed by the API.
MetricSeries
object
The metric series
3 properties 3 required
OrganizationID
string
BranchMetricsRequest
object
5 properties 4 required
BranchMetrics
object
A collection of metrics (cpu, memory, disk,...) for each of the instances of a branch
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xata-metrics-api-openapi.yml Raw ↑

Other APIs Xata publishes across the network.

Xata API Keys API
Xata Billing API
Xata Branches API
Xata Gateway API
Xata GitHub App API
Xata Logs API
Xata Marketplace API
Xata Organizations API
Xata Projects API
Xata Projects Webhooks API
Xata Webhooks API
Where this information came from

This is an independent, third-party profile of Xata 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.