openapi: 3.0.4
info:
  title: Pulse Api AllDevices TriggeredThreshold API
  description: "# Introduction\n\nThe Pulse API is an HTTP API that is designed to interact with your pulse account and devices. \n\nNote that not all app functionality has yet been exposed through this api, so if you need additional functionality, contact our support team at support@pulsegrow.com and we will add it for you. \n\nThis API reference includes all technical documentation developers need to integrate third-party applications and platforms. If you have any additional questions send an email to our support team at support@pulsegrow.com\n\n# Authentication\n\nAll HTTP requests made against the Pulse API must be validated with an API Key.\n\n### Acquiring an API Key\n\nTo generate a new api key go to https://app.pulsegrow.com/account, scroll down to the api key section, and press the \"Add Api Key\" button.\n\n### Using Your API Key \n\nNote: API keys are generated per grow and only have access to that grow's resources (users, devices, etc). \n\nAll requests should target domain `https://api.pulsegrow.com`.\n\nYou need to provide the API key via the `x-api-key` header.\n\nSecurity Warning: It's important to secure your API Key against public access. Guard and secure it like a password. If you suspect that your API key has been compromised, revoke it via the web application at https://app.pulsegrow.com/account. \n\nSample request:\n\n```\n\ncurl --request GET \"https://api.pulsegrow.com/devices/{deviceId}/recent-data\" --header \"x-api-key: {apiKey}\"\n\n``` \n\n### Api consumption\n\n Api consumption is measured by number of datapoints retrieved.\n\n An api call that does not retrieve datapoints counts as one datapoint.\n\n Hobbyist users can use up to 4800 datapoints daily, Enthusiasts and Professionals 24000 and 120000, respectively \n\n"
  termsOfService: https://pulsegrow.com/terms
  contact:
    name: Need help? Contact support
    email: support@pulsegrow.com
  version: v1
  x-logo:
    url: https://cdn.shopify.com/s/files/1/2451/2393/files/logo_1_400x.png
    altText: The Logo
tags:
- name: TriggeredThreshold
  description: A collection of API operations related to timeline events.
paths:
  /api/triggered-thresholds:
    get:
      tags:
      - TriggeredThreshold
      summary: Retrieves triggered thresholds for a grow
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SortedTriggeredThresholdsDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    ThresholdType:
      type: integer
      format: int32
    SortedTriggeredThresholdsDto:
      type: object
      properties:
        ongoing:
          type: array
          items:
            $ref: '#/components/schemas/ViewTriggeredThresholdDto'
          nullable: true
        resolved:
          type: array
          items:
            $ref: '#/components/schemas/ViewTriggeredThresholdDto'
          nullable: true
        growId:
          type: integer
          format: int32
      additionalProperties: false
    HubThresholdType:
      type: integer
      format: int32
    SensorThresholdType:
      type: integer
      format: int32
    ViewTriggeredThresholdDto:
      type: object
      properties:
        id:
          type: integer
          format: int32
          nullable: true
        createdAt:
          type: string
          format: date-time
        resolvedAt:
          type: string
          format: date-time
          nullable: true
        resolved:
          type: boolean
        thresholdId:
          type: integer
          format: int32
          nullable: true
        thresholdType:
          $ref: '#/components/schemas/ThresholdType'
        deviceId:
          type: integer
          format: int32
        deviceName:
          type: string
          nullable: true
        lowOrHigh:
          type: boolean
        lowThresholdValue:
          type: number
          format: double
          nullable: true
        highThresholdValue:
          type: number
          format: double
          nullable: true
        triggeringValue:
          type: string
          nullable: true
        sensorThresholdType:
          $ref: '#/components/schemas/SensorThresholdType'
        hubThresholdType:
          $ref: '#/components/schemas/HubThresholdType'
      additionalProperties: false