segment · Schema

PageCall

A page call records a page view on a website.

Properties

Name	Type	Description
userId	string	Unique identifier for the user in your database.
anonymousId	string	A pseudo-unique substitute for a user ID.
name	string	Name of the page.
properties	object	Free-form dictionary of properties of the page.
context	object
integrations	object
timestamp	string	ISO 8601 date string when the message was originally sent.
messageId	string	Unique identifier for the message to deduplicate.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PageCall",
  "title": "PageCall",
  "type": "object",
  "description": "A page call records a page view on a website.",
  "properties": {
    "userId": {
      "type": "string",
      "description": "Unique identifier for the user in your database."
    },
    "anonymousId": {
      "type": "string",
      "description": "A pseudo-unique substitute for a user ID."
    },
    "name": {
      "type": "string",
      "description": "Name of the page."
    },
    "properties": {
      "type": "object",
      "description": "Free-form dictionary of properties of the page.",
      "properties": {
        "path": {
          "type": "string",
          "description": "The path portion of the page URL."
        },
        "referrer": {
          "type": "string",
          "format": "uri",
          "description": "The referrer URL."
        },
        "search": {
          "type": "string",
          "description": "The search query string of the URL."
        },
        "title": {
          "type": "string",
          "description": "The page title."
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "The full URL of the page."
        }
      },
      "additionalProperties": true
    },
    "context": {
      "$ref": "#/components/schemas/Context"
    },
    "integrations": {
      "$ref": "#/components/schemas/Integrations"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 date string when the message was originally sent."
    },
    "messageId": {
      "type": "string",
      "description": "Unique identifier for the message to deduplicate."
    }
  }
}