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.

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

_linksmap from strings to objectsOptional

The location and content type of related resources

Errors

GET

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

200Retrieved

1 {
2   "totalCount": 25,
3   "items": [
4     {
5       "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
6       "externalId": "1234",
7       "title": "Enable new payment structure",
8       "status": "merged",
9       "author": "jane.doe",
10       "createTime": 1000000,
11       "baseCommitKey": "a90a8a2",
12       "headCommitKey": "a90a8a2",
13       "filesChanged": 2,
14       "linesAdded": 100,
15       "linesDeleted": 50,
16       "url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
17       "mergeTime": 1000000,
18       "mergeCommitKey": "a90a8a2",
19       "deployments": {
20         "totalCount": 25,
21         "items": [
22           {
23             "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
24             "applicationKey": "billing-service",
25             "applicationVersion": "a90a8a2",
26             "startedAt": 1000000,
27             "status": "status",
28             "kind": "kind",
29             "active": true,
30             "archived": false,
31             "environmentKey": "production",
32             "numberOfContributors": 1,
33             "numberOfPullRequests": 2,
34             "linesAdded": 100,
35             "linesDeleted": 50,
36             "leadTime": 20237000,
37             "durationMs": 10996000,
38             "metadata": {
39               "buildNumber": "1234"
40             },
41             "flagReferences": {
42               "totalCount": 25,
43               "items": [
44                 {
45                   "projectKey": "default",
46                   "flagKey": "enable-new-payment-structure",
47                   "referencesAdded": 2,
48                   "referencesRemoved": 5
49                 }
50               ]
51             },
52             "leadTimeStages": {
53               "codingDurationMs": 1000000,
54               "reviewDurationMs": 500000,
55               "waitDurationMs": 100000,
56               "deployDurationMs": 100000,
57               "totalLeadTimeMs": 1600000
58             }
59           }
60         ],
61         "_links": {
62           "next": {
63             "href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
64             "type": "application/json"
65           },
66           "self": {
67             "href": "/api/v2/engineering-insights/deployments",
68             "type": "application/json"
69           }
70         }
71       },
72       "flagReferences": {
73         "totalCount": 25,
74         "items": [
75           {
76             "projectKey": "default",
77             "flagKey": "enable-new-payment-structure",
78             "referencesAdded": 2,
79             "referencesRemoved": 5
80           }
81         ]
82       },
83       "leadTime": {
84         "codingDurationMs": 1000000,
85         "reviewDurationMs": 500000,
86         "maxWaitDurationMs": 100000,
87         "avgWaitDurationMs": 100000,
88         "maxDeployDurationMs": 100000,
89         "avgDeployDurationMs": 100000,
90         "maxTotalLeadTimeMs": 1600000,
91         "avgTotalLeadTimeMs": 1600000
92       }
93     }
94   ],
95   "_links": {
96     "next": {
97       "href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
98       "type": "application/json"
99     },
100     "self": {
101       "href": "/api/v2/engineering-insights/pull-requests",
102       "type": "application/json"
103     }
104   }
105 }

Insights repositories (beta)

Up Next

Built with

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

1	{
2	"totalCount": 25,
3	"items": [
4	{
5	"id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
6	"externalId": "1234",
7	"title": "Enable new payment structure",
8	"status": "merged",
9	"author": "jane.doe",
10	"createTime": 1000000,
11	"baseCommitKey": "a90a8a2",
12	"headCommitKey": "a90a8a2",
13	"filesChanged": 2,
14	"linesAdded": 100,
15	"linesDeleted": 50,
16	"url": "https://github.com/launchdarkly/LaunchDarkly-Docs/pull/406",
17	"mergeTime": 1000000,
18	"mergeCommitKey": "a90a8a2",
19	"deployments": {
20	"totalCount": 25,
21	"items": [
22	{
23	"id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
24	"applicationKey": "billing-service",
25	"applicationVersion": "a90a8a2",
26	"startedAt": 1000000,
27	"status": "status",
28	"kind": "kind",
29	"active": true,
30	"archived": false,
31	"environmentKey": "production",
32	"numberOfContributors": 1,
33	"numberOfPullRequests": 2,
34	"linesAdded": 100,
35	"linesDeleted": 50,
36	"leadTime": 20237000,
37	"durationMs": 10996000,
38	"metadata": {
39	"buildNumber": "1234"
40	},
41	"flagReferences": {
42	"totalCount": 25,
43	"items": [
44	{
45	"projectKey": "default",
46	"flagKey": "enable-new-payment-structure",
47	"referencesAdded": 2,
48	"referencesRemoved": 5
49	}
50	]
51	},
52	"leadTimeStages": {
53	"codingDurationMs": 1000000,
54	"reviewDurationMs": 500000,
55	"waitDurationMs": 100000,
56	"deployDurationMs": 100000,
57	"totalLeadTimeMs": 1600000
58	}
59	}
60	],
61	"_links": {
62	"next": {
63	"href": "/api/v2/engineering-insights/deployments?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
64	"type": "application/json"
65	},
66	"self": {
67	"href": "/api/v2/engineering-insights/deployments",
68	"type": "application/json"
69	}
70	}
71	},
72	"flagReferences": {
73	"totalCount": 25,
74	"items": [
75	{
76	"projectKey": "default",
77	"flagKey": "enable-new-payment-structure",
78	"referencesAdded": 2,
79	"referencesRemoved": 5
80	}
81	]
82	},
83	"leadTime": {
84	"codingDurationMs": 1000000,
85	"reviewDurationMs": 500000,
86	"maxWaitDurationMs": 100000,
87	"avgWaitDurationMs": 100000,
88	"maxDeployDurationMs": 100000,
89	"avgDeployDurationMs": 100000,
90	"maxTotalLeadTimeMs": 1600000,
91	"avgTotalLeadTimeMs": 1600000
92	}
93	}
94	],
95	"_links": {
96	"next": {
97	"href": "/api/v2/engineering-insights/pull-requests?after=a4290006-1fd1-4ca5-acf7-9f31fac61cf5",
98	"type": "application/json"
99	},
100	"self": {
101	"href": "/api/v2/engineering-insights/pull-requests",
102	"type": "application/json"
103	}
104	}
105	}