{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer API - Base Operations Analytics Saved Location Charts API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Saved Location Charts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Saved Location Monthly Time Series Analysis at City or District Level",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/monthly-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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 granularity 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"
        },
        {
          "info": {
            "name": "Saved Location 30-day Rolling Average at City or District Level",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/rolling-average",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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 granularity 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 acquir"
        },
        {
          "info": {
            "name": "Saved Location Historical Monthly Trend Analysis at City or District Level",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/historical-monthly-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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 granularity provided.<br><br>      **Example:** If you specify a precision `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 result"
        },
        {
          "info": {
            "name": "PublicSavedLocationChartsController_getAverageDayOfWeek_v1",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/historical-analysis/day-of-week",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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"
            }
          }
        },
        {
          "info": {
            "name": "PublicSavedLocationChartsController_getAverageTimeOfDay_v1",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/historical-analysis/time-of-day",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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"
            }
          }
        },
        {
          "info": {
            "name": "Saved Location Severity Score Trend Analysis at District Level",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/severity-score",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "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 relative severity of the district that contains your saved location compared to other districts in the city. This is computed for each month to help you analyze the trend over time.<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 `day"
        },
        {
          "info": {
            "name": "Saved Location Threat Quintile Analysis at District Level",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/threat-quintiles",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "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 severity quintile (1-5) of the district that contains your saved location relative to other districts in the city for each threat category.<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 furt"
        },
        {
          "info": {
            "name": "Get Threat Category Trend Chart",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/threat-categories-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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 for a specific location."
        },
        {
          "info": {
            "name": "Get Source Category Trend Chart",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/source-categories-trend",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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 for a specific location."
        },
        {
          "info": {
            "name": "Get Event Breakdown",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/charts/:savedLocationId/event-breakdown",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "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."
        }
      ]
    }
  ],
  "bundled": true
}