Tomorrow.io · JSON Structure

Insight Structure

A named threshold definition over one or more weather fields.

Type: object Properties: 9 Required: 3
WeatherClimateForecastHistorical WeatherAir QualityPollenFireFloodRoutesMap TilesAviationMaritimePublic APIs

Insight is a JSON Structure definition published by Tomorrow.io, describing 9 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description conditions logical timestep units createdAt updatedAt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tomorrow/refs/heads/main/json-structure/insight-structure.json",
  "name": "Insight",
  "description": "A named threshold definition over one or more weather fields.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "6183d156022c1b00086860a1"
    },
    "name": {
      "type": "string",
      "example": "High Wind"
    },
    "description": {
      "type": "string",
      "example": "Sustained wind speed above 15 m/s."
    },
    "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": "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"
      ]
    },
    "createdAt": {
      "type": "datetime"
    },
    "updatedAt": {
      "type": "datetime"
    }
  },
  "required": [
    "id",
    "name",
    "conditions"
  ]
}