nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Require API's to list PR's, name of approved PR, count LOC of branch based on month

sreekanth.c

I'm trying fetch below details using bitbucket API's.

- list of all repo’s in a project

- list all type of pull requests(OPEN,MERGED) with status, if its merged who has merged

tried- https://api.bitbucket.org/2.0/repositories/turvobitbucket/accounts/pullrequests

Above API call only fetches OPEN PR's

- No. of lines of code added on the branch(ex:master)

tried:
git log --since="3 month ago" --pretty=tformat: --numstat | awk '{ add += $1; subs += $2 } END { printf "Lines added: %s\nLines deleted: %s\n", add, subs }'

in the same way we need BBC API's

Above queries required on monthly basis.

Accepted answers

All comments

Patrik S

Hello @sreekanth.c ,

Welcome to Atlassian Community!

Let me share the relevant Bitbucket Cloud API endpoints along with some examples for the use cases you have described :

List of all repo’s in a project

We have an endpoint to list all the repositories within a workspace, which can be queried for the project name of the key. Following an example listing all the repositories that are within a project named "my_project"

https://api.bitbucket.org/2.0/repositories/<workspace>?q=project.name="my_project"

You also have the option to query by the project key :

https://api.bitbucket.org/2.0/repositories/<workspace>?q=project.key="ABC"

List all the Pull Request regardless of the current state (OPEN, MERGED, DECLINED, etc)

By default, the List Pull requests endpoint will indeed just return the Pull requests that are in OPEN state.

You can add the state=ALL query in the API URL to return all the Pull Requests in a repository, like in the example below :

https://api.bitbucket.org/2.0/repositories/<workspace>/<repository>/pullrequests?state=ALL

For Pull Requests in the Merged state, you can check the closed_by field in the response of the API for details of the user who merged the Pull request.

No. of lines of code added on the branch

I'm afraid that currently Bitbucket Cloud does not track this information and there's no API endpoint currently available to fetch this data. In this case, the git command you shared would need to be executed in a local clone of the repository.

For more details about the aforementioned API endpoints, and all the other available endpoints you can refer to Bitbucket Cloud API reference documentation.

Thank you, @sreekanth.c !

Patrik S

sreekanth.c

Thank you Patrik S for quick response.

please respond if possible

1. from below api I'm unable to fetch all the repo's from project. fetching only few repo's.

https://api.bitbucket.org/2.0/repositories/<workspace>?q=project.name="my_project"

2. Is there any API to get the information about merged PR who all are approved.

sreekanth.c

Thank you Patrik S for quick response.

please respond if possible

1. from below api I'm unable to fetch all the repo's from project. fetching only few repo's.

https://api.bitbucket.org/2.0/repositories/<workspace>?q=project.name="my_project"

2. Is there any API to get the information about merged PR who all are approved.

Patrik S

Hello @sreekanth.c ,

You're very welcome!

In regards to your follow-up questions :

1. The Bitbucket API responses are paginated (learn more in BB API Pagination ) and the page length can include from 10 to 100 results. The default pagination depends on the endpoint, and specifically for the list all the repositories within a workspace API, the default pagination is 10, which means it will return a maximum of 10 repositories per page. With that in mind, the following approaches can be used to see all the results :

Iterate through all the pages: The response of the API will include the following fields :
```
{ 
  "size": 5421, 
  "page": 2, 
  "pagelen": 10, 
  "next": "https://api.bitbucket.org/2.0/repositories/pypy/pypy/commits?page=3", "previous": "https://api.bitbucket.org/2.0/repositories/pypy/pypy/commits?page=1", 
  "values": [ ... ] 
}
```
Where the URL in the next field indicates the link you should call to get to the next page with the rest of the results. The lack of a next link in the response indicates the end of the results.
Increase the pagelen to return more results in a single API call : you can define the length of the page (number of results on each page) by adding the following query in the URL :
```
https://api.bitbucket.org/2.0/repositories/<workspace>?q=project.name="my_project"&pagelen=100
```
The example above will return 100 results per page. If you have up to 100 repos under "my_project", all the repos will be returned on a single page. If you have more than 100, then you will still need to iterate through the pages like in the example above.

2. You can list the Merged PRs using the query below :

https://api.bitbucket.org/2.0/repositories/<workspace>/<repository>/pullrequests?state=MERGED

And to get the users that approved those PRs, for each PR ID returned in that list, you will need to make a new API call and specify the PR ID in the URL as well. Here is an example of how to get the name of all participants in the PR and which ones approved it :

https://api.bitbucket.org/2.0/repositories/<workspace>/<repo>/pullrequests/<id>\?fields\=participants.user.display_name,participants.approved

More details about that endpoint are outlined in Get a Pull Request .

Hope that helps! Thank you, @sreekanth.c !

Patrik S

sreekanth.c

Thanks for the reply @Patrik S

same issue for pull requests, not fetching all the results from all the pages just printing 10fields. i tried to add &pagelen=100 but not working. anything im missing?

if possible, is there any way to filter the pull request based on updated_on field. i have tried below but not working to the pull request API

jq '.' | jq 'select(.updated_on > "2023-01-09T08:21:50.037798+00:00")'

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

cloud

bitbucket

bitbucket-cloud