Insights deployments (beta)

Get deployment

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Get a deployment by ID.

The deployment ID is returned as part of the List deployments response. It is the id field of each element in the items array.

Expanding the deployment response

LaunchDarkly supports expanding the deployment response to include additional fields.

To expand the response, append the expand query parameter and include the following:

pullRequests includes details on all of the pull requests associated with each deployment
flagReferences includes details on all of the references to flags in each deployment

For example, use ?expand=pullRequests to include the pullRequests field in the response. By default, this field is not included in the response.

GET

api

engineering-insights

deployments

{deploymentID}

Get deployment

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "applicationKey": "billing-service",
  "applicationVersion": "a90a8a2",
  "startedAt": "1706701522000",
  "status": "finished",
  "kind": "redeployment",
  "active": true,
  "archived": false,
  "environmentKey": "production",
  "numberOfContributors": 1,
  "numberOfPullRequests": 2,
  "linesAdded": 100,
  "linesDeleted": 50,
  "leadTime": 20237000,
  "endedAt": "1706712518000",
  "durationMs": 10996000,
  "metadata": {
    "buildNumber": "1234"
  },
  "pullRequests": {
    "totalCount": 25,
    "items": [
      {
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "externalId": "1234",
        "title": "Enable new payment structure",
        "status": "merged",
        "author": "jane.doe",
        "createTime": "1706701522000",
        "baseCommitKey": "a90a8a2",
        "headCommitKey": "a90a8a2",
        "filesChanged": 2,
        "linesAdded": 100,
        "linesDeleted": 50,
        "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
        "mergeTime": "1706712518000",
        "mergeCommitKey": "a90a8a2",
        "deployments": {
          "totalCount": 25,
          "items": "<array>",
          "_links": {
            "next": {
              "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/engineering-insights/deployments",
              "type": "application/json"
            }
          }
        },
        "flagReferences": {
          "totalCount": 25,
          "items": [
            {
              "projectKey": "default",
              "flagKey": "enable-new-payment-structure",
              "referencesAdded": 2,
              "referencesRemoved": 5
            }
          ]
        },
        "leadTime": {
          "codingDurationMs": 1000000,
          "reviewDurationMs": 500000,
          "maxWaitDurationMs": 100000,
          "avgWaitDurationMs": 100000,
          "maxDeployDurationMs": 100000,
          "avgDeployDurationMs": 100000,
          "maxTotalLeadTimeMs": 1600000,
          "avgTotalLeadTimeMs": 1600000
        }
      }
    ],
    "_links": {
      "next": {
        "href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
        "type": "application/json"
      },
      "self": {
        "href": "/api/v2/engineering-insights/pull-requests",
        "type": "application/json"
      }
    }
  },
  "flagReferences": {
    "totalCount": 25,
    "items": [
      {
        "projectKey": "default",
        "flagKey": "enable-new-payment-structure",
        "referencesAdded": 2,
        "referencesRemoved": 5
      }
    ]
  },
  "leadTimeStages": {
    "codingDurationMs": 1000000,
    "reviewDurationMs": 500000,
    "waitDurationMs": 100000,
    "deployDurationMs": 100000,
    "totalLeadTimeMs": 1600000
  }
}

