Base Operations Key Takeaways API

openapi: 3.0.0
info:
  title: Customer API - Base Operations Analytics Key Takeaways API
  description: 'Welcome to the Base Operations Customer API! This API allows you to interact with our data and perform detailed analysis. In this documentation, we''ll explain how to use the API, including the available endpoints and the expected request bodies or query parameters.


    ### Authentication


    To use this API, you''ll need to authenticate using an API key. Please reach out to Base Operations to have an API key provisioned for your user. Once you have your API key, you can use it to authorize the Swagger docs.


    To authenticate on the Swagger docs, follow these steps:


    1.  Click on the "Authorize" button on the top right corner of the Swagger docs.

    2.  In the "Value" field, enter your API key.

    3.  Click "Authorize" to authenticate.


    ### Helpful Hints


    When using the API, you may see the following query parameters:


    - `savedLocationId`: This is an internal identifier for a saved location. You can acquire this identifier by using the `GET /v1/public/saved-locations` endpoint.


    - `categoryId`: This is an internal identifier for a threat category. You can acquire this identifier by using the `GET /v1/public/threat-categories` endpoint.<br><br>


    That''s it! You''re now authenticated and can start using the API. If you have any questions or issues, please contact Base Operations support.

    '
  version: '1.0'
  contact: {}
servers:
- url: https://api.baseoperationsenterprise.com/
tags:
- name: Key Takeaways
paths:
  /v1/public/key-takeaways/event-summary:
    get:
      description: High-level summary analysis of events.
      operationId: PublicKeyTakeawaysController_getKeyTakeawaysEventSummary_v1
      parameters:
      - name: locationId
        required: true
        in: query
        schema:
          type: number
      - name: types
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - crime
            - unrest
            - customer
            - uas_sighting
      - name: fromDate
        required: false
        in: query
        schema:
          type: string
      - name: toDate
        required: false
        in: query
        schema:
          type: string
      - name: sources
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: categories
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: months
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: sortBy
        required: false
        in: query
        schema:
          example:
          - date.asc
          - categoryId.desc
          type: array
          items:
            type: string
      - name: daytimes
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: isGTM
        required: false
        in: query
        schema:
          type: boolean
      - name: hasAuxInfoOnly
        required: false
        in: query
        schema:
          type: boolean
      - name: organizationId
        required: false
        in: query
        schema:
          nullable: true
          default: null
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - ApiKey: []
      summary: 'Public: Event summary key takeaways'
      tags:
      - Key Takeaways
  /v1/public/key-takeaways/radius/event-summary:
    get:
      description: High-level summary analysis of events within a radius.
      operationId: PublicKeyTakeawaysController_getKeyTakeawaysRadiusEventSummary_v1
      parameters:
      - name: fromDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
      - name: toDate
        required: false
        in: query
        schema:
          format: date-time
          type: string
      - name: types
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - crime
            - unrest
            - customer
            - uas_sighting
      - name: sourceIds
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: categoryIds
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: months
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: daytimes
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - morning
            - midmorning
            - afternoon
            - evening
            - night
      - name: latitude
        required: true
        in: query
        schema:
          type: number
      - name: longitude
        required: true
        in: query
        schema:
          type: number
      - name: radius
        required: true
        in: query
        schema:
          type: number
      - name: units
        required: true
        in: query
        description: 'NB: miles, kilometers and meters will be deprecated soon.'
        schema:
          type: string
          enum:
          - mi
          - km
          - m
          - miles
          - kilometers
          - meters
      - name: isGTM
        required: false
        in: query
        schema:
          default: true
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - ApiKey: []
      summary: 'Public: Event summary key takeaways for a radius'
      tags:
      - Key Takeaways
  /v1/public/key-takeaways/event-change:
    get:
      description: Change analysis of events (period over period or year over year).
      operationId: PublicKeyTakeawaysController_getKeyTakeawaysEventChange_v1
      parameters:
      - name: locationId
        required: true
        in: query
        schema:
          type: number
      - name: types
        required: false
        in: query
        schema:
          default:
          - crime
          - unrest
          type: array
          items:
            type: string
            enum:
            - crime
            - unrest
            - customer
            - uas_sighting
      - name: fromDate
        required: true
        in: query
        schema:
          type: string
      - name: toDate
        required: true
        in: query
        schema:
          type: string
      - name: sources
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: categories
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: months
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: daytimes
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: isGTM
        required: false
        in: query
        schema:
          default: false
          type: boolean
      - name: timeAggregation
        required: true
        in: query
        schema:
          type: string
          enum:
          - monthly
          - quarterly
          - yearly
      - name: changeType
        required: true
        in: query
        description: The type of change to get the key takeaways for (eg. yearOverYear or periodOverPeriod)
        schema:
          example: periodOverPeriod
          type: string
          enum:
          - trendline
          - periodOverPeriod
          - yearOverYear
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - ApiKey: []
      summary: 'Public: Event change key takeaways'
      tags:
      - Key Takeaways
  /v1/public/key-takeaways/radius/event-change:
    get:
      description: Change analysis of events within a radius.
      operationId: PublicKeyTakeawaysController_getKeyTakeawaysRadiusEventChange_v1
      parameters:
      - name: latitude
        required: true
        in: query
        schema:
          type: number
      - name: longitude
        required: true
        in: query
        schema:
          type: number
      - name: radius
        required: true
        in: query
        schema:
          type: number
      - name: units
        required: true
        in: query
        schema:
          type: string
          enum:
          - mi
          - km
          - m
      - name: types
        required: false
        in: query
        schema:
          default:
          - crime
          - unrest
          type: array
          items:
            type: string
            enum:
            - crime
            - unrest
            - customer
            - uas_sighting
      - name: fromDate
        required: true
        in: query
        schema:
          type: string
      - name: toDate
        required: true
        in: query
        schema:
          type: string
      - name: sources
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: categories
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: months
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: daytimes
        required: false
        in: query
        schema:
          type: array
          items:
            type: number
      - name: isGTM
        required: false
        in: query
        schema:
          default: false
          type: boolean
      - name: timeAggregation
        required: true
        in: query
        schema:
          type: string
          enum:
          - monthly
          - quarterly
          - yearly
      - name: changeType
        required: true
        in: query
        description: The type of change to get the key takeaways for (eg. yearOverYear or periodOverPeriod)
        schema:
          example: periodOverPeriod
          type: string
          enum:
          - trendline
          - periodOverPeriod
          - yearOverYear
      - name: savedLocationId
        required: false
        in: query
        schema:
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - ApiKey: []
      summary: 'Public: Event change key takeaways for a radius'
      tags:
      - Key Takeaways
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-KEY