List pull requests

GET

/api/v2/engineering-insights/pull-requests

GET

/api/v2/engineering-insights/pull-requests

curl -G https://app.launchdarkly.com/api/v2/engineering-insights/pull-requests \
     -H "Authorization: <apiKey>" \
     -d projectKey=projectKey

{
  "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": [
          {
            "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": [
                null
              ],
              "_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
            }
          }
        ],
        "_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"
    }
  }
}

Get a list of pull requests

Expanding the pull request collection response

LaunchDarkly supports expanding the pull request collection response to include additional fields.

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

deployments includes details on all of the deployments associated with each pull request
flagReferences includes details on all of the references to flags in each pull request
leadTime includes details about the lead time of the pull request for each stage

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

Get a list of pull requests ### Expanding the pull request collection response LaunchDarkly supports expanding the pull request collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `deployments` includes details on all of the deployments associated with each pull request * `flagReferences` includes details on all of the references to flags in each pull request * `leadTime` includes details about the lead time of the pull request for each stage For example, use `?expand=deployments` to include the `deployments` field in the response. By default, this field is **not** included in the response.

Authentication

Authorizationstring

API Key authentication via header

Query parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringOptionalformat: "string"

Required if you are using the sort parameter’s leadTime option to sort pull requests.

applicationKeystringOptionalformat: "string"

Filter the results to pull requests deployed to a comma separated list of applications

statusstringOptionalformat: "string"

Filter results to pull requests with the given status. Options: open, merged, closed, deployed.

querystringOptionalformat: "string"

Filter list of pull requests by title or author

limitlongOptional

The number of pull requests to return. Default is 20. Maximum allowed is 100.

expandstringOptionalformat: "string"

Expand properties in response. Options: deployments, flagReferences, leadTime.

sortstringOptionalformat: "string"

Sort results. Requires the environmentKey to be set. Options: leadTime (asc) and -leadTime (desc). When query option is excluded, default sort is by created or merged date.

fromdatetimeOptional

Unix timestamp in milliseconds. Default value is 7 days ago.

todatetimeOptional

Unix timestamp in milliseconds. Default value is now.

afterstringOptionalformat: "string"

Identifier used for pagination

beforestringOptionalformat: "string"

Identifier used for pagination

Response

Pull request collection response

totalCountinteger

The total number of pull requests

itemslist of objects

A list of pull requests

_linksmap from strings to objectsOptional

The location and content type of related resources

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error