Jump to

• Request
• Response

Blackout statistics

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/dashboard

This API returns the statistics about blackouts

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : BlackoutDashboard

Type: object

Various statistics about blackouts.

Show Source

• totalActiveBlackouts: integer
  Total number of active blackouts.

  Example: 12
• totalFailedBlackouts: integer
  Total number of failed blackouts.

  Example: 23
• totalFutureBlackouts: integer
  Total number of blackouts scheduled for future.

  Example: 15
• totalTargetsInActiveBlackout: integer
  Total number of targets which are in an active blackout.

  Example: 40
• totalTargetsInBlackout: integer
  Total number of targets which are member of an active or scheduled blackout.

  Example: 75

{
    "x-em-sdk-level":"emSDK",
    "description":"Various statistics about blackouts.",
    "type":"object",
    "properties":{
        "totalTargetsInActiveBlackout":{
            "type":"integer",
            "description":"Total number of targets which are in an active blackout.",
            "example":"40"
        },
        "totalTargetsInBlackout":{
            "type":"integer",
            "description":"Total number of targets which are member of an active or scheduled blackout.",
            "example":"75"
        },
        "totalActiveBlackouts":{
            "type":"integer",
            "description":"Total number of active blackouts.",
            "example":"12"
        },
        "totalFailedBlackouts":{
            "type":"integer",
            "description":"Total number of failed blackouts.",
            "example":"23"
        },
        "totalFutureBlackouts":{
            "type":"integer",
            "description":"Total number of blackouts scheduled for future.",
            "example":"15"
        }
    }
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top