Tomorrow.io · Schema

InsightCreateRequest

Payload to create or update an insight.

WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

Properties

Name Type Description
name string
description string
conditions array
logical string
timestep string
units string
View JSON Schema on GitHub

JSON Schema

insight-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tomorrow/refs/heads/main/json-schema/insight-create-request-schema.json",
  "title": "InsightCreateRequest",
  "description": "Payload to create or update an insight.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A single condition that must hold for an insight to fire.",
        "properties": {
          "field": {
            "type": "string",
            "example": "windSpeed"
          },
          "operator": {
            "type": "string",
            "enum": [
              "eq",
              "neq",
              "gt",
              "gte",
              "lt",
              "lte"
            ],
            "example": "gt"
          },
          "value": {
            "type": "number",
            "format": "double",
            "example": 15
          }
        },
        "required": [
          "field",
          "operator",
          "value"
        ]
      }
    },
    "logical": {
      "type": "string",
      "enum": [
        "and",
        "or"
      ],
      "default": "and"
    },
    "timestep": {
      "type": "string",
      "example": "1h"
    },
    "units": {
      "type": "string",
      "enum": [
        "metric",
        "imperial"
      ]
    }
  },
  "required": [
    "name",
    "conditions"
  ]
}