Get the number of outages for locations.

/radar/annotations/outages/locations

get

Radar Annotations

radar-get-annotations-outages-top

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

{
  "enum": [
    "com.cloudflare.api.user.read"
  ]
}

Debug "parameters"

[
  {
    "in": "query",
    "name": "limit",
    "schema": {
      "description": "Limit the number of objects in the response.",
      "example": 5,
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "dateRange",
    "schema": {
      "description": "Shorthand date ranges for the last X days - use when you don't need specific start and end dates.",
      "enum": [
        "1d",
        "2d",
        "7d",
        "14d",
        "28d",
        "12w",
        "24w",
        "52w",
        "1dControl",
        "2dControl",
        "7dControl",
        "14dControl",
        "28dControl",
        "12wControl",
        "24wControl"
      ],
      "example": "7d",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "dateStart",
    "schema": {
      "description": "Start of the date range (inclusive).",
      "example": "2023-09-01T11:41:33.782Z",
      "format": "date-time",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "dateEnd",
    "schema": {
      "description": "End of the date range (inclusive).",
      "example": "2023-09-01T11:41:33.782Z",
      "format": "date-time",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "format",
    "schema": {
      "description": "Format results are returned in.",
      "enum": [
        "JSON",
        "CSV"
      ],
      "example": "json",
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "result": {
              "properties": {
                "annotations": {
                  "items": {
                    "properties": {
                      "clientCountryAlpha2": {
                        "example": "PT",
                        "type": "string"
                      },
                      "clientCountryName": {
                        "example": "Portugal",
                        "type": "string"
                      },
                      "value": {
                        "example": "5",
                        "type": "string"
                      }
                    },
                    "required": [
                      "clientCountryAlpha2",
                      "clientCountryName",
                      "value"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "required": [
                "annotations"
              ],
              "type": "object"
            },
            "success": {
              "example": true,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success"
          ],
          "type": "object"
        }
      }
    },
    "description": "Successful Response"
  },
  "400": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "errors": {
              "items": {
                "properties": {
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "message"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "result": {
              "type": "object"
            },
            "success": {
              "example": false,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success",
            "errors"
          ],
          "type": "object"
        }
      }
    },
    "description": "Bad Request"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]