Umami · Schema

WebsiteList

Paginated list of websites

Cookieless TrackingOpen SourcePrivacyWeb AnalyticsWebsite Analytics

Properties

Name Type Description
data array
count integer Total number of records
page integer Current page number
pageSize integer Records per page
View JSON Schema on GitHub

JSON Schema

umami-website-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12",
  "$id": "https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-website-list-schema.json",
  "title": "WebsiteList",
  "description": "Paginated list of websites",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Website"
      }
    },
    "count": {
      "type": "integer",
      "description": "Total number of records",
      "examples": [
        5
      ]
    },
    "page": {
      "type": "integer",
      "description": "Current page number",
      "examples": [
        1
      ]
    },
    "pageSize": {
      "type": "integer",
      "description": "Records per page",
      "examples": [
        20
      ]
    }
  }
}