643 matches
22 actions
LGTM API specification
22 actions
Other/LGTM API specification
This endpoint provides a summary of the results generated by completed query runs for each project specified in the the POST /queryjobs endpoint. For completed query jobs, the summary includes:
No information is included in the response for any project for which the query run is still in progress.
{
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"limit": {
"type": "integer",
"format": "int32"
},
"queryjob-id": {
"type": "string"
},
"start": {
"type": "string"
}
},
"required": [
"queryjob-id"
],
"additionalProperties": false
}{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message. Only applies if `status` is `error`."
},
"external": {
"type": "integer",
"format": "int32",
"description": "Number of results that refer to elements outside the source tree (e.g., libraries). Only applies if `status` is `success`."
},
"internal": {
"type": "integer",
"format": "int32",
"description": "Number of results that refer to elements within the source tree. Only applies if `status` is `success`."
},
"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."
}
}
},
"status": {
"type": "string",
"description": "Describes whether the query was sucessfully executed against the project.",
"enum": [
"success",
"error"
]
},
"total": {
"type": "integer",
"format": "int32",
"description": "Number of results returned by the query. This is broken down further into `internal` and `external` results. Only applies if `status` is `success`.\n"
}
}
}
},
"next": {
"type": "string"
}
}
}