CookiePilot – cookie banner & Consent Mode v2

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "setup_token"
  ],
  "properties": {
    "hostname": {
      "type": "string",
      "maxLength": 253,
      "description": "Website hostname, e.g. example.com; defaults to the website given to create_account"
    },
    "setup_token": {
      "type": "string",
      "maxLength": 200,
      "minLength": 10,
      "description": "setup_token returned by create_account"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "minLength": 3,
      "description": "Website address, e.g. https://example.com or example.com"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "setup_token"
  ],
  "properties": {
    "setup_token": {
      "type": "string",
      "maxLength": 200,
      "minLength": 10,
      "description": "setup_token returned by create_account"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "setup_token"
  ],
  "properties": {
    "colors": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string",
          "maxLength": 80
        },
        "border": {
          "type": "string",
          "maxLength": 80
        },
        "overlay": {
          "type": "string",
          "maxLength": 80
        },
        "primary": {
          "type": "string",
          "maxLength": 80
        },
        "background": {
          "type": "string",
          "maxLength": 80
        },
        "primaryText": {
          "type": "string",
          "maxLength": 80
        }
      },
      "description": "CSS colours (hex or rgb/rgba); missing keys keep their current value",
      "additionalProperties": false
    },
    "layout": {
      "enum": [
        "BAR",
        "BOX",
        "MODAL"
      ],
      "type": "string"
    },
    "hostname": {
      "type": "string",
      "maxLength": 253,
      "description": "Website hostname, e.g. example.com; defaults to the website given to create_account"
    },
    "position": {
      "enum": [
        "TOP",
        "BOTTOM",
        "CENTER"
      ],
      "type": "string"
    },
    "font_family": {
      "type": "string",
      "maxLength": 200,
      "description": "e.g. \"Inter, sans-serif\""
    },
    "setup_token": {
      "type": "string",
      "maxLength": 200,
      "minLength": 10,
      "description": "setup_token returned by create_account"
    },
    "privacy_policy_url": {
      "type": "string",
      "maxLength": 2000,
      "description": "Link to the site's privacy policy"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email",
    "organization_name"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "description": "The user's own e-mail address"
    },
    "locale": {
      "type": "string",
      "maxLength": 10,
      "description": "Language of the CookiePilot panel and currency of prices: \"pl\" = PLN, any other = EUR. One of: en, pl, de, fr, es, it, nl, pt, sv, cs, ro, el, hu, sk, bg, hr, sl, et, lv, lt. Defaults to \"en\"."
    },
    "website": {
      "type": "string",
      "maxLength": 253,
      "description": "The website the banner is for, e.g. example.com"
    },
    "organization_name": {
      "type": "string",
      "maxLength": 100,
      "description": "The user's company or project name, plain text without web or e-mail addresses"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "platform"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "maxLength": 10,
      "description": "Language of the CookiePilot panel and currency of prices: \"pl\" = PLN, any other = EUR. One of: en, pl, de, fr, es, it, nl, pt, sv, cs, ro, el, hu, sk, bg, hr, sl, et, lv, lt. Defaults to \"en\"."
    },
    "hostname": {
      "type": "string",
      "maxLength": 253,
      "description": "Website hostname, e.g. example.com; defaults to the website given to create_account"
    },
    "platform": {
      "enum": [
        "html",
        "wordpress",
        "woocommerce",
        "prestashop",
        "gtm",
        "shoper"
      ],
      "type": "string",
      "description": "Install method, usually recommendedInstallMethod from analyze_site"
    },
    "setup_token": {
      "type": "string",
      "maxLength": 200,
      "minLength": 10,
      "description": "setup_token returned by create_account"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "monthly_pageviews"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "maxLength": 10,
      "description": "Language of the CookiePilot panel and currency of prices: \"pl\" = PLN, any other = EUR. One of: en, pl, de, fr, es, it, nl, pt, sv, cs, ro, el, hu, sk, bg, hr, sl, et, lv, lt. Defaults to \"en\"."
    },
    "domains": {
      "type": "integer",
      "default": 1,
      "maximum": 1000,
      "minimum": 1,
      "description": "Number of websites (domains)"
    },
    "monthly_pageviews": {
      "type": "integer",
      "maximum": 1000000000,
      "minimum": 0,
      "description": "Monthly pageviews across all the user's sites, as stated by the user"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "setup_token",
    "plan"
  ],
  "properties": {
    "plan": {
      "enum": [
        "pro",
        "business"
      ],
      "type": "string"
    },
    "period": {
      "enum": [
        "monthly",
        "yearly"
      ],
      "type": "string",
      "default": "monthly"
    },
    "setup_token": {
      "type": "string",
      "maxLength": 200,
      "minLength": 10,
      "description": "setup_token returned by create_account"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "setup_token"
  ],
  "properties": {
    "hostname": {
      "type": "string",
      "maxLength": 253,
      "description": "Website hostname, e.g. example.com; defaults to the website given to create_account"
    },
    "setup_token": {
      "type": "string",
      "maxLength": 200,
      "minLength": 10,
      "description": "setup_token returned by create_account"
    }
  },
  "additionalProperties": false
}