Skip to main content

Record a deployment

DORA metrics are computed from the deployment and incident events you send. Post a release from your CI/CD pipeline whenever you ship, and GitKraken uses it to calculate deployment frequency, lead time, and more.

Assumes you already have a GitKraken API key — if not, see Authentication.

Post a release​

POST /v1/insights/releases. Only repo is required; provide a timestamp via releasedAt, releaseSha, or releaseNow:

curl -X POST "https://staging-api.gitkraken.dev/v1/insights/releases" \
  -H "Authorization: Bearer $GK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "repo": "gitkraken/gitlens",
    "name": "v1.2.3",
    "releaseNow": true,
    "issueKeysResolved": ["PROJ-123", "PROJ-456"]
  }'

Useful fields:

  • repo (required) — owner/repo.
  • name — release identifier, e.g. a version tag.
  • releasedAt — ISO 8601 (2025-03-21T22:50:03Z) or epoch seconds as a string. Use instead of releaseNow for backfilled releases.
  • releaseNow — mark the release as happening at the time of the call.
  • releaseSha — commit SHA; its authorship time is used if releasedAt is omitted.
  • issueKeysResolved — issue keys shipped in this release (feeds lead time).

List recorded releases​

curl "https://staging-api.gitkraken.dev/v1/insights/releases?repo=gitkraken/gitlens" \
  -H "Authorization: Bearer $GK_TOKEN"

Record an incident​

To feed change failure rate and time-to-restore, post critical defects as they occur:

curl -X POST "https://staging-api.gitkraken.dev/v1/insights/critical-defects" \
  -H "Authorization: Bearer $GK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "repo": "gitkraken/gitlens" }'

See the API Reference for the full request schemas, then build a DORA report from the data you've sent.