Documentation

Examples

Copy-paste examples covering DevOps, SaaS, e-commerce, smart home, and AI usage.

Examples

Structured Response: Dashboard

{
  "items": [
    {
      "title": "Revenue",
      "subtitle": "This month",
      "type": "number",
      "value": 12450.00,
      "icon": "dollarsign.circle",
      "emoji": "💰",
      "format": "currency:USD",
      "color": "green",
      "menuBar": true
    },
    {
      "title": "Users",
      "subtitle": "Active now",
      "type": "number",
      "value": 1234,
      "icon": "person.fill",
      "emoji": "👤",
      "format": "number"
    },
    {
      "title": "CPU Usage",
      "type": "progress",
      "value": 0.65,
      "icon": "cpu",
      "emoji": "💻"
    },
    {
      "title": "Traffic",
      "subtitle": "Last 7 days",
      "type": "array",
      "value": [120, 150, 180, 140, 200, 220, 190],
      "icon": "chart.line.uptrend.xyaxis",
      "emoji": "📈"
    }
  ],
  "columns": 2
}

JSONPath Examples

User Count

  • API returns: { "data": { "total_users": 1234567 } }
  • Path: $.data.total_users
  • Format: number:compact
  • Result: 1.2M

Revenue from Cents

  • API returns: { "revenue": { "total_cents": 1234500 } }
  • Path: $.revenue.total_cents
  • Format: currency:USD:cents
  • Result: $12,345.00

Filtered Count

  • API returns: { "servers": [{"status": "online"}, {"status": "offline"}, {"status": "online"}] }
  • Path: $.servers[?(@.status == 'online')]
  • Format: number
  • Result: 2

Authentication Examples

Bearer Token API

  • URL: https://api.example.com/metrics
  • Auth: Bearer Token
  • Token: sk_live_abc123...
  • Refresh: 5 minutes

Custom Header

  • URL: https://api.example.com/stats
  • Auth: None
  • Custom Header: X-API-Key = your-api-key