LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Insights pull requests (beta)

List pull requests

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

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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Query Parameters

projectKey*string

The project key

Formatstring
environmentKey?string

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

Formatstring
applicationKey?string

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

Formatstring
status?string

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

Formatstring
query?string

Filter list of pull requests by title or author

Formatstring
limit?integer

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

Formatint64
expand?string

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

Formatstring
sort?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.

Formatstring
from?string

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

Formatdate-time
to?string

Unix timestamp in milliseconds. Default value is now.

Formatdate-time
after?string

Identifier used for pagination

Formatstring
before?string

Identifier used for pagination

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/engineering-insights/pull-requests?projectKey=string"
{  "totalCount": 25,  "items": [    {      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",      "externalId": "1234",      "title": "Enable new payment structure",      "status": "merged",      "author": "jane.doe",      "createTime": "1706701522000",      "mergeTime": "1706712518000",      "mergeCommitKey": "a90a8a2",      "baseCommitKey": "a90a8a2",      "headCommitKey": "a90a8a2",      "filesChanged": 2,      "linesAdded": 100,      "linesDeleted": 50,      "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",      "deployments": {},      "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 insight scores GET

Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views.

List repositories GET

Get a list of repositories ### Expanding the repository collection response LaunchDarkly supports expanding the repository collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `projects` includes details on all of the LaunchDarkly projects associated with each repository For example, use `?expand=projects` to include the `projects` field in the response. By default, this field is **not** included in the response.