page

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/customer-io/main/json-schema/customer-io-page-schema.json",
  "title": "page",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/customer-io-page-api-openapi.yml#/components/schemas/page",
  "x-scalar-ignore": true,
  "oneOf": [
    {
      "title": "Known User",
      "allOf": [
        {
          "type": "object",
          "required": [
            "userId"
          ],
          "properties": {
            "userId": {
              "$ref": "#/$defs/userId"
            },
            "type": {
              "type": "string",
              "enum": [
                "page"
              ],
              "description": "The event type. This is set automatically by the request method/endpoint."
            },
            "name": {
              "type": "string",
              "description": "The name of the page."
            },
            "properties": {
              "type": "object",
              "description": "Additional `page` properties. Analytics.js automatically collects `url`, `title`, `referrer`, `path`, and `search` properties. But, if you use our other sources or you write your own integration, you should consider sending these properties yourself. Destination actions that take `page` events often rely on the `url` and `title` properties.",
              "properties": {
                "category": {
                  "type": "string",
                  "description": "The category of the page. This might be useful if you have a single page routes or have a flattened URL structure."
                },
                "url": {
                  "type": "string",
                  "description": "The URL of the page. This defaults to a canonical url if available, and falls back to `document.location.href`."
                },
                "title": {
                  "type": "string",
                  "description": "The title of the page. This defaults to `document.title`, but can be overridden."
                },
                "referrer": {
                  "type": "string",
                  "description": "The referrer of the page, if applicable. This defaults to `document.referrer`, but can be overridden."
                },
                "path": {
                  "type": "string",
                  "description": "The path of the page. This defaults to `location.pathname`, but can be overridden."
                },
                "search": {
                  "type": "string",
                  "description": "The search query in the URL, if present. This defaults to `location.search`, but can be overridden."
                }
              },
              "additionalProperties": {
                "x-additionalPropertiesName": "Page Properties"
              }
            }
          }
        },
        {
          "$ref": "#/$defs/page_common_fields"
        }
      ]
    },
    {
      "title": "Anonymous User",
      "allOf": [
        {
          "type": "object",
          "required": [
            "anonymousId"
          ],
          "properties": {
            "anonymousId": {
              "$ref": "#/$defs/anonymousId"
            },
            "type": {
              "type": "string",
              "enum": [
                "page"
              ],
              "description": "The event type. This is set automatically by the request method/endpoint."
            },
            "name": {
              "type": "string",
              "description": "The name of the page."
            },
            "properties": {
              "type": "object",
              "description": "Additional properties for your event.",
              "properties": {
                "category": {
                  "type": "string",
                  "description": "The category of the page. This might be useful if you have a single page routes or have a flattened URL structure."
                },
                "url": {
                  "type": "string",
                  "description": "The URL of the page."
                },
                "title": {
                  "type": "string",
                  "description": "The title of the page. This defaults to `document.title`, but can be overridden."
                },
                "referrer": {
                  "type": "string",
                  "description": "The referrer of the page, if applicable. This defaults to document.referrer, but can be overridden."
                },
                "path": {
                  "type": "string",
                  "description": "The path of the page. This defaults to location.pathname, but can be overridden."
                },
                "search": {
                  "type": "string",
                  "description": "The search query in the URL, if present. This defaults to location.search, but can be overridden."
                }
              },
              "additionalProperties": {
                "x-additionalPropertiesName": "Page Properties"
              }
            }
          }
        },
        {
          "$ref": "#/$defs/page_common_fields"
        }
      ]
    }
  ],
  "$defs": {
    "anonymousId": {
      "x-scalar-ignore": true,
      "type": "string",
      "description": "A unique substitute for a User ID in cases when you don’t have an absolutely unique identifier. Our libraries generate this value automatically to help you track people before they sign up, log in, provide their email, etc."
    },
    "common_fields": {
      "x-scalar-ignore": true,
      "type": "object",
      "properties": {
        "integrations": {
          "$ref": "#/$defs/integrations"
        },
        "messageId": {
          "type": "string",
          "description": "A unique identifier for a Data Pipelines call, ensuring that each individual event is unique. This is set by Customer.io"
        },
        "receivedAt": {
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "description": "The ISO-8601 timestamp when Data Pipelines receives an event."
        },
        "sentAt": {
          "type": "string",
          "format": "date-time",
          "description": "The ISO-8601 timestamp when a library sends an event to Data Pipelines."
        },
        "originalTimestamp": {
          "type": "string",
          "format": "date-time",
          "description": "In general, you can use `timestamp` rather than this field if you want to back-date events. This is the timestamp on the client device you invoke a call or the timestamp value you manually passed in a server-side library call."
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "description": "The ISO-8601 timestamp when the event originally took place. This is mostly useful when you backfill past events. If you're not backfilling data, you can leave this field empty and we'll use the current time or server time."
        },
        "type": {
          "readOnly": true,
          "type": "string",
          "enum": [
            "identify",
            "group",
            "track",
            "page",
            "screen",
            "alias"
          ],
          "description": "The type of source event. This is implicit and set by Customer.io based on the endpoint/method you use (e.g. `identify`)."
        },
        "version": {
          "readOnly": true,
          "type": "number",
          "description": "The version of the API that received the event, automatically set by Customer.io."
        }
      }
    },
    "context_common": {
      "x-scalar-ignore": true,
      "type": "object",
      "description": "Contains contextual information about the event.",
      "properties": {
        "active": {
          "type": "boolean",
          "description": "Whether a user is active.\n\nThis is usually used when you send an .identify() call to update the traits independently of when you've “last seen” a user.\n"
        },
        "ip": {
          "type": "string",
          "description": "The user's IP address. This isn't captured by our libraries, but by our servers when we receive client-side events (like from our JavaScript source)."
        },
        "locale": {
          "type": "string",
          "description": "The locale string for the current user, e.g. `en-US`."
        },
        "userAgent": {
          "type": "string",
          "description": "The user agent of the device making the request"
        },
        "channel": {
          "type": "string",
          "enum": [
            "browser",
            "server",
            "mobile"
          ],
          "description": "The channel the event originated from."
        }
      }
    },
    "context_non_mobile": {
      "x-scalar-ignore": true,
      "description": "A dictionary of context about a source call/event, like the user’s IP address or locale. Context is automatically collected by our source libraries.",
      "title": "Non-mobile",
      "allOf": [
        {
          "$ref": "#/$defs/context_common"
        },
        {
          "type": "object",
          "properties": {
            "campaign": {
              "type": "object",
              "description": "Contains information about the campaign that resulted in the API call, gathered from, or mapping to, UTM parameters (e.g. `utm_source`).\n",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The campaign name."
                },
                "source": {
                  "type": "string",
                  "description": "The source of traffic—like the name of your email list, Facebook, Google, etc."
                },
                "medium": {
                  "type": "string",
                  "description": "The type of traffic a person/event originates from, like `email`, or `referral`."
                },
                "term": {
                  "type": "string",
                  "description": "The keyword term(s) a user came from."
                },
                "content": {
                  "type": "string"
                }
              },
              "additionalProperties": {
                "type": "string",
                "x-additionalPropertiesName": "Additional UTM Parameters"
              }
            },
            "page": {
              "$ref": "#/$defs/context_page"
            }
          }
        }
      ]
    },
    "context_page": {
      "x-scalar-ignore": true,
      "type": "object",
      "description": "Contains information about the current page in the browser. This is automatically collected by our JavaScript source.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the page. Reserved for future use.\n"
        },
        "path": {
          "type": "string",
          "description": "The path portion of the page's URL. Equivalent to the canonical `path` which defaults to `location.pathname` from the DOM API."
        },
        "referrer": {
          "type": "string",
          "description": "The previous page's full URL. Equivalent to `document.referrer` from the DOM API."
        },
        "search": {
          "type": "string",
          "description": "The query string portion of the page's URL. Equivalent to `location.search` from the DOM API."
        },
        "title": {
          "type": "string",
          "description": "The page's title. Equivalent to `document.title` from the DOM API."
        },
        "url": {
          "type": "string",
          "description": "A page's full URL. We first look for the canonical URL. If the canonical URL is not provided, we'll use `location.href` from the DOM API."
        },
        "keywords": {
          "type": "array",
          "description": "A list/array of keywords describing the page's content. The keywords are likely the same as, or similar to, the keywords you would find in an HTML `meta` tag for SEO purposes. This property is mainly used by content publishers that rely heavily on pageview tracking. This isn't automatically collected.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "integrations": {
      "x-scalar-ignore": true,
      "type": "object",
      "description": "Contains a list of booleans indicating the integrations that are enabled (true) or disabled (false). By default, all integrations are enabled (returning an empty object). Set `\"All\": false` to reverse this behavior.\n",
      "additionalProperties": {
        "type": "boolean",
        "x-additionalPropertiesName": "Enabled/Disabled integrations"
      }
    },
    "page_common_fields": {
      "x-scalar-ignore": true,
      "allOf": [
        {
          "$ref": "#/$defs/common_fields"
        },
        {
          "type": "object",
          "properties": {
            "context": {
              "$ref": "#/$defs/context_non_mobile"
            }
          }
        }
      ]
    },
    "userId": {
      "x-scalar-ignore": true,
      "type": "string",
      "description": "The unique identifier for a person. This value should be unique across systems, so you recognize the same person in your sources _and_ destinations."
    }
  }
}