RUrunway
org

Get organization metrics

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.

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

Path parameters

orgIdstring required

The ID of the org.

Query parameters

startDatestring date required
Example:2026-01-01

Start of the date range (inclusive), in YYYY-MM-DD format. Interpreted as UTC.

endDatestring date required
Example:2026-01-31

End of the date range (inclusive), in YYYY-MM-DD format. Interpreted as UTC.

metricTypesstring[]

Comma-separated list of metric types to include in the response. If omitted, all available metrics are returned. Custom org-defined health metrics (prefixed with OBAA:, configured under App settings → Health metrics) are also accepted but are not enumerated here.

[
  "CIBuildsCount",
  "ReleaseDuration"
]
includeDataPointsboolean

If true, include the underlying time-series data points for each metric. Defaults to false.

Response

Aggregated metrics for an organization over the requested date range

Example response

{
  "metrics": [
    {
      "type": "CommitCount",
      "category": "work",
      "displayText": "Number of commits (non-hotfixes)",
      "description": "Chart: Total number of commits included in the given release. Releases are only included if completion date falls within the specified date range.\n\nPrimary value: Average over the selected date range.\n\nExclusions: Hotfix releases.",
      "unit": "count",
      "value": 17,
      "benchmarkValue": null,
      "trend": -28,
      "trendStatus": "trendNeutral",
      "dataPoints": [
        {
          "timestamp": "2025-01-13",
          "appId": "tab",
          "releaseId": "3.122.0",
          "bucketId": null,
          "destinationId": "dest-cvrc6af0osdacavf54og",
          "destinationName": null,
          "platform": null,
          "value": 31,
          "valuesByUser": null
        },
        {
          "timestamp": "2025-02-27",
          "appId": "tab",
          "releaseId": "3.124.0",
          "bucketId": null,
          "destinationId": "dest-cvrc6af0osdacavf54og",
          "destinationName": null,
          "platform": null,
          "value": 3,
          "valuesByUser": null
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.