{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/socialdata-tools/json-schema/socialdata-tools-monitor-schema.json",
  "title": "Monitor",
  "description": "Represents a monitor configuration",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/socialdata-tools-openapi.yml#/components/schemas/Monitor",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the monitor"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The UTC datetime when the monitor was created"
    },
    "monitor_type": {
      "type": "string",
      "enum": [
        "user_tweets",
        "user_following",
        "user_profile",
        "search_keyword"
      ],
      "description": "Type of monitor"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ],
      "description": "Whether the monitor is currently checking for updates. A monitor is paused when a charge could not be collected from your balance, and resumes automatically once you top up."
    },
    "refresh_frequency": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3600,
      "description": "Search monitors only. How often the monitor executes, in seconds."
    },
    "webhook_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Monitor-specific webhook URL that overrides the global webhook URL, if set"
    },
    "parameters": {
      "type": "object",
      "description": "Configuration parameters specific to the type of monitor"
    }
  },
  "required": [
    "id",
    "created_at",
    "monitor_type",
    "status",
    "parameters"
  ]
}