{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer API - Base Operations Analytics Change Detection API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Change Detection",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Yearly Event Change Analysis by Location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/prior-year",
            "params": [
              {
                "name": "locationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "sources",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified location for each month or quarter to the same period in the prior year.<br><br><br>      - The `locationId` is required to identify the location.<br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>      - The `fromDate` and `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that determine the time range for the analysis.<br><br>      - Optional query pa"
        },
        {
          "info": {
            "name": "Yearly Event Change Analysis by Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/radius/prior-year",
            "params": [
              {
                "name": "latitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "longitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "savedLocationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified radius each month or quarter to the same period in the prior year.<br><br><br>      - The `latitude`, `longitude`, and `radius` are required parameters to define the area of interest. The `radius` must be 5 miles, 8 kilometers, or 8000 meters or less.<br><br>      - The `units` parameter is used to specify the measurement unit of the radius.<br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br"
        },
        {
          "info": {
            "name": "Yearly Event Change Analysis for Saved Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/:savedLocationId/prior-year",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified saved location for each month or quarter to the same period in the prior year.<br><br><br>      - The `savedLocationId` is required to identify the saved location.<br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>      - The `fromDate` and `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that determine the time range for the analysis.<br><br>      - "
        },
        {
          "info": {
            "name": "Periodic Event Change Analysis by Location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/prior-period",
            "params": [
              {
                "name": "locationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "sources",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified saved location for one period to the previous period (e.g., this month to last month, this quarter to last quarter, or this year to last year).<br><br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>      - The `fromDate` and `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that determine the time range for the analysis.<br><br>      - Optional query p"
        },
        {
          "info": {
            "name": "Periodic Event Change Analysis by Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/radius/prior-period",
            "params": [
              {
                "name": "latitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "longitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "savedLocationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified radius for one period to the previous period (e.g., this month to last month, this quarter to last quarter, or this year to last year).<br><br><br>      - The `latitude`, `longitude`, and `radius` are required parameters to define the area of interest. The `radius` must be 5 miles, 8 kilometers, or 8000 meters or less.<br><br>      - The `units` parameter is used to specify the measurement unit of the radius.<br><br>      - The `type"
        },
        {
          "info": {
            "name": "Periodic Event Change Analysis for Saved Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/:savedLocationId/prior-period",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified saved location for one period to the previous period (e.g., this month to last month, this quarter to last quarter, or this year to last year).<br><br><br>      - The `savedLocationId` is required to identify the saved location.<br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>      - The `fromDate` and `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameter"
        },
        {
          "info": {
            "name": "Category-Based Event Change Analysis by Location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/category-contribution",
            "params": [
              {
                "name": "locationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "sources",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "processType",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "\n      This endpoint compares the volume of events within a specified location over time and returns the change by category. The comparison can be either period-over-period (e.g., this month to last month) or year-over-year (e.g., this month to the same month last year), based on the `processType` parameter.<br><br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>      - The `fromDate` and `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO"
        },
        {
          "info": {
            "name": "Category-Based Event Change Analysis by Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/radius/category-contribution",
            "params": [
              {
                "name": "latitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "longitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "processType",
                "value": "",
                "type": "query"
              },
              {
                "name": "savedLocationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint compares the volume of events within a specified radius over time and returns the change by category. The comparison can be either period-over-period (e.g., this month to last month) or year-over-year (e.g., this month to the same month last year), based on the `processType` parameter.<br><br><br>      - The `latitude`, `longitude`, and `radius` are required parameters to define the area of interest. The `radius` must be 5 miles, 8 kilometers, or 8000 meters or less.<br><br>      -"
        },
        {
          "info": {
            "name": "Category-Based Event Change Analysis for Saved Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/:savedLocationId/category-contribution",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "processType",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "\n      This endpoint compares the volume of events within a specified saved location over time and returns the change by category. The comparison can be either period-over-period (e.g., this month to last month) or year-over-year (e.g., this month to the same month last year), based on the `processType` parameter.<br><br><br>      - The `savedLocationId` is required to identify the saved location.<br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>     "
        },
        {
          "info": {
            "name": "Top Cities by Event Volume Change within Footprint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/locations-most-change",
            "params": [
              {
                "name": "search",
                "value": "",
                "type": "query"
              },
              {
                "name": "tags",
                "value": "",
                "type": "query"
              },
              {
                "name": "addressTypes",
                "value": "",
                "type": "query"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort fields. Some fields may not be available for all organizations."
              },
              {
                "name": "visibility",
                "value": "",
                "type": "query"
              },
              {
                "name": "threatScoreQuintiles",
                "value": "",
                "type": "query"
              },
              {
                "name": "changeMetric",
                "value": "",
                "type": "query"
              },
              {
                "name": "degreesOfChange",
                "value": "",
                "type": "query"
              },
              {
                "name": "locationIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "take",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint retrieves all cities within your footprint (all saved locations) and orders them by cities with the highest change in event volume.<br><br><br>      - The `changeMetric` (required) parameter controls which change value is returned (e.g., one_month_period_over_period, year_over_year, index).<br><br>      - The `tags` parameter allows filtering by specific tags.<br><br>      - The `addressTypes` parameter allows filtering by different address types, such as office, hotel, etc.<br><br"
        },
        {
          "info": {
            "name": "Saved Location Change Distribution within Footprint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/saved-locations/distribution",
            "params": [
              {
                "name": "tags",
                "value": "",
                "type": "query"
              },
              {
                "name": "addressTypes",
                "value": "",
                "type": "query"
              },
              {
                "name": "degreesOfChange",
                "value": "",
                "type": "query"
              },
              {
                "name": "visibility",
                "value": "",
                "type": "query"
              },
              {
                "name": "threatScoreQuintiles",
                "value": "",
                "type": "query"
              },
              {
                "name": "parentCategoryId",
                "value": "",
                "type": "query"
              },
              {
                "name": "changeMetric",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "TThis endpoint returns the number of saved locations within your footprint that fall into each range of change (large increase, increase, no change, decrease, large decrease).<br><br><br>      - The `changeMetric` (required) parameter controls which change value is returned (e.g., one_month_period_over_period, year_over_year, index).<br><br>      - The `tags` parameter allows filtering by specific tags.<br><br>      - The `addressTypes` parameter allows filtering by different address types, such"
        },
        {
          "info": {
            "name": "Enhanced Event Trend Analysis by Radius",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/radius/trendline",
            "params": [
              {
                "name": "latitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "longitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "savedLocationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint retrieves the trendline for events within a specified radius. The trendline is a smoothed curve that represents the overall trend of events over time.<br><br><br>      - The `latitude`, `longitude`, and `radius` are required parameters to define the area of interest. The `radius` must be 5 miles, 8 kilometers, or 8000 meters or less.<br><br>      - The `units` parameter is used to specify the measurement unit of the radius.<br><br>      - The `type` parameter specifies the event ty"
        },
        {
          "info": {
            "name": "Enhanced Event Trend Analysis for Saved Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/change/:savedLocationId/trendline",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              },
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "sources",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "timeAggregation",
                "value": "",
                "type": "query"
              },
              {
                "name": "granularity",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint retrieves the trendline for events within a specified saved location. The trendline is a smoothed curve that represents the overall trend of events over time.<br><br><br>      - The `savedLocationId` is required to identify the saved location.<br><br>      - The `type` parameter specifies the event type, such as crime or unrest.<br><br>      - The `fromDate` and `toDate` are required [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) query parameters that determine the time range fo"
        }
      ]
    }
  ],
  "bundled": true
}