Get Report Statistics

Get the statistics of the report, including metrics such as risky rules and compliance.

Resource name: /api/v1/seikan/report/{report}/statistics

Request Method: GET

Request parameters:

Parameter	Type	Description
report mandatory	string	The unique identifier for the report. Obtain this using the GET /report/findAllReports endpoint.

cURL Example:

curl -X GET "https://localhost/api/v1/seikan/report/1234/statistics" \-H "Authorization: Bearer your_access_token"

Status codes:

Code	Description
200	OK - Statistics data successfully retrieved.
400	Bad Request - Invalid input or missing required parameters.
401	Unauthorized - Access token is missing or invalid.
403	Forbidden - Insufficient permissions to access this resource.
404	Not Found - Specified report does not exist.
500	Internal Server Error - An unexpected error occurred.
503	Service Unavailable - The service is temporarily unavailable.

Response parameters:

Parameter	Type	Description
statistics	object	Contains statistical data for the report. Each statistic includes additional properties.
name	string	The name of the statistic.
type	string	The type of the statistic.
value	integer	The value associated with the statistic.

Response example success 200:

Copy

{
  "statistics": {
    "exampleStatistic": {
      "name": "Risky Rules",
      "type": "integer",
      "value": 25
    }
  }
}

Response example failure 400:

Copy

{
  "error": "Invalid Report ID",
  "message": "The report ID provided is invalid.",
  "fieldErrors": [
    {
      "field": "string",
      "error": "string"
    }
  ]
}

Response example failure 403:

Copy

{
  "cause": {
    "stackTrace": [
      {
        "moduleName": "string",
        "moduleVersion": "string",
        "classLoaderName": "string",
        "methodName": "string",
        "fileName": "string",
        "lineNumber": 0,
        "className": "string",
        "nativeMethod": true
      }
    ],
    "message": "string",
    "localizedMessage": "string",
    "suppressed": [
      {
        "stackTrace": [
          {
            "moduleName": "string",
            "moduleVersion": "string",
            "classLoaderName": "string",
            "methodName": "string",
            "fileName": "string",
            "lineNumber": 0,
            "className": "string",
            "nativeMethod": true
          }
        ],
        "message": "string",
        "localizedMessage": "string"
      }
    ]
  },
  "stackTrace": [
    {
      "moduleName": "string",
      "moduleVersion": "string",
      "classLoaderName": "string",
      "methodName": "string",
      "fileName": "string",
      "lineNumber": 0,
      "className": "string",
      "nativeMethod": true
    }
  ],
  "resolvedName": {
    "empty": true,
    "all": {}
  },
  "resolvedObj": {},
  "remainingName": {
    "empty": true,
    "all": {}
  },
  "explanation": "string",
  "rootCause": {
    "stackTrace": [
      {
        "moduleName": "string",
        "moduleVersion": "string",
        "classLoaderName": "string",
        "methodName": "string",
        "fileName": "string",
        "lineNumber": 0,
        "className": "string",
        "nativeMethod": true
      }
    ],
    "message": "string",
    "localizedMessage": "string",
    "suppressed": [
      {
        "stackTrace": [
          {
            "moduleName": "string",
            "moduleVersion": "string",
            "classLoaderName": "string",
            "methodName": "string",
            "fileName": "string",
            "lineNumber": 0,
            "className": "string",
            "nativeMethod": true
          }
        ],
        "message": "string",
        "localizedMessage": "string"
      }
    ]
  },
  "message": "string",
  "localizedMessage": "string",
  "suppressed": [
    {
      "stackTrace": [
        {
          "moduleName": "string",
          "moduleVersion": "string",
          "classLoaderName": "string",
          "methodName": "string",
          "fileName": "string",
          "lineNumber": 0,
          "className": "string",
          "nativeMethod": true
        }
      ],
      "message": "string",
      "localizedMessage": "string"
    }
  ]
}