Run analysis of a specific commit

v1.0.0

Trigger the analysis of a specific commit to a project. If a previous attempt to analyze that commit failed, this triggers a fresh analysis. This is supported for all LGTM projects, regardless of repository type or host. The commit must be available in the main repository, but can be on a branch that isn't tracked by LGTM. For both LGTM.com and LGTM Enterprise, you must include an access token with the analyses:write scope.

When you request the analysis of a commit, the API returns:

operation-id: used to track the status of the task using the /operations endpoint. For more information, see .
status: initially pending.
task-result: containing information about the progress and results of the analysis.

Input

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

Output

{
  "type": "object",
  "required": [
    "task-type"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "The identifier for the operation."
    },
    "status": {
      "type": "string",
      "description": "Status of the operation.",
      "enum": [
        "pending",
        "done"
      ]
    },
    "task-result": {
      "type": "object"
    },
    "task-result-url": {
      "type": "string",
      "description": "The URL for the result of the task. For some operations, included only on completion."
    },
    "task-type": {
      "type": "string",
      "enum": [
        "analysis",
        "codereview",
        "queryjob"
      ]
    },
    "uploads": {
      "type": "object"
    }
  }
}