Capturable variables for JavaScript API

The various capture methods used by Personalization can be modified based on your website’s needs by replacing the following variables:

  • <category>: The event descriptor you want to associate with the page view. For more information about creating categories for your use, see Creating and managing events.

  • <parameter>: An information type collecting other custom data about an event, such as the length of a viewed video. Commonly used parameters include the following:

    • author: Author of a piece of content a visitor viewed

    • content_keywords: Maps to a Drupal keyword taxonomy when the Personalization Drupal module is used

    • content_type: Content-type to which a piece of visitor-viewed content belongs

    • content_title: Title of a piece of content a visitor viewed

    • content_section: Section or category associated with a piece of content (for example, technology)

    • site_id: Your websites using Personalization (for more information, see Customer sites)

    • engagement_score: Number you have chosen to signify the importance of a visitor’s interest in the event (for example, viewing a webpage may have an engagement score of 1, and viewing a webinar may have an engagement score of 20)

    • page_type: Category of page the visitor viewed (examples include article page, tag page, and home page)

    • persona: User-defined category into which a visitor fits, based on their viewing of particular content

    • post_id: Unique identifier for a piece of content (for example, 10000324)

    • published_date: Date and time a piece of content was published

    Although each parameter can have only a single value, you can include several parameters to provide more values, separating each parameter and value pair by commas.

    You can also enter parameters based on the following user-defined fields made available by Personalization (where <i> is the user-defined field you want to use, such as touch_udf3):

    • person_udf: User-defined field for a person, with up to 50 fields for values

    • touch_udf: User-defined field for a touch, with up to 20 fields for values

    • event_udf: User-defined field for an event, with up to 50 fields for values


    Personalization also includes another method called identity that also accepts parameters. Using this method enables you to send more information about the website visitor along with the page view to Personalization. For information about using the identity method, see Capturing visitor identity information.

  • <value>: The value you want to assign to a parameter.

For more information about parameters, see the Field layouts section of the Data warehouse documentation.