OverviewInsights pull requests (beta)

List 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.

Headers

AuthorizationstringRequired

Query parameters

projectKeystringRequired
The project key
environmentKeystringOptional

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

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

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

querystringOptional
Filter list of pull requests by title or author
limitlongOptional
The number of pull requests to return. Default is 20. Maximum allowed is 100.
expandstringOptional

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

sortstringOptional

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.
afterstringOptional
Identifier used for pagination
beforestringOptional
Identifier used for pagination

Response

Pull request collection response
totalCountinteger
The total number of pull requests
itemslist of objects
A list of pull requests

Errors