Contentful Personalization & Analytics
    Preparing search index...

    Parameters used when updating an existing profile.

    interface UpdateProfileParams {
        events: (
            | {
                anonymousId?: string;
                channel: "server"
                | "mobile"
                | "web";
                context: {
                    app?: { name: string; version: string };
                    campaign: {
                        content?: string;
                        medium?: string;
                        name?: string;
                        source?: string;
                        term?: string;
                    };
                    gdpr?: { isConsentGiven: boolean };
                    library: { name: string; version: string };
                    locale?: string;
                    location?: {
                        city?: string;
                        continent?: string;
                        coordinates?: { latitude: number; longitude: number };
                        country?: string;
                        countryCode?: string;
                        postalCode?: string;
                        region?: string;
                        regionCode?: string;
                        timezone?: string;
                    };
                    page?: {
                        path: string;
                        query: Record<string, string | string[]>;
                        referrer: string;
                        search: string;
                        title?: string;
                        url: string;
                        [key: string]: JSONType;
                    };
                    screen?: { name: string; [key: string]: JSONType };
                    userAgent?: string;
                };
                entityId: string;
                entityKind: "Experience"
                | "ExperienceFragment";
                entityKindId?: string;
                entryIds?: string[];
                messageId: string;
                optimizationId?: string;
                originalTimestamp: string;
                parameters?: Record<string, JSONType>;
                parentExperienceId?: string;
                parentVariantId?: string;
                sentAt: string;
                timestamp: string;
                type: "exo_node_view";
                userId?: string;
                variantId?: string;
                variantIndex?: number;
                viewDurationMs: number;
                viewId: string;
            }
            | {
                anonymousId?: string;
                channel: "server"
                | "mobile"
                | "web";
                context: {
                    app?: { name: string; version: string };
                    campaign: {
                        content?: string;
                        medium?: string;
                        name?: string;
                        source?: string;
                        term?: string;
                    };
                    gdpr?: { isConsentGiven: boolean };
                    library: { name: string; version: string };
                    locale?: string;
                    location?: {
                        city?: string;
                        continent?: string;
                        coordinates?: { latitude: number; longitude: number };
                        country?: string;
                        countryCode?: string;
                        postalCode?: string;
                        region?: string;
                        regionCode?: string;
                        timezone?: string;
                    };
                    page?: {
                        path: string;
                        query: Record<string, string | string[]>;
                        referrer: string;
                        search: string;
                        title?: string;
                        url: string;
                        [key: string]: JSONType;
                    };
                    screen?: { name: string; [key: string]: JSONType };
                    userAgent?: string;
                };
                messageId: string;
                originalTimestamp: string;
                sentAt: string;
                timestamp: string;
                traits: Record<string, JSONType>;
                type: "identify";
                userId: string;
            }
            | {
                anonymousId?: string;
                channel: "server"
                | "mobile"
                | "web";
                context: {
                    app?: { name: string; version: string };
                    campaign: {
                        content?: string;
                        medium?: string;
                        name?: string;
                        source?: string;
                        term?: string;
                    };
                    gdpr?: { isConsentGiven: boolean };
                    library: { name: string; version: string };
                    locale?: string;
                    location?: {
                        city?: string;
                        continent?: string;
                        coordinates?: { latitude: number; longitude: number };
                        country?: string;
                        countryCode?: string;
                        postalCode?: string;
                        region?: string;
                        regionCode?: string;
                        timezone?: string;
                    };
                    page?: {
                        path: string;
                        query: Record<string, string | string[]>;
                        referrer: string;
                        search: string;
                        title?: string;
                        url: string;
                        [key: string]: JSONType;
                    };
                    userAgent?: string;
                };
                messageId: string;
                name?: string;
                originalTimestamp: string;
                properties: {
                    path: string;
                    query: Record<string, string | string[]>;
                    referrer: string;
                    search: string;
                    title: string;
                    url: string;
                    [key: string]: JSONType;
                };
                sentAt: string;
                timestamp: string;
                type: "page";
                userId?: string;
            }
            | {
                anonymousId?: string;
                channel: "server"
                | "mobile"
                | "web";
                context: {
                    app?: { name: string; version: string };
                    campaign: {
                        content?: string;
                        medium?: string;
                        name?: string;
                        source?: string;
                        term?: string;
                    };
                    gdpr?: { isConsentGiven: boolean };
                    library: { name: string; version: string };
                    locale?: string;
                    location?: {
                        city?: string;
                        continent?: string;
                        coordinates?: { latitude: number; longitude: number };
                        country?: string;
                        countryCode?: string;
                        postalCode?: string;
                        region?: string;
                        regionCode?: string;
                        timezone?: string;
                    };
                    screen: { name: string; [key: string]: JSONType };
                    userAgent?: string;
                };
                messageId: string;
                name: string;
                originalTimestamp: string;
                properties?: Record<string, JSONType>;
                sentAt: string;
                timestamp: string;
                type: "screen";
                userId?: string;
            }
            | {
                anonymousId?: string;
                channel: "server"
                | "mobile"
                | "web";
                context: {
                    app?: { name: string; version: string };
                    campaign: {
                        content?: string;
                        medium?: string;
                        name?: string;
                        source?: string;
                        term?: string;
                    };
                    gdpr?: { isConsentGiven: boolean };
                    library: { name: string; version: string };
                    locale?: string;
                    location?: {
                        city?: string;
                        continent?: string;
                        coordinates?: { latitude: number; longitude: number };
                        country?: string;
                        countryCode?: string;
                        postalCode?: string;
                        region?: string;
                        regionCode?: string;
                        timezone?: string;
                    };
                    page?: {
                        path: string;
                        query: Record<string, string | string[]>;
                        referrer: string;
                        search: string;
                        title?: string;
                        url: string;
                        [key: string]: JSONType;
                    };
                    screen?: { name: string; [key: string]: JSONType };
                    userAgent?: string;
                };
                event: string;
                messageId: string;
                originalTimestamp: string;
                properties: Record<string, JSONType>;
                sentAt: string;
                timestamp: string;
                type: "track";
                userId?: string;
            }
            | {
                anonymousId?: string;
                channel: "server"
                | "mobile"
                | "web";
                componentId: string;
                componentType?: "Entry" | "Variable";
                context: {
                    app?: { name: string; version: string };
                    campaign: {
                        content?: string;
                        medium?: string;
                        name?: string;
                        source?: string;
                        term?: string;
                    };
                    gdpr?: { isConsentGiven: boolean };
                    library: { name: string; version: string };
                    locale?: string;
                    location?: {
                        city?: string;
                        continent?: string;
                        coordinates?: { latitude: number; longitude: number };
                        country?: string;
                        countryCode?: string;
                        postalCode?: string;
                        region?: string;
                        regionCode?: string;
                        timezone?: string;
                    };
                    page?: {
                        path: string;
                        query: Record<string, string | string[]>;
                        referrer: string;
                        search: string;
                        title?: string;
                        url: string;
                        [key: string]: JSONType;
                    };
                    screen?: { name: string; [key: string]: JSONType };
                    userAgent?: string;
                };
                experienceId?: string;
                messageId: string;
                originalTimestamp: string;
                sentAt: string;
                timestamp: string;
                type: "component";
                userId?: string;
                variantIndex?: number;
                viewDurationMs?: number;
                viewId?: string;
            }
        )[];
        profileId: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Properties

    events: (
        | {
            anonymousId?: string;
            channel: "server"
            | "mobile"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr?: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale?: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string | string[]>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            entityId: string;
            entityKind: "Experience"
            | "ExperienceFragment";
            entityKindId?: string;
            entryIds?: string[];
            messageId: string;
            optimizationId?: string;
            originalTimestamp: string;
            parameters?: Record<string, JSONType>;
            parentExperienceId?: string;
            parentVariantId?: string;
            sentAt: string;
            timestamp: string;
            type: "exo_node_view";
            userId?: string;
            variantId?: string;
            variantIndex?: number;
            viewDurationMs: number;
            viewId: string;
        }
        | {
            anonymousId?: string;
            channel: "server"
            | "mobile"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr?: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale?: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string | string[]>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            traits: Record<string, JSONType>;
            type: "identify";
            userId: string;
        }
        | {
            anonymousId?: string;
            channel: "server"
            | "mobile"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr?: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale?: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string | string[]>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                userAgent?: string;
            };
            messageId: string;
            name?: string;
            originalTimestamp: string;
            properties: {
                path: string;
                query: Record<string, string | string[]>;
                referrer: string;
                search: string;
                title: string;
                url: string;
                [key: string]: JSONType;
            };
            sentAt: string;
            timestamp: string;
            type: "page";
            userId?: string;
        }
        | {
            anonymousId?: string;
            channel: "server"
            | "mobile"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr?: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale?: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                screen: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            messageId: string;
            name: string;
            originalTimestamp: string;
            properties?: Record<string, JSONType>;
            sentAt: string;
            timestamp: string;
            type: "screen";
            userId?: string;
        }
        | {
            anonymousId?: string;
            channel: "server"
            | "mobile"
            | "web";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr?: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale?: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string | string[]>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            event: string;
            messageId: string;
            originalTimestamp: string;
            properties: Record<string, JSONType>;
            sentAt: string;
            timestamp: string;
            type: "track";
            userId?: string;
        }
        | {
            anonymousId?: string;
            channel: "server"
            | "mobile"
            | "web";
            componentId: string;
            componentType?: "Entry" | "Variable";
            context: {
                app?: { name: string; version: string };
                campaign: {
                    content?: string;
                    medium?: string;
                    name?: string;
                    source?: string;
                    term?: string;
                };
                gdpr?: { isConsentGiven: boolean };
                library: { name: string; version: string };
                locale?: string;
                location?: {
                    city?: string;
                    continent?: string;
                    coordinates?: { latitude: number; longitude: number };
                    country?: string;
                    countryCode?: string;
                    postalCode?: string;
                    region?: string;
                    regionCode?: string;
                    timezone?: string;
                };
                page?: {
                    path: string;
                    query: Record<string, string | string[]>;
                    referrer: string;
                    search: string;
                    title?: string;
                    url: string;
                    [key: string]: JSONType;
                };
                screen?: { name: string; [key: string]: JSONType };
                userAgent?: string;
            };
            experienceId?: string;
            messageId: string;
            originalTimestamp: string;
            sentAt: string;
            timestamp: string;
            type: "component";
            userId?: string;
            variantIndex?: number;
            viewDurationMs?: number;
            viewId?: string;
        }
    )[]

    Events used to aggregate the profile state.

    Type Declaration

    • {
          anonymousId?: string;
          channel: "server" | "mobile" | "web";
          context: {
              app?: { name: string; version: string };
              campaign: {
                  content?: string;
                  medium?: string;
                  name?: string;
                  source?: string;
                  term?: string;
              };
              gdpr?: { isConsentGiven: boolean };
              library: { name: string; version: string };
              locale?: string;
              location?: {
                  city?: string;
                  continent?: string;
                  coordinates?: { latitude: number; longitude: number };
                  country?: string;
                  countryCode?: string;
                  postalCode?: string;
                  region?: string;
                  regionCode?: string;
                  timezone?: string;
              };
              page?: {
                  path: string;
                  query: Record<string, string | string[]>;
                  referrer: string;
                  search: string;
                  title?: string;
                  url: string;
                  [key: string]: JSONType;
              };
              screen?: { name: string; [key: string]: JSONType };
              userAgent?: string;
          };
          entityId: string;
          entityKind: "Experience"
          | "ExperienceFragment";
          entityKindId?: string;
          entryIds?: string[];
          messageId: string;
          optimizationId?: string;
          originalTimestamp: string;
          parameters?: Record<string, JSONType>;
          parentExperienceId?: string;
          parentVariantId?: string;
          sentAt: string;
          timestamp: string;
          type: "exo_node_view";
          userId?: string;
          variantId?: string;
          variantIndex?: number;
          viewDurationMs: number;
          viewId: string;
      }
      • OptionalanonymousId?: string

        Anonymous identifier of the visitor, if the caller supplies one.

        Optional. The Experience API profile endpoints derive it from the request route, and batch ingestion requires it (see BatchExperienceEvent).

      • channel: "server" | "mobile" | "web"

        Channel from which the event originated.

      • context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr?: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale?: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string | string[]>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        }

        Context object carrying environment and client metadata.

        • Optionalapp?: { name: string; version: string }

          Application-level metadata.

          • name: string

            Name of the application.

          • version: string

            Version of the application.

        • campaign: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          }

          Campaign attribution metadata.

          • Optionalcontent?: string

            Campaign content (e.g., utm_content).

          • Optionalmedium?: string

            Campaign medium (e.g., utm_medium).

          • Optionalname?: string

            Name of the campaign (e.g., utm_campaign).

          • Optionalsource?: string

            Campaign source (e.g., utm_source).

          • Optionalterm?: string

            Campaign term (e.g., utm_term).

        • Optionalgdpr?: { isConsentGiven: boolean }

          GDPR-related consent information.

          Optional and informational: the Experience and Insights APIs do not read it. Consent is enforced by the SDK before events are sent.

          • isConsentGiven: boolean

            Indicates whether the user has given consent.

        • library: { name: string; version: string }

          Analytics library metadata.

          • name: string

            Name of the SDK/library (e.g., "@contentful/optimization-web").

          • version: string

            Version of the analytics library.

        • Optionallocale?: string

          Locale identifier of the event (e.g., "en-US").

          "en-US"

        • Optionallocation?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          }

          Optional geo-location information associated with the event.

          • Optionalcity?: string

            City name associated with the location.

          • Optionalcontinent?: string

            Continent name associated with the location.

          • Optionalcoordinates?: { latitude: number; longitude: number }

            Geographical coordinates for the location.

            • latitude: number

              Latitude component of the coordinates.

            • longitude: number

              Longitude component of the coordinates.

          • Optionalcountry?: string

            Country name associated with the location.

          • OptionalcountryCode?: string

            Country code associated with the location.

            Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

          • OptionalpostalCode?: string

            Postal or ZIP code associated with the location.

          • Optionalregion?: string

            Region or state name associated with the location.

          • OptionalregionCode?: string

            Region or state code associated with the location.

          • Optionaltimezone?: string

            Time zone identifier associated with the location.

            Typically an IANA time zone string (e.g., "Europe/Berlin").

        • Optionalpage?: {
              path: string;
              query: Record<string, string | string[]>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          }
          • path: string

            Path component of the page URL (e.g., /products/123).

          • query: Record<string, string | string[]>

            Parsed query parameters for the page.

            Query

          • referrer: string

            Referrer URL that led to the current page.

          • search: string

            Raw search string including the leading ? (e.g., "?q=test").

          • Optionaltitle?: string

            Title of the page as seen by the user.

          • url: string

            Full URL of the page.

        • Optionalscreen?: { name: string; [key: string]: JSONType }
          • name: string

            Name or label for the screen.

        • OptionaluserAgent?: string

          User agent string of the client, if available.

      • entityId: string

        Identifier of the rendered ExO entity.

      • entityKind: "Experience" | "ExperienceFragment"

        Kind of ExO entity represented by this event.

      • OptionalentityKindId?: string

        Optional identifier of the entity's concrete content kind.

      • OptionalentryIds?: string[]

        Contentful entry identifiers rendered by the entity.

      • messageId: string

        Unique identifier for this message.

        Used to deduplicate events across retries and transports.

      • OptionaloptimizationId?: string

        Identifier of the optimization that selected the entity variant, when available.

      • originalTimestamp: string

        Timestamp when the event originally occurred.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • Optionalparameters?: Record<string, JSONType>

        Parameter values used to render the entity.

      • OptionalparentExperienceId?: string

        Identifier of the containing experience, when the entity is nested.

      • OptionalparentVariantId?: string

        Selected variant of the root experience, or default for its baseline. Omitted on the experience itself.

      • sentAt: string

        Timestamp when the event payload was sent.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • timestamp: string

        Timestamp when the event was recorded or processed.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • type: "exo_node_view"
      • OptionaluserId?: string

        Identifier of the authenticated user, if known.

      • OptionalvariantId?: string

        Identifier of the selected entity variant, when available.

      • OptionalvariantIndex?: number

        Index of the selected variant when available.

      • viewDurationMs: number
      • viewId: string
    • {
          anonymousId?: string;
          channel: "server" | "mobile" | "web";
          context: {
              app?: { name: string; version: string };
              campaign: {
                  content?: string;
                  medium?: string;
                  name?: string;
                  source?: string;
                  term?: string;
              };
              gdpr?: { isConsentGiven: boolean };
              library: { name: string; version: string };
              locale?: string;
              location?: {
                  city?: string;
                  continent?: string;
                  coordinates?: { latitude: number; longitude: number };
                  country?: string;
                  countryCode?: string;
                  postalCode?: string;
                  region?: string;
                  regionCode?: string;
                  timezone?: string;
              };
              page?: {
                  path: string;
                  query: Record<string, string | string[]>;
                  referrer: string;
                  search: string;
                  title?: string;
                  url: string;
                  [key: string]: JSONType;
              };
              screen?: { name: string; [key: string]: JSONType };
              userAgent?: string;
          };
          messageId: string;
          originalTimestamp: string;
          sentAt: string;
          timestamp: string;
          traits: Record<string, JSONType>;
          type: "identify";
          userId: string;
      }
      • OptionalanonymousId?: string

        Anonymous identifier of the visitor, if the caller supplies one.

        Optional. The Experience API profile endpoints derive it from the request route, and batch ingestion requires it (see BatchExperienceEvent).

      • channel: "server" | "mobile" | "web"

        Channel from which the event originated.

      • context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr?: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale?: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string | string[]>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        }

        Context object carrying environment and client metadata.

        • Optionalapp?: { name: string; version: string }

          Application-level metadata.

          • name: string

            Name of the application.

          • version: string

            Version of the application.

        • campaign: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          }

          Campaign attribution metadata.

          • Optionalcontent?: string

            Campaign content (e.g., utm_content).

          • Optionalmedium?: string

            Campaign medium (e.g., utm_medium).

          • Optionalname?: string

            Name of the campaign (e.g., utm_campaign).

          • Optionalsource?: string

            Campaign source (e.g., utm_source).

          • Optionalterm?: string

            Campaign term (e.g., utm_term).

        • Optionalgdpr?: { isConsentGiven: boolean }

          GDPR-related consent information.

          Optional and informational: the Experience and Insights APIs do not read it. Consent is enforced by the SDK before events are sent.

          • isConsentGiven: boolean

            Indicates whether the user has given consent.

        • library: { name: string; version: string }

          Analytics library metadata.

          • name: string

            Name of the SDK/library (e.g., "@contentful/optimization-web").

          • version: string

            Version of the analytics library.

        • Optionallocale?: string

          Locale identifier of the event (e.g., "en-US").

          "en-US"

        • Optionallocation?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          }

          Optional geo-location information associated with the event.

          • Optionalcity?: string

            City name associated with the location.

          • Optionalcontinent?: string

            Continent name associated with the location.

          • Optionalcoordinates?: { latitude: number; longitude: number }

            Geographical coordinates for the location.

            • latitude: number

              Latitude component of the coordinates.

            • longitude: number

              Longitude component of the coordinates.

          • Optionalcountry?: string

            Country name associated with the location.

          • OptionalcountryCode?: string

            Country code associated with the location.

            Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

          • OptionalpostalCode?: string

            Postal or ZIP code associated with the location.

          • Optionalregion?: string

            Region or state name associated with the location.

          • OptionalregionCode?: string

            Region or state code associated with the location.

          • Optionaltimezone?: string

            Time zone identifier associated with the location.

            Typically an IANA time zone string (e.g., "Europe/Berlin").

        • Optionalpage?: {
              path: string;
              query: Record<string, string | string[]>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          }
          • path: string

            Path component of the page URL (e.g., /products/123).

          • query: Record<string, string | string[]>

            Parsed query parameters for the page.

            Query

          • referrer: string

            Referrer URL that led to the current page.

          • search: string

            Raw search string including the leading ? (e.g., "?q=test").

          • Optionaltitle?: string

            Title of the page as seen by the user.

          • url: string

            Full URL of the page.

        • Optionalscreen?: { name: string; [key: string]: JSONType }
          • name: string

            Name or label for the screen.

        • OptionaluserAgent?: string

          User agent string of the client, if available.

      • messageId: string

        Unique identifier for this message.

        Used to deduplicate events across retries and transports.

      • originalTimestamp: string

        Timestamp when the event originally occurred.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • sentAt: string

        Timestamp when the event payload was sent.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • timestamp: string

        Timestamp when the event was recorded or processed.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • traits: Record<string, JSONType>

        Traits describing the user.

        Traits

      • type: "identify"

        Discriminator indicating that this event is an identify event.

      • userId: string

        Identifier of the user being identified.

        Required for identify events, as the Experience API requires it.

    • {
          anonymousId?: string;
          channel: "server" | "mobile" | "web";
          context: {
              app?: { name: string; version: string };
              campaign: {
                  content?: string;
                  medium?: string;
                  name?: string;
                  source?: string;
                  term?: string;
              };
              gdpr?: { isConsentGiven: boolean };
              library: { name: string; version: string };
              locale?: string;
              location?: {
                  city?: string;
                  continent?: string;
                  coordinates?: { latitude: number; longitude: number };
                  country?: string;
                  countryCode?: string;
                  postalCode?: string;
                  region?: string;
                  regionCode?: string;
                  timezone?: string;
              };
              page?: {
                  path: string;
                  query: Record<string, string | string[]>;
                  referrer: string;
                  search: string;
                  title?: string;
                  url: string;
                  [key: string]: JSONType;
              };
              userAgent?: string;
          };
          messageId: string;
          name?: string;
          originalTimestamp: string;
          properties: {
              path: string;
              query: Record<string, string | string[]>;
              referrer: string;
              search: string;
              title: string;
              url: string;
              [key: string]: JSONType;
          };
          sentAt: string;
          timestamp: string;
          type: "page";
          userId?: string;
      }
      • OptionalanonymousId?: string

        Anonymous identifier of the visitor, if the caller supplies one.

        Optional. The Experience API profile endpoints derive it from the request route, and batch ingestion requires it (see BatchExperienceEvent).

      • channel: "server" | "mobile" | "web"

        Channel from which the event originated.

      • context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr?: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale?: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string | string[]>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            userAgent?: string;
        }

        Override the context property of UniversalEventProperties with a page-specific context.

        • Optionalapp?: { name: string; version: string }

          Application-level metadata.

          • name: string

            Name of the application.

          • version: string

            Version of the application.

        • campaign: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          }

          Campaign attribution metadata.

          • Optionalcontent?: string

            Campaign content (e.g., utm_content).

          • Optionalmedium?: string

            Campaign medium (e.g., utm_medium).

          • Optionalname?: string

            Name of the campaign (e.g., utm_campaign).

          • Optionalsource?: string

            Campaign source (e.g., utm_source).

          • Optionalterm?: string

            Campaign term (e.g., utm_term).

        • Optionalgdpr?: { isConsentGiven: boolean }

          GDPR-related consent information.

          Optional and informational: the Experience and Insights APIs do not read it. Consent is enforced by the SDK before events are sent.

          • isConsentGiven: boolean

            Indicates whether the user has given consent.

        • library: { name: string; version: string }

          Analytics library metadata.

          • name: string

            Name of the SDK/library (e.g., "@contentful/optimization-web").

          • version: string

            Version of the analytics library.

        • Optionallocale?: string

          Locale identifier of the event (e.g., "en-US").

          "en-US"

        • Optionallocation?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          }

          Optional geo-location information associated with the event.

          • Optionalcity?: string

            City name associated with the location.

          • Optionalcontinent?: string

            Continent name associated with the location.

          • Optionalcoordinates?: { latitude: number; longitude: number }

            Geographical coordinates for the location.

            • latitude: number

              Latitude component of the coordinates.

            • longitude: number

              Longitude component of the coordinates.

          • Optionalcountry?: string

            Country name associated with the location.

          • OptionalcountryCode?: string

            Country code associated with the location.

            Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

          • OptionalpostalCode?: string

            Postal or ZIP code associated with the location.

          • Optionalregion?: string

            Region or state name associated with the location.

          • OptionalregionCode?: string

            Region or state code associated with the location.

          • Optionaltimezone?: string

            Time zone identifier associated with the location.

            Typically an IANA time zone string (e.g., "Europe/Berlin").

        • Optionalpage?: {
              path: string;
              query: Record<string, string | string[]>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          }

          Page context for events that occur within a web page.

          Optional, as the Experience API defaults it to an empty page. The Experience API reads the session landing page and page-based audience rules from it, so send it whenever the page is known.

          • path: string

            Path component of the page URL (e.g., /products/123).

          • query: Record<string, string | string[]>

            Parsed query parameters for the page.

            Query

          • referrer: string

            Referrer URL that led to the current page.

          • search: string

            Raw search string including the leading ? (e.g., "?q=test").

          • Optionaltitle?: string

            Title of the page as seen by the user.

          • url: string

            Full URL of the page.

        • OptionaluserAgent?: string

          User agent string of the client, if available.

      • messageId: string

        Unique identifier for this message.

        Used to deduplicate events across retries and transports.

      • Optionalname?: string

        Optional name for the page.

        Useful when the logical page name differs from the URL or title.

      • originalTimestamp: string

        Timestamp when the event originally occurred.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • properties: {
            path: string;
            query: Record<string, string | string[]>;
            referrer: string;
            search: string;
            title: string;
            url: string;
            [key: string]: JSONType;
        }

        Page-level properties such as URL, path, and referrer.

        title is required here, as the Experience API rejects page events without it.

        • path: string

          Path component of the page URL (e.g., /products/123).

        • query: Record<string, string | string[]>

          Parsed query parameters for the page.

          Query

        • referrer: string

          Referrer URL that led to the current page.

        • search: string

          Raw search string including the leading ? (e.g., "?q=test").

        • title: string
        • url: string

          Full URL of the page.

      • sentAt: string

        Timestamp when the event payload was sent.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • timestamp: string

        Timestamp when the event was recorded or processed.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • type: "page"

        Discriminator indicating that this event is a page view.

      • OptionaluserId?: string

        Identifier of the authenticated user, if known.

    • {
          anonymousId?: string;
          channel: "server" | "mobile" | "web";
          context: {
              app?: { name: string; version: string };
              campaign: {
                  content?: string;
                  medium?: string;
                  name?: string;
                  source?: string;
                  term?: string;
              };
              gdpr?: { isConsentGiven: boolean };
              library: { name: string; version: string };
              locale?: string;
              location?: {
                  city?: string;
                  continent?: string;
                  coordinates?: { latitude: number; longitude: number };
                  country?: string;
                  countryCode?: string;
                  postalCode?: string;
                  region?: string;
                  regionCode?: string;
                  timezone?: string;
              };
              screen: { name: string; [key: string]: JSONType };
              userAgent?: string;
          };
          messageId: string;
          name: string;
          originalTimestamp: string;
          properties?: Record<string, JSONType>;
          sentAt: string;
          timestamp: string;
          type: "screen";
          userId?: string;
      }
      • OptionalanonymousId?: string

        Anonymous identifier of the visitor, if the caller supplies one.

        Optional. The Experience API profile endpoints derive it from the request route, and batch ingestion requires it (see BatchExperienceEvent).

      • channel: "server" | "mobile" | "web"

        Channel from which the event originated.

      • context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr?: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale?: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            screen: { name: string; [key: string]: JSONType };
            userAgent?: string;
        }

        Override the context property of UniversalEventProperties with a screen-specific context.

        • Optionalapp?: { name: string; version: string }

          Application-level metadata.

          • name: string

            Name of the application.

          • version: string

            Version of the application.

        • campaign: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          }

          Campaign attribution metadata.

          • Optionalcontent?: string

            Campaign content (e.g., utm_content).

          • Optionalmedium?: string

            Campaign medium (e.g., utm_medium).

          • Optionalname?: string

            Name of the campaign (e.g., utm_campaign).

          • Optionalsource?: string

            Campaign source (e.g., utm_source).

          • Optionalterm?: string

            Campaign term (e.g., utm_term).

        • Optionalgdpr?: { isConsentGiven: boolean }

          GDPR-related consent information.

          Optional and informational: the Experience and Insights APIs do not read it. Consent is enforced by the SDK before events are sent.

          • isConsentGiven: boolean

            Indicates whether the user has given consent.

        • library: { name: string; version: string }

          Analytics library metadata.

          • name: string

            Name of the SDK/library (e.g., "@contentful/optimization-web").

          • version: string

            Version of the analytics library.

        • Optionallocale?: string

          Locale identifier of the event (e.g., "en-US").

          "en-US"

        • Optionallocation?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          }

          Optional geo-location information associated with the event.

          • Optionalcity?: string

            City name associated with the location.

          • Optionalcontinent?: string

            Continent name associated with the location.

          • Optionalcoordinates?: { latitude: number; longitude: number }

            Geographical coordinates for the location.

            • latitude: number

              Latitude component of the coordinates.

            • longitude: number

              Longitude component of the coordinates.

          • Optionalcountry?: string

            Country name associated with the location.

          • OptionalcountryCode?: string

            Country code associated with the location.

            Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

          • OptionalpostalCode?: string

            Postal or ZIP code associated with the location.

          • Optionalregion?: string

            Region or state name associated with the location.

          • OptionalregionCode?: string

            Region or state code associated with the location.

          • Optionaltimezone?: string

            Time zone identifier associated with the location.

            Typically an IANA time zone string (e.g., "Europe/Berlin").

        • screen: { name: string; [key: string]: JSONType }

          Screen context for events that occur within a mobile or TV application.

          • name: string

            Name or label for the screen.

        • OptionaluserAgent?: string

          User agent string of the client, if available.

      • messageId: string

        Unique identifier for this message.

        Used to deduplicate events across retries and transports.

      • name: string

        Name of the screen being viewed.

      • originalTimestamp: string

        Timestamp when the event originally occurred.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • Optionalproperties?: Record<string, JSONType>

        Optional properties describing the screen context.

      • sentAt: string

        Timestamp when the event payload was sent.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • timestamp: string

        Timestamp when the event was recorded or processed.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • type: "screen"

        Discriminator indicating that this event is a screen view.

      • OptionaluserId?: string

        Identifier of the authenticated user, if known.

    • {
          anonymousId?: string;
          channel: "server" | "mobile" | "web";
          context: {
              app?: { name: string; version: string };
              campaign: {
                  content?: string;
                  medium?: string;
                  name?: string;
                  source?: string;
                  term?: string;
              };
              gdpr?: { isConsentGiven: boolean };
              library: { name: string; version: string };
              locale?: string;
              location?: {
                  city?: string;
                  continent?: string;
                  coordinates?: { latitude: number; longitude: number };
                  country?: string;
                  countryCode?: string;
                  postalCode?: string;
                  region?: string;
                  regionCode?: string;
                  timezone?: string;
              };
              page?: {
                  path: string;
                  query: Record<string, string | string[]>;
                  referrer: string;
                  search: string;
                  title?: string;
                  url: string;
                  [key: string]: JSONType;
              };
              screen?: { name: string; [key: string]: JSONType };
              userAgent?: string;
          };
          event: string;
          messageId: string;
          originalTimestamp: string;
          properties: Record<string, JSONType>;
          sentAt: string;
          timestamp: string;
          type: "track";
          userId?: string;
      }
      • OptionalanonymousId?: string

        Anonymous identifier of the visitor, if the caller supplies one.

        Optional. The Experience API profile endpoints derive it from the request route, and batch ingestion requires it (see BatchExperienceEvent).

      • channel: "server" | "mobile" | "web"

        Channel from which the event originated.

      • context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr?: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale?: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string | string[]>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        }

        Context object carrying environment and client metadata.

        • Optionalapp?: { name: string; version: string }

          Application-level metadata.

          • name: string

            Name of the application.

          • version: string

            Version of the application.

        • campaign: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          }

          Campaign attribution metadata.

          • Optionalcontent?: string

            Campaign content (e.g., utm_content).

          • Optionalmedium?: string

            Campaign medium (e.g., utm_medium).

          • Optionalname?: string

            Name of the campaign (e.g., utm_campaign).

          • Optionalsource?: string

            Campaign source (e.g., utm_source).

          • Optionalterm?: string

            Campaign term (e.g., utm_term).

        • Optionalgdpr?: { isConsentGiven: boolean }

          GDPR-related consent information.

          Optional and informational: the Experience and Insights APIs do not read it. Consent is enforced by the SDK before events are sent.

          • isConsentGiven: boolean

            Indicates whether the user has given consent.

        • library: { name: string; version: string }

          Analytics library metadata.

          • name: string

            Name of the SDK/library (e.g., "@contentful/optimization-web").

          • version: string

            Version of the analytics library.

        • Optionallocale?: string

          Locale identifier of the event (e.g., "en-US").

          "en-US"

        • Optionallocation?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          }

          Optional geo-location information associated with the event.

          • Optionalcity?: string

            City name associated with the location.

          • Optionalcontinent?: string

            Continent name associated with the location.

          • Optionalcoordinates?: { latitude: number; longitude: number }

            Geographical coordinates for the location.

            • latitude: number

              Latitude component of the coordinates.

            • longitude: number

              Longitude component of the coordinates.

          • Optionalcountry?: string

            Country name associated with the location.

          • OptionalcountryCode?: string

            Country code associated with the location.

            Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

          • OptionalpostalCode?: string

            Postal or ZIP code associated with the location.

          • Optionalregion?: string

            Region or state name associated with the location.

          • OptionalregionCode?: string

            Region or state code associated with the location.

          • Optionaltimezone?: string

            Time zone identifier associated with the location.

            Typically an IANA time zone string (e.g., "Europe/Berlin").

        • Optionalpage?: {
              path: string;
              query: Record<string, string | string[]>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          }
          • path: string

            Path component of the page URL (e.g., /products/123).

          • query: Record<string, string | string[]>

            Parsed query parameters for the page.

            Query

          • referrer: string

            Referrer URL that led to the current page.

          • search: string

            Raw search string including the leading ? (e.g., "?q=test").

          • Optionaltitle?: string

            Title of the page as seen by the user.

          • url: string

            Full URL of the page.

        • Optionalscreen?: { name: string; [key: string]: JSONType }
          • name: string

            Name or label for the screen.

        • OptionaluserAgent?: string

          User agent string of the client, if available.

      • event: string

        Name of the event being tracked.

      • messageId: string

        Unique identifier for this message.

        Used to deduplicate events across retries and transports.

      • originalTimestamp: string

        Timestamp when the event originally occurred.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • properties: Record<string, JSONType>

        Additional properties describing the event.

      • sentAt: string

        Timestamp when the event payload was sent.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • timestamp: string

        Timestamp when the event was recorded or processed.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • type: "track"

        Discriminator indicating that this event is a track event.

      • OptionaluserId?: string

        Identifier of the authenticated user, if known.

    • {
          anonymousId?: string;
          channel: "server" | "mobile" | "web";
          componentId: string;
          componentType?: "Entry" | "Variable";
          context: {
              app?: { name: string; version: string };
              campaign: {
                  content?: string;
                  medium?: string;
                  name?: string;
                  source?: string;
                  term?: string;
              };
              gdpr?: { isConsentGiven: boolean };
              library: { name: string; version: string };
              locale?: string;
              location?: {
                  city?: string;
                  continent?: string;
                  coordinates?: { latitude: number; longitude: number };
                  country?: string;
                  countryCode?: string;
                  postalCode?: string;
                  region?: string;
                  regionCode?: string;
                  timezone?: string;
              };
              page?: {
                  path: string;
                  query: Record<string, string | string[]>;
                  referrer: string;
                  search: string;
                  title?: string;
                  url: string;
                  [key: string]: JSONType;
              };
              screen?: { name: string; [key: string]: JSONType };
              userAgent?: string;
          };
          experienceId?: string;
          messageId: string;
          originalTimestamp: string;
          sentAt: string;
          timestamp: string;
          type: "component";
          userId?: string;
          variantIndex?: number;
          viewDurationMs?: number;
          viewId?: string;
      }
      • OptionalanonymousId?: string

        Anonymous identifier of the visitor, if the caller supplies one.

        Optional. The Experience API profile endpoints derive it from the request route, and batch ingestion requires it (see BatchExperienceEvent).

      • channel: "server" | "mobile" | "web"

        Channel from which the event originated.

      • componentId: string

        Contentful entry ID or flag key corresponding to the interaction.

      • OptionalcomponentType?: "Entry" | "Variable"

        Type of tracked optimization target for the interaction event.

        • 'Entry' — A content entry.
        • 'Variable' — A Custom Flag or other variable-backed optimization target.

        Optional in the schema, as the Experience and Insights APIs accept events without it. The SDK always sends it.

      • context: {
            app?: { name: string; version: string };
            campaign: {
                content?: string;
                medium?: string;
                name?: string;
                source?: string;
                term?: string;
            };
            gdpr?: { isConsentGiven: boolean };
            library: { name: string; version: string };
            locale?: string;
            location?: {
                city?: string;
                continent?: string;
                coordinates?: { latitude: number; longitude: number };
                country?: string;
                countryCode?: string;
                postalCode?: string;
                region?: string;
                regionCode?: string;
                timezone?: string;
            };
            page?: {
                path: string;
                query: Record<string, string | string[]>;
                referrer: string;
                search: string;
                title?: string;
                url: string;
                [key: string]: JSONType;
            };
            screen?: { name: string; [key: string]: JSONType };
            userAgent?: string;
        }

        Context object carrying environment and client metadata.

        • Optionalapp?: { name: string; version: string }

          Application-level metadata.

          • name: string

            Name of the application.

          • version: string

            Version of the application.

        • campaign: {
              content?: string;
              medium?: string;
              name?: string;
              source?: string;
              term?: string;
          }

          Campaign attribution metadata.

          • Optionalcontent?: string

            Campaign content (e.g., utm_content).

          • Optionalmedium?: string

            Campaign medium (e.g., utm_medium).

          • Optionalname?: string

            Name of the campaign (e.g., utm_campaign).

          • Optionalsource?: string

            Campaign source (e.g., utm_source).

          • Optionalterm?: string

            Campaign term (e.g., utm_term).

        • Optionalgdpr?: { isConsentGiven: boolean }

          GDPR-related consent information.

          Optional and informational: the Experience and Insights APIs do not read it. Consent is enforced by the SDK before events are sent.

          • isConsentGiven: boolean

            Indicates whether the user has given consent.

        • library: { name: string; version: string }

          Analytics library metadata.

          • name: string

            Name of the SDK/library (e.g., "@contentful/optimization-web").

          • version: string

            Version of the analytics library.

        • Optionallocale?: string

          Locale identifier of the event (e.g., "en-US").

          "en-US"

        • Optionallocation?: {
              city?: string;
              continent?: string;
              coordinates?: { latitude: number; longitude: number };
              country?: string;
              countryCode?: string;
              postalCode?: string;
              region?: string;
              regionCode?: string;
              timezone?: string;
          }

          Optional geo-location information associated with the event.

          • Optionalcity?: string

            City name associated with the location.

          • Optionalcontinent?: string

            Continent name associated with the location.

          • Optionalcoordinates?: { latitude: number; longitude: number }

            Geographical coordinates for the location.

            • latitude: number

              Latitude component of the coordinates.

            • longitude: number

              Longitude component of the coordinates.

          • Optionalcountry?: string

            Country name associated with the location.

          • OptionalcountryCode?: string

            Country code associated with the location.

            Validated to exactly COUNTRY_CODE_LENGTH characters, typically an ISO 3166-1 alpha-2 code.

          • OptionalpostalCode?: string

            Postal or ZIP code associated with the location.

          • Optionalregion?: string

            Region or state name associated with the location.

          • OptionalregionCode?: string

            Region or state code associated with the location.

          • Optionaltimezone?: string

            Time zone identifier associated with the location.

            Typically an IANA time zone string (e.g., "Europe/Berlin").

        • Optionalpage?: {
              path: string;
              query: Record<string, string | string[]>;
              referrer: string;
              search: string;
              title?: string;
              url: string;
              [key: string]: JSONType;
          }
          • path: string

            Path component of the page URL (e.g., /products/123).

          • query: Record<string, string | string[]>

            Parsed query parameters for the page.

            Query

          • referrer: string

            Referrer URL that led to the current page.

          • search: string

            Raw search string including the leading ? (e.g., "?q=test").

          • Optionaltitle?: string

            Title of the page as seen by the user.

          • url: string

            Full URL of the page.

        • Optionalscreen?: { name: string; [key: string]: JSONType }
          • name: string

            Name or label for the screen.

        • OptionaluserAgent?: string

          User agent string of the client, if available.

      • OptionalexperienceId?: string

        Identifier of the experience that rendered this entry or flag.

        Optional; interactions can occur outside of a specific experiment/personalization.

      • messageId: string

        Unique identifier for this message.

        Used to deduplicate events across retries and transports.

      • originalTimestamp: string

        Timestamp when the event originally occurred.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • sentAt: string

        Timestamp when the event payload was sent.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • timestamp: string

        Timestamp when the event was recorded or processed.

        Any date string the Experience API can parse; the SDK sends ISO 8601.

      • type: "component"

        Discriminator indicating that this is an entry or flag view event.

      • OptionaluserId?: string

        Identifier of the authenticated user, if known.

      • OptionalvariantIndex?: number

        Index of the variant associated with this interaction.

        Typically corresponds to the index of the selected optimization entry. Optional in the schema, as the Experience and Insights APIs accept events without it. The SDK always sends it.

      • OptionalviewDurationMs?: number

        Monotonically increasing visible duration for the active view.

        This value is updated and re-emitted while the same view remains active.

      • OptionalviewId?: string

        UUID identifying a single active view session.

        Multiple events emitted for the same active view share this identifier.

    profileId: string

    ID of the profile to update.