{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer API - Base Operations Analytics Base Score API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Base Score",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get aggregate BaseScore for a city using a city id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores",
            "params": [
              {
                "name": "locationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Get aggregate BaseScore for a city using a city id"
        },
        {
          "info": {
            "name": "Get aggregate BaseScore for a given radius using location coordinates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/radius",
            "params": [
              {
                "name": "latitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "longitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "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 computes the base score for a given radius. The query dto should include the following fields:<br><br>      - The `latitude`, `longitude`, and `radius` are required parameters to define the area of interest.<br><br>      - The `units` parameter is used to specify the measurement unit of the radius.<br><br>      - The `normalizedBy` parameter is used to specify the normalization method for the base score either through area or populateion.<br><br>"
        },
        {
          "info": {
            "name": "Get aggregate BaseScore for a hex using a hex id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/hex",
            "params": [
              {
                "name": "hexIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Get aggregate BaseScore for a hex using a hex id"
        },
        {
          "info": {
            "name": "Get aggregate BaseScore for a given radius using a saved location id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/saved-locations/:savedLocationId",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint computes the base score of the radius of a saved location. Radius defaults to `0.5 mi`."
        },
        {
          "info": {
            "name": "Get aggregate BaseScore for a city using a city id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/saved-locations/:savedLocationId/location",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint computes the base score for a saved location. Granularity is defaults to `city`."
        },
        {
          "info": {
            "name": "Get the BaseScore category breakdown within a specified radius using a saved location id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/saved-locations/:savedLocationId/categories",
            "params": [
              {
                "name": "savedLocationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Get the BaseScore category breakdown within a specified radius using a saved location id"
        },
        {
          "info": {
            "name": "Get the BaseScore category breakdown within a specified city using a city id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/categories",
            "params": [
              {
                "name": "locationId",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Get the BaseScore category breakdown within a specified city using a city id"
        },
        {
          "info": {
            "name": "Get the BaseScore category breakdown within a specified radius using location coordinates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/radius/categories",
            "params": [
              {
                "name": "latitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "longitude",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Get the BaseScore category breakdown within a specified radius using location coordinates"
        },
        {
          "info": {
            "name": "Get the BaseScore category breakdown within a specified hex using a hex id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/base-scores/hex/categories",
            "params": [
              {
                "name": "hexIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "categories",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "Get the BaseScore category breakdown within a specified hex using a hex id"
        }
      ]
    }
  ],
  "bundled": true
}