Global compliance

Get current global compliance of a Rudder server

get/compliance

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/compliance/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

precisioninteger

Number of digits after comma in compliance percent figures

Response

Success

result'success' | 'error' required

Result of the request

action'getGlobalCompliance' required

The id of the action

Example response

{
  "result": "success",
  "data": {
    "globalCompliance": {
      "compliance": 57,
      "complianceDetails": {
        "successAlreadyOK": 48.68,
        "noReport": 36.18,
        "successNotApplicable": 5.92,
        "unexpectedMissingComponent": 2.63,
        "error": 1.32,
        "unexpectedUnknownComponent": 2.63,
        "successRepaired": 2.63
      }
    }
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.