{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/bol-com/json-schema/bol-com-product-ranks-schema.json",
  "title": "ProductRanks",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bol-com-insights-api-openapi.yml#/components/schemas/ProductRanks",
  "required": [
    "hasNextPage",
    "ranks"
  ],
  "type": "object",
  "properties": {
    "ranks": {
      "type": "array",
      "description": "The list of ranks associated with the product.",
      "items": {
        "$ref": "#/$defs/Rank"
      }
    },
    "hasNextPage": {
      "type": "boolean",
      "description": "Indicator if there is a next page of ranks (true/false)."
    }
  },
  "$defs": {
    "Rank": {
      "required": [
        "impressions",
        "rank",
        "wasSponsored"
      ],
      "type": "object",
      "properties": {
        "categoryId": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ID of the category to which the product belongs."
        },
        "searchTerm": {
          "type": [
            "string",
            "null"
          ],
          "description": "Search term related to the rank."
        },
        "wasSponsored": {
          "type": "boolean",
          "description": "Indicator if the product is sponsored or not."
        },
        "rank": {
          "type": "integer",
          "description": "The rank of the product in the category or search page.",
          "format": "int32"
        },
        "impressions": {
          "type": "integer",
          "description": "Number of viewable impressions of the product.",
          "format": "int32"
        }
      },
      "description": "The list of ranks associated with the product."
    }
  }
}