WebBasedContext

  • campaign
    Type: object · Campaign

    The campaign that resulted in the interaction. Campaign dictionary contains standard UTM parameters: name, source, medium, term, content. We use campaign information to infer users' interests and fine-tune the personalization and search results based on the current user's campaign information.

    • content
      Type: string · Content

      Content of the campaign that identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link. It is often used for A/B testing and content-targeted ads. Identifies search terms. (see UTM parameters)

    • medium
      Type: string · Medium

      Medium of the campaign that identifies what type of link was used, such as cost per click or email. (see UTM parameters)

    • name
      Type: string · Name

      Name of the campaign. Identifies a specific product promotion or strategic campaign. (see UTM parameters)

    • source
      Type: string · Source

      Source of the campaign. Identifies which site sent the traffic. (see UTM parameters)

    • term
      Type: string · Term

      Term of the campaign that identifies search terms. (see UTM parameters)

  • custom_context
    Type: object · Custom Context

    Dictionary of custom context variables for the current browsing session. You can specify context variables specific to your websites or apps in a {"KEY":VALUE} format, where KEY must be a string, and VALUE can be:

    • a bool
    • a string or an array of string
    • a number or an array of numbers
    • an array of objects
    • null

    Miso will take these variables into account when generating recommendations.

    • propertyName
      • Type: boolean
  • locale
    Type: string · Locale

    Locale string of the current session, for example en-US.

  • page
    Type: object · Page

    The current page in the browser. Page dictionary containing referrer, title and url. we will use page view as a pseudo interaction to infer users' interest.

    • url
      Type: string · Url
      required

      Url of the page

    • referrer
      Type: string · Referrer

      Url of the referrer page

    • title
      Type: string · Title

      Title of the page

  • region
    Type: string · Region

    The region/location of the site the user is visiting. This is for sites that serve different regions or markets. You can define your own region keywords, for example, US East, Europe, LATM, etc.

  • truncated_ip
    Type: string · Truncated IpFormat: ipv4

    User's truncated IP address. We use IP address to determine the country of the users.

  • user_agent
    Type: string · User Agent

    User agent of the device making the request. We use this to determine if a user is browsing the site on mobile or desktop, and tailor the recommendations and search results accordingly.

    Example:

    {"user_agent":
        "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"}