{
  "opencollection": "1.0.0",
  "info": {
    "name": "Customer API - Base Operations Analytics Saved Locations API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Saved Locations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get All Saved Location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations",
            "params": [
              {
                "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": "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 allows you to get all saved locations.<br><br>      You can use the parameters `page`, and `take` to control the pagination, however, there is maximum page size of `take=30`.<br><br>      If no value is specified for the `take` parameter, the default number of saved locations retrieved is `10`.<br><br>      You can use `sortBy` to sort your results. This is optional but if provided must be an array of properties you would like to sort by with a suffix of the sort order.<br><br>    "
        },
        {
          "info": {
            "name": "Create Saved Location",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint allows you to create a new saved location. Creating a saved location here will also be visible in your dashboard.<br><br>      While only `name`, `latitude`, and `longitude` are required, other parameters will help you organize and analyze your saved locations.<br><br><br>      *HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*"
        },
        {
          "info": {
            "name": "Get Saved Location Tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations/tags",
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns all distinct saved location tags created by the user and their count."
        },
        {
          "info": {
            "name": "PublicSavedLocationsController_getSavedLocationReport_v1",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations/report",
            "params": [
              {
                "name": "fromDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "toDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "sourceIds",
                "value": "",
                "type": "query"
              },
              {
                "name": "months",
                "value": "",
                "type": "query"
              },
              {
                "name": "daytimes",
                "value": "",
                "type": "query"
              },
              {
                "name": "radius",
                "value": "",
                "type": "query"
              },
              {
                "name": "units",
                "value": "",
                "type": "query",
                "description": "NB: miles, kilometers and meters will be deprecated soon."
              },
              {
                "name": "isGTM",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          }
        },
        {
          "info": {
            "name": "Get Saved Location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint allows you to get a saved location by it's `id`.<br><br><br>      *HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*"
        },
        {
          "info": {
            "name": "Update Saved Location",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint allows you to update a saved location. Changes made to a saved location here will also be visible in your dashboard.<br><br><br>      *HINT: The `id` returned from this endpoint will be used as `savedLocationId` in some analysis endpoints*"
        },
        {
          "info": {
            "name": "Delete Saved Location",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.baseoperationsenterprise.com/v1/public/saved-locations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-KEY",
              "value": "{{X-API-KEY}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint allows you to delete a saved location. Changes made to a saved location here will also be visible in your dashboard."
        }
      ]
    }
  ],
  "bundled": true
}