RankIntelligenceResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/harpd-com/json-schema/harpd-com-rank-intelligence-response-schema.json",
  "title": "RankIntelligenceResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/harpd-com-openapi.json#/components/schemas/RankIntelligenceResponse",
  "type": "object",
  "required": [
    "request_id",
    "resource",
    "generated_at",
    "scope",
    "category",
    "summary",
    "products",
    "methodology"
  ],
  "properties": {
    "request_id": {
      "type": "string"
    },
    "resource": {
      "const": "rank-intelligence-v1"
    },
    "generated_at": {
      "type": "string",
      "format": "date-time"
    },
    "scope": {
      "type": "string",
      "enum": [
        "overall",
        "monthly",
        "weekly"
      ]
    },
    "category": {
      "type": "string"
    },
    "summary": {
      "type": "object",
      "properties": {
        "eligible_products": {
          "type": "integer"
        },
        "returned_products": {
          "type": "integer",
          "maximum": 100
        },
        "top_100_threshold_rp": {
          "type": "integer"
        },
        "approved_in_period": {
          "type": "integer"
        }
      },
      "required": [
        "eligible_products",
        "returned_products",
        "top_100_threshold_rp",
        "approved_in_period"
      ]
    },
    "products": {
      "type": "array",
      "maxItems": 100,
      "items": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "position": {
            "type": "integer"
          },
          "previous_position": {
            "type": [
              "integer",
              "null"
            ]
          },
          "movement": {
            "type": "string"
          },
          "rank_points": {
            "type": "integer"
          },
          "promotional_rank_points": {
            "type": "integer"
          },
          "history": {
            "type": "array"
          }
        },
        "required": [
          "slug",
          "title",
          "category",
          "position",
          "movement",
          "rank_points",
          "promotional_rank_points",
          "history"
        ]
      }
    },
    "methodology": {
      "type": "object"
    }
  }
}