Home
Home
German Version
Support
Impressum
20.5 Release ►

    Main Navigation

    • Preparation
      • Connectors
      • Initial Startup for G6 appliances (before January 2018)
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JiveSoftware Jive Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Salesforce Connector
      • Configuration - SAP KMC Connector
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - SharePoint Online Connector
      • Configuration - Web Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Jive Sitemap Generator
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze InSpire Search Apps in Microsoft SharePoint 2010
      • Mindbreeze InSpire Search Apps in Microsoft SharePoint 2013
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
    • Configuration
      • CAS_Authentication
      • Cognito JWT Authentification
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - GSA Late Binding Authentication
      • Configuration - Index-Servlets
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Notifications
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • Google Search Appliance Migration to Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Prediction Service Text Classification
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • Non-Inverted Metadata Item Transformer
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
    • Operations
      • app.telemetry Statistics Regarding Search Queries
      • Configuration Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Synchronized Operation (G6)
      • Index Operating Concepts
      • Indexing and Search Logs
      • Inspire Diagnostics and Resource Monitoring
      • InSpire Support Documentation
      • Mindbreeze InSpire SFX Update
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
    • User Manual
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of Insight Apps
      • Java API Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 2018 Spring - Mindbreeze InSpire
      • Release Notes 2018 Winter - Mindbreeze InSpire
      • Release Notes 2019 Fall - Mindbreeze InSpire
      • Release Notes 2019 Winter - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Interface Description

    api.v2.personalization

    Copyright ©

    Mindbreeze GmbH, A-4020 Linz. 2020.

    All rights reserved. All hardware and software names are brand names and/or trademarks of their respective manufacturers.

    These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes or other protected rights.

    The dissemination, publication or reproduction hereof is prohibited.

    For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.

    IntroductionPermanent link for this heading

    This document deals with the Mindbreeze Web API for analyzing user behavior. The API is responsible for recording user actions in the app.telemetry.

    Please note that this API is designed to analyze user actions in the search results, such as opening or previewing documents. Information on how to perform searches with the Mindbreeze Web API can be found in the api.v2.search Interface Description.

    Personalization requests are sent as HTTP POST requests to a client service. The path for personalization requests is: <Client Service URL>/api/v2/personalization.

    A JSON document that describes the personalization requests is sent with the body of the HTTP request.

    You can find more information on personalization in the following documentation:

    Usage Analysis

    Reading the data logged with api.v2.personalization in app.telemetry

    Personalization

    Setting up personalization in the default Mindbreeze InSpire search client

    Fields in Personalization RequestsPermanent link for this heading

    query_resultPermanent link for this heading

    This JSON object describes the user actions related to the search result. Which members can be set for this JSON object is described in the following subsections.

    query_result.actionPermanent link for this heading

    The operation performed by the user. Displayed in capital letters in the app.telemetry in the “Operation” column.

    query_result.commentPermanent link for this heading

    Can be used to log user comments on a document. Is displayed in the app.telemetry in the column “Comment”.

    query_result.duration_in_msPermanent link for this heading

    The duration of the user action in milliseconds (for example, if the user had a preview of the document open for a certain time and then closed it). Displayed in the app.telemetry in the column “Duration (ms)”.

    query_result.fqcategoryPermanent link for this heading

    The fqcategory (Full Qualified Category) of the document that was involved in the user action. Appears in the app.telemetry in the “FQCategory” column.

    query_result.keyPermanent link for this heading

    The key (datasource/mes:key) of the document involved in the user action. Is displayed in the app.telemetry in the column “Key”.

    query_result.positionPermanent link for this heading

    The result position of the document that was involved in the user action. Note that the first document has the position 0, so for example the tenth document has the position 9. Is displayed in the app.telemetry in the column “Result Position”.

    query_result.propertiesPermanent link for this heading

    An array of JSON objects with key-value pairs to log custom properties in app.telemetry. Displayed in the app.telemetry in the columns “Custom Property 1” to “Custom Property 10”. Thus, a maximum of 10 custom properties can be added.

    The following example shows how to set the resultcount and language properties in the app.telemetry in the columns “Custom Property 1” and “Custom Property 2”:

    "properties": [

        {

            "key": "resultcount",

            "value": "534"

        },

        {

            "key": "language",

            "value": "de-AT"

        }

    ]

    query_result.query_contextPermanent link for this heading

    This JSON object describes the context of the search query. The following subsections describe the members of this JSON object.

    Note: You can also send the query context with the search query.

    query_result.query_context.query_idPermanent link for this heading

    The ID of the search query (as an unsigned number). It is recommended to set a UTC timestamp (milliseconds since January 1, 1970, 00:00:00.000 GMT) of the current time of the search query (e.g. in JavaScript using new Date().getTime()). Is displayed in the app.telemetry in the column “Query ID”.

    query_result.query_context.prev_query_idPermanent link for this heading

    This is the query_id that was set in the previous query. Displayed in the app.telemetry in the column ”Previous Query ID”.

    query_result.query_context. refinement_idPermanent link for this heading

    The ID of the search query in which filters (= facets) were changed (as unsigned numbers). It is recommended to set a UTC timestamp (milliseconds since January 1, 1970, 00:00:00.000 GMT) of the current time of the search query (e.g. in JavaScript using new Date().getTime()). Displayed in the app.telemetry in the column "Refinement ID".

    query_result.query_context. prev_refinement_idPermanent link for this heading

    This is the refinement_id that was set in the previous query. Displayed in the app.telemetry in the column "Previous Refinement ID".

    scroll_position_in_percentagePermanent link for this heading

    The scroll position in the browser. Can be used, for example, during the close action of a preview window to log how far a user has scrolled down in the preview window. Values between 0 and 100 are valid. Displayed in the app.telemetry in the “Scroll position (%)” column.

    user_contextPermanent link for this heading

    This JSON object describes the context of the user. The following subsections describe the members of this JSON object.

    Note: You can also send the query context with the search query using api.v2.search (for example, for language and time zone).

    user_context.refererPermanent link for this heading

    This is the URL where the user is currently located. Displayed in the app.telemetry in the following columns:

    • "Referer": the entire URL
    • "Referer Scheme": the scheme of the URL (http/https)
    • "Referer Host": the host name of the URL.
    • "Referer Port": the port of the URL (-1 if no port has been defined)
    • "Referer Path: the path to the URL.

    ExamplePermanent link for this heading

    The following example illustrates the request format described above.

    HeaderPermanent link for this heading

    Content-Type: application/json

    BodyPermanent link for this heading

    {

        "query_result": {

            "query_context": {

                "query_id": "1552292350743",

                "properties": [

                    {

                        "key": "resultcount",

                        "value": "534"

                    },

                    {

                        "key": "language",

                        "value": "de-AT"

                    }

                ],

                "prev_query_id": "1552292349847"

            },

            "action": "preview",

            "position": 2,

            "weight": 0.5,

            "fqcategory": "Microsoft Exchange:Default",

            "key": "AQMkADU3YjMxNzg0LWE2OTQtNGQ3ZC1iZTFjLWJhMTc0Mzk1NGY4YwAuAAADooiUNxWDyEmjTSU5uGq 5gEAShd4IrQ/NU6YapRuM8OUPQAAAyIAAAA=@AQMkADU3YjMxNzg0LWE2OTQtNGQ3ZC1iZTFjLWJhMTc0Mzk1NGY4YwBGAAADooiUNxWDyEmjTSU5uGq 5gcAShd4IrQ/NU6YapRuM8OUPQAAAyIAAAAkKagZlMRnQ76P/8/misL4AAAAFm8giQAAAA==",

            "comment": ""

        },

        "user_context": {

            "referer": "https://inspire.mydomain.com/apps/client/"

        }

    }

    Download PDF

    • api.v2.personalization Interface Description

    Content

    • Introduction
    • Fields in Personalization Requests
    • Example

    Download PDF

    • api.v2.personalization Interface Description