release

Get the details of a Runway release step

Returns the details for a release step, including a data field whose shape depends on the step archetype:

  • releaseCandidate: RC build info (status, integration IDs).
  • approvals: metadata/screenshots approval state via approvalItems.
  • takeoff: info about store release — submittedAt, startedReviewAt, approvedAt, markedRejectedAt, releasedAt, plus the precomputed waitingForReviewSeconds (queued before review started) and timeInReviewSeconds (under review).
  • regressionTesting: regressionItems and testRuns from the connected regression integration.
  • featureReadiness: work items tracked for the release, including project management ticket info and pull request / code review (PR / CR) info.
  • rollout: releaseAdoptionRate, phasedRelease (rollout percentage via userFraction, state, dayNumber, startDate), appStoreReviewData (average rating, total ratings count, surfaced user review issues), and monitoringStatistics (crash-free users, crash-free sessions, custom metrics — each with currentValue, delta, previousValue, monitoringMetricStatus).
  • Other archetypes: data may be null.

For apps on Flightpaths, stepId resolves to the release's step with that archetype. If the release has more than one step with that archetype (e.g. one per destination), the request fails with the matching step config IDs; use GET /app/{appId}/stepConfig/{stepConfigId}/release/{releaseId}/stepRun instead.

get/app/{appId}/release/{releaseId}/step/{stepId}

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/release/{releaseId}/step/{stepId}
  • Auth
    API key in header X-API-Key

Path parameters

releaseIdstring required

The id of the release. Constructed from the app's id and the release version like so: {appId}:{version}. For the GET single release endpoint, the following keywords are also accepted: live (latest completed release), next or current (current active release).

appIdstring required

The id of the app

stepIdstring required

The id of the release step

Response

A release step response

stepIdunknown
type'kickoff' | 'featureReadiness' | 'releaseCandidate' | 'regressionTesting' | 'betaTesting' | 'metadata' | 'screenshots' | 'approvals' | 'submission' | 'storeReview' | 'takeoff' | 'ciDistribution' required

The type of release step

displayNamestring required

The display name of the step

status'ready' | 'pending' | 'pendingChecklist' | 'blocked' | 'inactive' required

The status of a release step

statusReasonStringstring required

The user-friendly description of the reason for the status of the step

Example response

{
  "data": {
    "approvalItems": [
      {
        "title": "Gather new release notes",
        "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
        "oneOffForVersion": "1.1.0",
        "status": {
          "createdAt": "2022-03-02T01:15:00Z"
        }
      }
    ]
  },
  "checklistItems": [
    {
      "title": "Gather new release notes",
      "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
      "oneOffForVersion": "1.1.0",
      "status": {
        "createdAt": "2022-03-02T01:15:00Z"
      }
    }
  ]
}

Changes

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