search

adobe / spacecat-api-service

Edge Delivery services experience success as a service automation: SpaceCat + Star Catalogue
Apache License 2.0
4 stars 3 forks source link

docs(api): cwv schema changes to support groups and site metrics #574

Open ekremney opened 3 days ago

ekremney commented 3 days ago

cwv schema changes to support groups and site metrics.

how it looks like:

cwv schema

Example JSON:

{
  "siteMetrics": {
    "performanceScore": 82.5,
    "bounceRate": 47.3
  },
  "pageMetrics": [
    {
      "type": "group",
      "name": "Homepage Group",
      "pattern": "https://www.aem.live/home*",
      "pageviews": 4620,
      "metrics": [
        {
          "deviceType": "mobile",
          "lcp": 2099.7,
          "lcpCount": 9,
          "cls": 0.02066,
          "clsCount": 7,
          "inp": 12,
          "inpCount": 3,
          "ttfb": 520.45,
          "ttfbCount": 18
        },
        {
          "deviceType": "desktop",
          "lcp": 1800.5,
          "lcpCount": 8,
          "cls": 0.015,
          "clsCount": 6,
          "inp": 10,
          "inpCount": 2,
          "ttfb": 480.3,
          "ttfbCount": 15
        }
      ]
    },
    {
      "type": "group",
      "name": "Developer Pages",
      "pattern": "https://www.aem.live/developer/*",
      "pageviews": 3000,
      "metrics": [
        {
          "deviceType": "mobile",
          "lcp": 612.1,
          "lcpCount": 4,
          "cls": 0.001,
          "clsCount": 4,
          "inp": 20,
          "inpCount": 2,
          "ttfb": 122.9,
          "ttfbCount": 4
        },
        {
          "deviceType": "desktop",
          "lcp": 490.2,
          "lcpCount": 3,
          "cls": 0.0008,
          "clsCount": 3,
          "inp": 18,
          "inpCount": 1,
          "ttfb": 115.7,
          "ttfbCount": 3
        }
      ]
    },
    {
      "type": "url",
      "url": "https://www.aem.live/home",
      "pageviews": 2620,
      "metrics": [
        {
          "deviceType": "mobile",
          "lcp": 2099.7,
          "lcpCount": 9,
          "cls": 0.02066,
          "clsCount": 7,
          "inp": 12,
          "inpCount": 3,
          "ttfb": 520.45,
          "ttfbCount": 18
        },
        {
          "deviceType": "desktop",
          "lcp": 1800.5,
          "lcpCount": 8,
          "cls": 0.015,
          "clsCount": 6,
          "inp": 10,
          "inpCount": 2,
          "ttfb": 480.3,
          "ttfbCount": 15
        }
      ]
    },
    {
      "type": "url",
      "url": "https://www.aem.live/developer/block-collection",
      "pageviews": 2000,
      "metrics": [
        {
          "deviceType": "mobile",
          "lcp": 512.1,
          "lcpCount": 4,
          "cls": 0.0005,
          "clsCount": 4,
          "inp": 20,
          "inpCount": 2,
          "ttfb": 122.9,
          "ttfbCount": 4
        },
        {
          "deviceType": "desktop",
          "lcp": 490.2,
          "lcpCount": 3,
          "cls": 0.0008,
          "clsCount": 3,
          "inp": 18,
          "inpCount": 1,
          "ttfb": 115.7,
          "ttfbCount": 3
        }
      ]
    }
  ]
}