API archive entry · source-reported
LGTM API specification
The REST API for LGTM provides data so that you can customize how you integrate LGTM analysis into your workflow. It includes the following resources: * `/` (API root)—get version information or download the specification in OpenAPI format. * `/projects` (Projects)—list projects, get a summary of the current status for a project, or add new projects. * `/analyses` (Analyses)—get a summary of results, download all the alerts, or trigger analysis for a specific commit. * `/codereviews` (Code reviews)—trigger code review for a patch, and view the results. * `/operations` (Operations)—get information about long-running tasks, for example, analyses or code reviews that you've requested. * `/snapshots` (Snapshots)—download and upload databases representing a snapshot of a codebase. * `/queryjobs` (Query jobs)—submit queries to evaluate against existing projects, and download their results. * `/system` (System)—get information on the health or usage of the system. For an overview and getting started topics, see API for LGTM.
Plan the first integration safely
The access fields below come from the connected directory. Their likely implementation impact is explained without assuming provider-specific behavior.
Authentication
OAuth is reported. Confirm flows, scopes, consent, token lifetime, and refresh rules.
Transport
HTTPS is not confirmed. Do not send credentials or production data until secure transport is verified.
Browser access
CORS is unknown. Treat direct browser access as unconfirmed and test before choosing a client-only architecture.
First-request sequence
- Identify the current base URL, version, and endpoint for the use case.
- Confirm how credentials are issued and where they may be stored.
- Test success, invalid input, throttling, unavailable data, and timeouts.
- Record response fields, pagination, caching, and error shapes.
- Add monitoring, retries with backoff, and an appropriate fallback.
Questions to resolve before production
Pricing and quotas
Confirm current plans, free-tier limits, overages, and request ceilings.
Endpoint coverage
Check that the operations and response fields match the intended workload.
Reliability
Look for uptime history, a status page, support routes, and service commitments.
Data and privacy
Review retention, licensing, regional processing, and compliance requirements.
Versioning
Confirm the active version, change policy, deprecation window, and migration guidance.
Developer experience
Validate SDKs, examples, error formats, pagination, and test environments.
Source reference
This page separates source-reported facts from questions that need live provider verification.