---
title: "Get organization metrics"
method: GET
path: "/org/{orgId}/metrics"
tags: ["org"]
---

# Get organization metrics

`GET /org/{orgId}/metrics`

## Request

- Base URL: `https://api.runway.team`
- URL: `https://api.runway.team/org/{orgId}/metrics`
- Auth: API key in header `X-API-Key`

Returns aggregated metrics for the organization over the given date range. Optionally restrict the response to specific metric types or include the underlying time-series data points.

## Path parameters

- `orgId` string, required

## Query parameters

- `startDate` string, date, required
- `endDate` string, date, required
- `metricTypes` string[]
- `includeDataPoints` boolean

## Response `200`

Aggregated metrics for an organization over the requested date range

- OrgMetricsEntity
  - `metrics` OrgMetricEntity[], required
    - `type` string, required: Identifier of the metric (e.g. `CommitCount`, `ReleaseDuration`). Pass these as `metricTypes` to filter the response.
    - `category` 'work' | 'build' | 'stabilityAndHealth' | 'devOps' | 'runwayMetric', required: Grouping category for the metric.
    - `displayText` string, required: Human-readable name of the metric.
    - `description` string, required: Human-readable description of what the metric measures. Includes chart, primary value, and exclusions where applicable.
    - `unit` 'count' | 'seconds' | 'percent' | 'moneyCents' | 'megabytes' | 'rating' | 'days', required: Unit of the metric's value.
    - `value` unknown, required
    - `benchmarkValue` number, double, nullable: Benchmark value to compare against, if available for this metric.
    - `trend` unknown
    - `trendStatus` 'trendGood' | 'trendBad' | 'trendNeutral', required: Qualitative status of the metric's trend.
    - `dataPoints` object[]: Per-release data points underlying the aggregated value. Only included when `includeDataPoints=true` is passed.
      - `timestamp` string, date: The date the data point is anchored to (typically the release completion date).
      - `appId` string, nullable
      - `releaseId` string, nullable: The release version this data point belongs to.
      - `bucketId` string, nullable
      - `destinationId` string, nullable
      - `destinationName` string, nullable
      - `platform` string, nullable
      - `value` unknown
      - `valuesByUser` unknown

## Other responses

- `400`: Bad request response
- `404`: Resource not found response

---

[API](https://skmtc.dev/runway/apis/runway-rest-api.md) - [All operations](https://skmtc.dev/runway/apis/runway-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runway/apis/runway-rest-api/revisions/081109863a9a?raw)