v1

latestOpenAPI 3.0.12026-07-14292576.8 KB

Code reviews

Get results of code review

Get the results of a code review using the review identifier for the task.

When you request a code review, the response includes a task result URL of the form: /codereviews/{review-id}.

This endpoint reports the results of a complete code review, or the status of a review that's still in progress.

get/codereviews/{review-id}

Path parameters

review-idstring required

The identifier for the review (from the task-result-url).

Response

Success. Requested data returned.

idstring

The identifier for the review.

results-urlstring

A page on LGTM to view the status and results of this code review.

status'pending' | 'failure' | 'success'

The status of the code review.

status-messagestring

A summary of the current status of the code review.

Example response

[
  {
    "id": "b45e291e7033460949ec986153c5416d22157d3e",
    "languages": [
      {
        "alerts": [
          {
            "fixed": 1,
            "new": 0,
            "query": {
              "name": "Incomplete string escaping or encoding"
            }
          }
        ],
        "fixed": 1,
        "language": "javascript",
        "new": 0,
        "status": "success",
        "status-message": "1 fixed alert"
      }
    ],
    "results-url": "https://lgtm.example.com/projects/g/yarnpkg/yarn/rev/pr-b45e291e7033460949ec986153c5416d22157d3e",
    "status": "success",
    "status-message": "Analysis succeeded"
  }
]