Code Reviews

Code Reviews describe the process of reviewing and improving source code made to Pull Requests. We will see how to obtain the list of code reviews and their properties.

The code reviews model

The code reviews model contains essential information about the source code review activity of a project, team, and developer.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the code review.

  • Name
    userId
    Type
    string
    Description

    The author user Id of the code review.

  • Name
    commitId
    Type
    string
    Description

    Associated commit id.

  • Name
    closedAt
    Type
    timestamp
    Description

    Timestamp of when the code review was closed.

  • Name
    state
    Type
    string
    Description

    The state for the code review.

  • Name
    prId
    Type
    string
    Description

    Associated pull request id.

GET/api/dashboard/code-reviews

List all code reviews

Request

GET
/api/dashboard/code-reviews
curl -G https://api.pulzen-gateway/api/dashboard/code-reviews \
  -H "Authorization: Basic {token}"

Response

{
    "id": "PRR_kwDOJsnarM58Dt0F",
    "login": "LBrieva",
    "userId": "LBrieva",
    "body": "",
    "commitId": "071c70c873f931a1b876415a622251ceb4f5bd5f",
    "submittedAt": "2024-05-27T14:26:27Z",
    "createdAt": null,
    "closedAt": "2024-05-27T14:26:27Z",
    "state": "approved",
    "prId": "PR_kwDOJsnarM5wrUP0"
}

Query Parameters:

  • provider: Can be one of the following: GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS.

Metrics

The metrics section of code reviews is in the pull requests section. Metrics