{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer API - Base Operations Analytics Saved Location Radius Charts API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Saved Location Radius Charts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Saved Location Monthly Time Series Anaylsis within Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/radius/monthly-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categoryIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint takes a `savedLocationId` and calculates the number with threats per month within the radius provided.<br><br><br>      - The `fromDate` & `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that will restrict or alter the results of this analysis.<br><br>      - The query parameters `type`, `categoryIds`, `months` and `daytimes` are optional but will help you further refine your analysis.<br><br><br>      HINT: The `savedLocationId` can we acqu"
        },
        {
          "info": {
            "name": "Saved Location 30-day Rolling Average within Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/radius/rolling-average",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categoryIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint takes a `savedLocationId` and calculates the 30-day rolling average within the radius provided.<br><br><br>      - The `fromDate` & `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that will restrict or alter the results of this analysis.<br><br>      - The query parameters `type`, `categoryIds`, `months` and `daytimes` are optional but will help you further refine your analysis.<br><br><br>      HINT: The `savedLocationId` can we acquired by"
        },
        {
          "info": {
            "name": "Saved Location Historical Monthly Trend Analysis within Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/radius/historical-monthly-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categoryIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "precision",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint takes a `savedLocationId` and calculates the monthly average compared to past years based on your chosen precision within the radius provided.<br><br>      **Example:** If you specify a precicion `3_years`, you will see the average of all Januaries within the past 3 years, then Februaries, and so on for every month.<br><br><br>      - The `fromDate` & `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that will restrict or alter the results of "
        },
        {
          "info": {
            "name": "Get Radius Event Breakdown",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/radius/event-breakdown",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categoryIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint calculates the relationship between parent categories, sub categories, and the time of day that they occur. The data will be returned as an array of nodes and links."
        },
        {
          "info": {
            "name": "Get Threat Category Trend Chart",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/radius/threat-categories-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categoryIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a trend of threat categories count within a specific date range into a defined radius area."
        },
        {
          "info": {
            "name": "Get Source Category Trend Chart",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/radius/source-categories-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categoryIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a trend of source categories count within a specific date range into a defined radius area."
        }
      ]
    }
  ],
  "bundled": true
}