v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB

API Scoring

Get API Scoring

Get API Scoring. Return a 404 HTTP Response status if API was never evaluated.

get/environments/{envId}/apis/{apiId}/scoring

Response

API Scoring

createdAtstring date-time

The date when the scoring has been created.

Example response

{
  "createdAt": "2023-05-18 12:40:46.184000+00:00",
  "summary": {
    "score": 0.91,
    "all": 100,
    "errors": 10,
    "warnings": 20,
    "infos": 30,
    "hints": 40
  },
  "assets": [
    {
      "name": "Echo-oas.json",
      "type": "SWAGGER",
      "diagnostics": [
        {
          "severity": "WARN",
          "range": {
            "start": {
              "line": 17,
              "character": 12
            },
            "end": {
              "line": 17,
              "character": 12
            }
          },
          "rule": "operation-operationId",
          "message": "Operation must have 'operationId'.",
          "path": "paths./my-api.get"
        }
      ],
      "errors": [
        {
          "code": "undefined-function"
        }
      ]
    }
  ]
}