{
  "code": "invalid_request",
  "message": "validation failed",
  "errors": [
    {
      "attribute": "projectKey",
      "reason": "must be present"
    }
  ]
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Path Parameters

deploymentID

string<string>

required

The deployment ID

Query Parameters

expand

string<string>

Expand properties in response. Options: pullRequests, flagReferences

Response

Deployment response

string<uuid>

required

The deployment ID

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

applicationKey

string

required

The application key

Example:

"billing-service"

applicationVersion

string

required

The application version

Example:

"a90a8a2"

startedAt

integer<int64>

required

The time the deployment started

Example:

"1706701522000"

status

string

required

The status of the deployment

Example:

"finished"

kind

string

required

The kind of deployment

Example:

"redeployment"

active

boolean

required

Whether the deployment is active

Example:

true

archived

boolean

required

Whether the deployment is archived

Example:

false

environmentKey

string

required

The environment key

Example:

"production"

numberOfContributors

integer

required

The number of contributors

Example:

1

numberOfPullRequests

integer

required

The number of pull requests

Example:

2

linesAdded

integer<int64>

required

The number of lines added

Example:

100

linesDeleted

integer<int64>

required

The number of lines deleted

Example:

50

leadTime

integer<int64>

required

The total lead time from first commit to deployment end in milliseconds

Example:

20237000

endedAt

integer<int64>

The time the deployment ended

Example:

"1706712518000"

durationMs

integer<int64>

The duration of the deployment in milliseconds

Example:

10996000

metadata

object

The metadata associated with the deployment

Show child attributes

Example:

{ "buildNumber": "1234" }

pullRequests

object

The pull requests contained in the deployment

Show child attributes

flagReferences

object

The flag references contained in the deployment

Show child attributes

leadTimeStages

object

The lead time stages for the deployment

Show child attributes

⌘I

Get deployment

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/engineering-insights/deployments/{deploymentID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "applicationKey": "billing-service",
  "applicationVersion": "a90a8a2",
  "startedAt": "1706701522000",
  "status": "finished",
  "kind": "redeployment",
  "active": true,
  "archived": false,
  "environmentKey": "production",
  "numberOfContributors": 1,
  "numberOfPullRequests": 2,
  "linesAdded": 100,
  "linesDeleted": 50,
  "leadTime": 20237000,
  "endedAt": "1706712518000",
  "durationMs": 10996000,
  "metadata": {
    "buildNumber": "1234"
  },
  "pullRequests": {
    "totalCount": 25,
    "items": [
      {
        "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
        "externalId": "1234",
        "title": "Enable new payment structure",
        "status": "merged",
        "author": "jane.doe",
        "createTime": "1706701522000",
        "baseCommitKey": "a90a8a2",
        "headCommitKey": "a90a8a2",
        "filesChanged": 2,
        "linesAdded": 100,
        "linesDeleted": 50,
        "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
        "mergeTime": "1706712518000",
        "mergeCommitKey": "a90a8a2",
        "deployments": {
          "totalCount": 25,
          "items": "<array>",
          "_links": {
            "next": {
              "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/engineering-insights/deployments",
              "type": "application/json"
            }
          }
        },
        "flagReferences": {
          "totalCount": 25,
          "items": [
            {
              "projectKey": "default",
              "flagKey": "enable-new-payment-structure",
              "referencesAdded": 2,
              "referencesRemoved": 5
            }
          ]
        },
        "leadTime": {
          "codingDurationMs": 1000000,
          "reviewDurationMs": 500000,
          "maxWaitDurationMs": 100000,
          "avgWaitDurationMs": 100000,
          "maxDeployDurationMs": 100000,
          "avgDeployDurationMs": 100000,
          "maxTotalLeadTimeMs": 1600000,
          "avgTotalLeadTimeMs": 1600000
        }
      }
    ],
    "_links": {
      "next": {
        "href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
        "type": "application/json"
      },
      "self": {
        "href": "/api/v2/engineering-insights/pull-requests",
        "type": "application/json"
      }
    }
  },
  "flagReferences": {
    "totalCount": 25,
    "items": [
      {
        "projectKey": "default",
        "flagKey": "enable-new-payment-structure",
        "referencesAdded": 2,
        "referencesRemoved": 5
      }
    ]
  },
  "leadTimeStages": {
    "codingDurationMs": 1000000,
    "reviewDurationMs": 500000,
    "waitDurationMs": 100000,
    "deployDurationMs": 100000,
    "totalLeadTimeMs": 1600000
  }
}

{
  "code": "invalid_request",
  "message": "validation failed",
  "errors": [
    {
      "attribute": "projectKey",
      "reason": "must be present"
    }
  ]
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}