Get analysis summary for a specific commit

v1.0.0

Get a summary of the analysis results for a specific commit, or the latest commit, to a project. (For projects configured for sparse or upload analysis, only latest is supported.)

This endpoint reports a summary of results for each language, and also the analysis identifier. You can use the analysis identifier to download full details of all the alerts found by the analysis. For more information, see .

Input

{
  "type": "object",
  "properties": {
    "commit-id": {
      "type": "string"
    },
    "project-id": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "commit-id",
    "project-id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "commit-id": {
      "type": "string",
      "description": "The commit identifier.\nThe commit identifier is included only if the same commit was successfully analyzed for all languages. A detailed breakdown of which commit was analyzed for each language is provided in the `languages` property.\n"
    },
    "id": {
      "type": "string",
      "description": "The analysis identifier."
    },
    "languages": {
      "type": "array",
      "description": "Per-language information.",
      "items": {
        "type": "object",
        "properties": {
          "alerts": {
            "type": "integer",
            "format": "int32",
            "description": "The number of alerts for this language."
          },
          "analysis-date": {
            "type": "string",
            "format": "date-time",
            "description": "The time the commit was analyzed."
          },
          "commit-date": {
            "type": "string",
            "format": "date-time",
            "description": "The time of the commit."
          },
          "commit-id": {
            "type": "string",
            "description": "The latest successfully analyzed commit for the language. All statistics refer to this commit."
          },
          "language": {
            "type": "string",
            "description": "The short name for the language."
          },
          "lines": {
            "type": "integer",
            "format": "int32",
            "description": "The number of lines of code for this language."
          },
          "status": {
            "type": "string",
            "description": "The status of the analysis of this language.",
            "enum": [
              "success",
              "failure",
              "pending"
            ]
          }
        }
      }
    },
    "log-url": {
      "type": "string",
      "description": "A page on LGTM to view the logs for this analysis."
    },
    "project": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "The numeric identifier of the project."
        },
        "name": {
          "type": "string",
          "description": "The display name of the project."
        },
        "url": {
          "type": "string",
          "description": "The full URL of the project on LGTM."
        },
        "url-identifier": {
          "type": "string",
          "description": "The URL identifier of the project."
        }
      }
    },
    "results-url": {
      "type": "string",
      "description": "A page on LGTM to view the results of this analysis."
    }
  }
}