Umami · Schema

WebsitePage

Cookieless TrackingOpen SourcePrivacyWeb AnalyticsWebsite AnalyticsProduct AnalyticsEvent TrackingSelf-HostedGDPRSession ReplayHeatmapsMarketing Attribution

Properties

Name Type Description
count integer Number of matching records.
data array Data returned by the operation.
orderBy string Field to sort the results by.
page integer Page number, starting at 1.
pageSize integer Number of results per page.
search string Search text used to filter results.
View JSON Schema on GitHub

JSON Schema

umami-website-page-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/umami/main/json-schema/umami-website-page-schema.json",
  "title": "WebsitePage",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/umami-openapi.yml#/components/schemas/WebsitePage",
  "additionalProperties": false,
  "properties": {
    "count": {
      "description": "Number of matching records.",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "data": {
      "description": "Data returned by the operation.",
      "items": {
        "$ref": "#/$defs/Website"
      },
      "type": "array"
    },
    "orderBy": {
      "description": "Field to sort the results by.",
      "type": "string"
    },
    "page": {
      "description": "Page number, starting at 1.",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "type": "integer"
    },
    "pageSize": {
      "description": "Number of results per page.",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "search": {
      "description": "Search text used to filter results.",
      "type": "string"
    }
  },
  "required": [
    "data",
    "count",
    "page",
    "pageSize"
  ],
  "type": "object",
  "$defs": {
    "ReplayConfig": {
      "additionalProperties": {},
      "properties": {
        "blockSelector": {
          "description": "CSS selector for elements excluded from recordings.",
          "type": "string"
        },
        "heatmapEnabled": {
          "description": "Whether heatmap recording is enabled.",
          "type": "boolean"
        },
        "heatmapSampleRate": {
          "description": "Fraction of sessions to record for heatmaps, from 0 to 1.",
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        },
        "maskLevel": {
          "description": "Privacy masking level used by the recorder: strict or moderate.",
          "enum": [
            "strict",
            "moderate"
          ],
          "type": "string"
        },
        "maxDuration": {
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991,
          "type": "integer"
        },
        "replayEnabled": {
          "description": "Whether session replay recording is enabled.",
          "type": "boolean"
        },
        "sampleRate": {
          "description": "Fraction of sessions to record for replay, from 0 to 1.",
          "maximum": 1,
          "minimum": 0,
          "type": "number"
        }
      },
      "type": "object"
    },
    "Website": {
      "additionalProperties": false,
      "properties": {
        "createdAt": {
          "anyOf": [
            {
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Date and time the record was created."
        },
        "createdBy": {
          "anyOf": [
            {
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "ID of the user who created the resource."
        },
        "deletedAt": {
          "anyOf": [
            {
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Date and time the record was deleted, if applicable."
        },
        "domain": {
          "description": "Domain name associated with the resource.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier of the resource.",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
          "type": "string"
        },
        "name": {
          "description": "Display name of the resource.",
          "type": "string"
        },
        "recorderEnabled": {
          "description": "Whether recording is enabled for the website.",
          "type": "boolean"
        },
        "replayConfig": {
          "anyOf": [
            {
              "$ref": "#/$defs/ReplayConfig"
            },
            {
              "type": "null"
            }
          ],
          "description": "Session replay and heatmap recording configuration."
        },
        "resetAt": {
          "anyOf": [
            {
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Date and time the website analytics were last reset."
        },
        "shareId": {
          "description": "Identifier used to access a shared resource.",
          "type": [
            "string",
            "null"
          ]
        },
        "teamId": {
          "anyOf": [
            {
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "ID of the associated team."
        },
        "updatedAt": {
          "anyOf": [
            {
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Date and time the record was last updated."
        },
        "user": {
          "$ref": "#/$defs/WebsiteUser",
          "description": "User associated with the resource."
        },
        "userId": {
          "anyOf": [
            {
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "ID of the associated user."
        }
      },
      "required": [
        "id",
        "name",
        "domain",
        "resetAt",
        "userId",
        "teamId",
        "createdBy",
        "createdAt",
        "updatedAt",
        "deletedAt",
        "recorderEnabled",
        "replayConfig",
        "shareId"
      ],
      "type": "object"
    },
    "WebsiteUser": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "description": "Unique identifier of the resource.",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
          "type": "string"
        },
        "username": {
          "description": "Username of the account.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "username"
      ],
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/umami-website-page"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.