webinfo.schema.json

{
  "meta:license": [
    "Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$id": "https://ns.adobe.com/xdm/context/webinfo",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Web information",
  "type": "object",
  "meta:status": "stable",
  "meta:extensible": true,
  "description": "",
  "definitions": {
    "webinfo": {
      "properties": {
        "xdm:webPageDetails": {
          "title": "Web page details",
          "type": "object",
          "description": "Details about the web page where the web interaction occurred.",
          "properties": {
            "xdm:siteSection": {
              "title": "Site section",
              "type": "string",
              "description": "The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction.",
              "meta:titleId": "webinfo##xdm:siteSection##title##15001",
              "meta:descriptionId": "webinfo##xdm:siteSection##description##23341"
            },
            "xdm:name": {
              "title": "Name",
              "type": "string",
              "description": "The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes.",
              "meta:titleId": "webinfo##xdm:name##title##24651",
              "meta:descriptionId": "webinfo##xdm:name##description##40671"
            },
            "xdm:viewName": {
              "title": "View Name",
              "type": "string",
              "description": "The name of the view, within a page. This is commonly used with Single Page Applications or pages that have tabs or controls that change a majority of the page layout.",
              "meta:titleId": "webinfo##xdm:viewName##title##36831",
              "meta:descriptionId": "webinfo##xdm:viewName##description##98571"
            },
            "xdm:URL": {
              "title": "URL",
              "type": "string",
              "description": "The normative or usual URL of the web page.  This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`.",
              "meta:titleId": "webinfo##xdm:URL##title##29541",
              "meta:descriptionId": "webinfo##xdm:URL##description##92831"
            },
            "xdm:server": {
              "title": "Server",
              "type": "string",
              "description": "The normative or usual server that hosts the web page.  This may or may not be the host or server that actually served the page interaction, but is used for classification purposes.",
              "meta:titleId": "webinfo##xdm:server##title##94071",
              "meta:descriptionId": "webinfo##xdm:server##description##57071"
            },
            "xdm:isErrorPage": {
              "title": "Is error page",
              "type": "boolean",
              "description": "Flag that indicate if the page is error page or not.  Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code.  This flag is used to broadly categorize web interactions.",
              "meta:titleId": "webinfo##xdm:isErrorPage##title##27791",
              "meta:descriptionId": "webinfo##xdm:isErrorPage##description##10941"
            },
            "xdm:isHomePage": {
              "title": "Is home page",
              "type": "boolean",
              "description": "Flag that indicate if the page is the site home page or not.  The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point.  This flag is used to broadly categorize web interactions.",
              "meta:titleId": "webinfo##xdm:isHomePage##title##9601",
              "meta:descriptionId": "webinfo##xdm:isHomePage##description##11801"
            },
            "xdm:isPreRendered": {
              "title": "Is pre-rendered",
              "type": "boolean",
              "description": "Flag that indicates if the page has been pre-rendered or partially pre-rendered prior to being viewed."
            },
            "xdm:pageViews": {
              "title": "Page Views",
              "$ref": "https://ns.adobe.com/xdm/data/measure",
              "description": "View(s) of a webpage has occurred.",
              "meta:titleId": "webinfo##xdm:pageViews##title##2321",
              "meta:descriptionId": "webinfo##xdm:pageViews##description##71941"
            }
          },
          "meta:titleId": "webinfo##xdm:webPageDetails##title##46881",
          "meta:descriptionId": "webinfo##xdm:webPageDetails##description##93641"
        },
        "xdm:webInteraction": {
          "title": "Web interaction",
          "type": "object",
          "description": "Details about the web link or URL that corresponds to where the interaction occurred.",
          "properties": {
            "xdm:type": {
              "title": "Type",
              "type": "string",
              "description": "The link type.",
              "enum": ["download", "exit", "other"],
              "meta:enum": {
                "download": "Download",
                "exit": "Exit",
                "other": "Other"
              },
              "meta:titleId": "webinfo##xdm:type##title##29511",
              "meta:descriptionId": "webinfo##xdm:type##description##48491"
            },
            "xdm:URL": {
              "title": "URL",
              "type": "string",
              "description": "The actual link or URL used for this web interaction.",
              "meta:titleId": "webinfo##xdm:URL##title##33971",
              "meta:descriptionId": "webinfo##xdm:URL##description##44571"
            },
            "xdm:name": {
              "title": "Name",
              "type": "string",
              "description": "The normative name used for this web link, used for classification purposes.",
              "meta:titleId": "webinfo##xdm:name##title##72971",
              "meta:descriptionId": "webinfo##xdm:name##description##40881"
            },
            "xdm:region": {
              "title": "Region",
              "type": "string",
              "description": "The region name represents the region or area of a document that the web link belongs to such as header or footer.",
              "meta:titleId": "webinfo##xdm:region##title##24931",
              "meta:descriptionId": "webinfo##xdm:region##description##45421"
            },
            "xdm:linkClicks": {
              "title": "Link Clicks",
              "$ref": "https://ns.adobe.com/xdm/data/measure",
              "description": "Click of a web link has occurred.",
              "meta:titleId": "webinfo##xdm:linkClicks##title##2051",
              "meta:descriptionId": "webinfo##xdm:linkClicks##description##86871"
            }
          },
          "meta:titleId": "webinfo##xdm:webInteraction##title##25791",
          "meta:descriptionId": "webinfo##xdm:webInteraction##description##53901"
        },
        "xdm:webReferrer": {
          "title": "Web referrer",
          "type": "object",
          "description": "The referrer of a web interaction, which is the URL a visitor came from immediately before the current web interaction was recorded.",
          "properties": {
            "xdm:URL": {
              "title": "URL",
              "type": "string",
              "description": "The referrer URL.",
              "meta:titleId": "webinfo##xdm:URL##title##99951",
              "meta:descriptionId": "webinfo##xdm:URL##description##66211"
            },
            "xdm:type": {
              "title": "Type",
              "type": "string",
              "description": "The referrer type.",
              "enum": [
                "internal",
                "external",
                "search_engine",
                "typed_bookmarked",
                "email",
                "social",
                "usenet",
                "hard_drive",
                "nojs",
                "conversational_ai",
                "unknown"
              ],
              "meta:enum": {
                "internal": "Internal",
                "external": "External",
                "search_engine": "Search engine",
                "typed_bookmarked": "Typed or bookmarked",
                "email": "Email",
                "social": "Social network",
                "hard_drive": "Hard Drive",
                "usenet": "Usenet newsgroup",
                "nojs": "No JS",
                "conversational_ai": "Conversational AI",
                "unknown": "Unknown"
              },
              "meta:titleId": "webinfo##xdm:type##title##17421",
              "meta:descriptionId": "webinfo##xdm:type##description##31751"
            }
          },
          "meta:titleId": "webinfo##xdm:webReferrer##title##93931",
          "meta:descriptionId": "webinfo##xdm:webReferrer##description##45151"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/webinfo"
    }
  ],
  "meta:createdDate": "2021-02-19",
  "meta:titleId": "webinfo##title##87241",
  "meta:descriptionId": "webinfo##description##1021"
}