v1

latestOpenAPI 3.0.12026-07-14292576.8 KB

Projects

Get project by URL identifier

Get the latest summary for a specific project using the project's URL identifier {provider}/{org}/{name}.

To find the URL identifier for a project, view the project overview page in LGTM. The URL identifier follows after /projects. For example, for a project with the URL https://lgtm.example.com/projects/g/apache/commons-io the URL identifier is g/apache/commons-io. In the example, g represents the provider (repository host), apache is the organization and commons-io is the name of the repository.

get/projects/{provider}/{org}/{name}

Path parameters

providerstring required

The first part of the URL identifier of a project, which represents the repository host.

orgstring required

The second part of the URL identifier of a project, the organization.

namestring required

The third part of the URL identifier of a project, the repository name.

Response

Success. Requested data returned.

idinteger

The numeric identifier of the project.

namestring

The display name of the project.

urlstring

The full URL of the project on LGTM.

url-identifierstring

The URL identifier of the project.

Example response

{
  "id": 1234567,
  "name": "Apache Commons IO",
  "url": "https://lgtm.example.com/projects/g/apache/commons-io",
  "url-identifier": "g/apache/commons-io"
}