Read an analysis report

OpenAPI contract

Method

GET

Path

/api/v1/analyses/{id}/report

Security

jwtBearer (bearer)

Response status

200 400 401 403 404 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Analysis report and structured suggestions",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/AnalysisReportResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Analysis or input not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "Request or concurrency limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RateLimitError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

The response wraps the raw core report with input identity and structured configuration guidance. Review issue locations, evidence and each issue's configurationSection. A suggestion's guidance contains a questionKey such as <section>Question and a fields array identifying the declaration inputs; it is null for unsupported or nondeclaration sections. The assistant localizes that question and opens the relevant fields rather than parsing English diagnostic messages. Unknown reflection and other dynamic targets keep the suggestion value as null and require the application owner's exact class, member or resource selection; suggestions are proposals, not completed declarations.

Prepare multiple declarations locally, then submit the combined draft for another analysis. A report verifies only the input and configuration submitted for that run. Changing either leaves its evidence unverified for the current draft. Review selected differences before applying them to the local NOL draft; saved project configuration and unrelated compiler settings remain untouched. Analysis does not activate Object Localization.