GetGrowthRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/hyperaware-live/json-schema/hyperaware-live-get-growth-request-schema.json",
  "title": "GetGrowthRequest",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hyperaware-live-openapi.json#/components/schemas/GetGrowthRequest",
  "properties": {
    "country": {
      "description": "ISO 3166-1 alpha-2 country code (US, GB, JP). Boards, TikTok and review stores default to US; Google time series and growth default to worldwide. Only for: Google Search, Google Images, Google News, Google Shopping, YouTube, TikTok, Pinterest.",
      "type": "string"
    },
    "keyword": {
      "description": "What to look up. The string format is required by source. Google Search, Google Images, Google News, Google Shopping, YouTube, Wikipedia, TikTok, Amazon, Pinterest: any name or phrase, e.g. 'nike'. npm: Exact npmjs.com package name, case-sensitive. Right: 'react', '@babel/core'. Wrong: 'React', 'React.js'. Python: Exact PyPI project name. Right: 'pandas', 'requests'. Wrong: 'Pandas'. Steam: Game display name in plain English, not a Steam App ID. Right: 'Elden Ring', 'CS2'. First Steam store search result wins, so use an unambiguous name. App Downloads: Android bundle ID only (the id= value on Google Play). Right: 'com.openai.chatgpt', 'com.whatsapp'. Wrong: 'ChatGPT', 'WhatsApp', an iOS App Store ID, or a bundle ID that is not Android. Find it at play.google.com/store/apps/details?id=THIS_PART. App Rankings: Android bundle ID only (the id= value on Google Play). Right: 'com.openai.chatgpt', 'com.whatsapp'. Wrong: 'ChatGPT', 'WhatsApp', an iOS App Store ID, or a bundle ID that is not Android. Find it at play.google.com/store/apps/details?id=THIS_PART.",
      "type": "string"
    },
    "language": {
      "default": "en",
      "description": "Wikipedia language edition (en, de, ja, pt); defaults to en. Only for: Wikipedia.",
      "type": "string"
    },
    "mode": {
      "const": "get_growth",
      "description": "Canonical name (matches the MCP tool). Alias: 'growth'.",
      "type": "string"
    },
    "percent_growth": {
      "default": [
        "12M"
      ],
      "description": "Growth windows. Each item is a window string or, on REST only, a custom date-range object. Every window is a two-date comparison. `window` is accepted as a REST alias.",
      "items": {
        "oneOf": [
          {
            "description": "Any whole number plus a D, W, M, or Y suffix, up to 5 years (e.g. '7D', '17D', '45D', '3M', '18M', '2Y'), or MTD, QTD, YTD. Common presets: 7D, 1W, 14D, 2W, 30D, 1M, 2M, 3M, 6M, 9M, 12M, 1Y, 18M, 24M, 2Y, 36M, 3Y, 48M, 4Y, 60M, 5Y, MTD, QTD, YTD.",
            "type": "string"
          },
          {
            "description": "Custom date range. REST only; MCP accepts the string windows.",
            "properties": {
              "baseline": {
                "format": "date",
                "type": "string"
              },
              "name": {
                "description": "Optional label.",
                "type": "string"
              },
              "recent": {
                "format": "date",
                "type": "string"
              }
            },
            "required": [
              "recent",
              "baseline"
            ],
            "type": "object"
          }
        ]
      },
      "type": "array"
    },
    "resolution": {
      "default": "weekly",
      "description": "'weekly' (about 5 years, default) or 'daily' (last 90 days, fetched live). Only for: Google Search, Google Images, Google News, Google Shopping, YouTube.",
      "enum": [
        "weekly",
        "daily"
      ],
      "type": "string"
    },
    "source": {
      "description": "One source, or comma-separated sources for get_growth (e.g. 'amazon, tiktok, youtube'). get_time_series takes exactly one.",
      "enum": [
        "Google Search",
        "Google Images",
        "Google News",
        "Google Shopping",
        "YouTube",
        "Wikipedia",
        "TikTok",
        "Amazon",
        "Pinterest",
        "npm",
        "Python",
        "Steam",
        "App Downloads",
        "App Rankings"
      ],
      "type": "string"
    }
  },
  "required": [
    "mode",
    "source",
    "keyword"
  ],
  "type": "object"
}