--- title: Custom metadata reference slug: pb6e0011 canonical_url: https://docs.coveo.com/en/pb6e0011/ collection: coveo-analytics source_format: adoc --- # Custom metadata reference This reference article provides metadata names for different types of [events](https://docs.coveo.com/en/260.md). These metadata are logged but not available in [Coveo Analytics](https://docs.coveo.com/en/182.md) [reports](https://docs.coveo.com/en/266.md) unless you create a [dimension](https://docs.coveo.com/en/258.md) for them. ## Action cause (click) This section lists the custom metadata logged for each standard `actionCause` value associated with click events. ### `documentQuickview` Logs the following: * The item title opened in [Quick view](https://docs.coveo.com/en/2760.md#search-result-quick-view). API name: `documenttitle` * The item URL opened in Quick view. API name: `documenturl` ### `documentOpen` Logs the following: * The clicked item title. API name: `documenttitle` * The clicked item URL. API name: `documenturl` ## Action cause (search) This section lists the custom metadata logged for each standard `actionCause` value associated with search events. ### `interfaceChange` Logs the search interface (tab) name. API name: `interfacechangeto` ### `contextRemove` Logs the removed search context name. API name: `contextname` ### `resultsSort` Logs the name of the selected sorting function. API name: `resultssortby` ### `breadcrumbFacet` Logs the following: * The breadcrumb ID removed from the facet history. API name: `facetid` * The breadcrumb value removed from the facet history. API name: `facetvalue` ### `documentField` Logs the following: * The clicked field ID from an item field to add a filter. API name: `facetid` * The clicked field value from an item field to add a filter. API name: `facetvalue` ### `pagerNumber` Logs the page number value used to change page. API name: `pagernumber` ### `pagerNext` Logs the resulting page number after using the Next button. API name: `pagernumber` ### `pagerPrevious` Logs the resulting page number after using the Previous button. API name: `pagernumber` ### `omniboxFacet` Logs the following: * The ID of the selected facet filter from the omnibox. API name: `facetid` * The value of the selected facet filter from the omnibox. API name: `facetvalue` ### `facetClearAll` Logs the facet ID for which all values have been removed. API name: `facetid` ### `facetRangeInputChange` Logs the user input in a range facet. ### `facetSearch` Logs the ID of the facet within which the search was performed. API name: `facetid` ### `facetToggle` Logs the following: * The selected operator (AND versus OR) icon before the toggle. API name: `facetoperatorbefore` * The selected operator (AND versus OR) icon after the toggle. API name: `facetoperatorafter` ### `facetRangeSlider` Logs the following: * The ID of the changed slider facet. API name: `facetid` * The start value of the slider facet. API name: `facetrangestart` * The end value of the slider facet. API name: `facetrangeend` ### `facetRangeGraph` Logs the following: * The ID of the changed graph facet. API name: `facetid` * The start value of the selected range. API name: `facetrangestart` * The end value of the selected range. API name: `facetrangeend` ### `facetSelect` Logs the following: * The selected facet ID used to filter on results. API name: `facetid` * The selected facet value used to filter on results. API name: `facetvalue` ### `facetDeselect` Logs the following: * The deselected facet ID to no longer filter on results with one of its values. API name: `facetid` * The deselected facet value to no longer filter on results with it. API name: `facetvalue` ### `facetExclude` Logs the following: * The excluded facet ID used to filter out results containing one of its values. API name: `facetid` * The excluded facet value used to filter out results containing this value. API name: `facetvalue` ### `facetUnexclude` Logs the following: * The facet ID for which a previously excluded value is now re-included in the results. API name: `facetid` * The facet value that was previously excluded but is now reinstated to allow results containing this value. API name: `facetvalue` ### `facetSortValues` Logs the following: * The ID of the facet for which the sorting function has changed. API name: `facetid` * The name of the sorting function. API name: `facetsortby` ### `facetSelectAll` Logs the following: * The ID of the facet for which all values have been selected. API name: `facetid` * The values of the facet for which all values have been selected. API name: `facetvalues` ### `createItem` Logs the type of created item. API name: `entityName` > **Note** > > A `caseAttach` event is logged when a user clicks the **Link to Case** or the **Mark as Relevant** button, whereas a `caseDetach` event is only logged when a user clicks the **Unlink from Case** button, which cancels the Link to Case action. ### `searchboxSubmit` Logs the query from a [non-standalone search box.](https://docs.coveo.com/en/1377.md#standard-search-box-actions) ### `searchFromLink` Logs the query from a [standalone search box.](https://docs.coveo.com/en/1377.md#standard-search-box-actions) ## Action cause (Salesforce) This section lists the custom metadata logged for each standard `actionCause` value associated with Salesforce events. ### `casecontextAdd` Logs the added contextual case ID. API name: `caseid` ### `casecontextRemove` Logs the removed contextual case ID. API name: `caseid` ### `preferencesChange` Logs the following: * The search preference setting name. API name: `preferencesname` * The search preference setting type. API name: `preferencestype` ### `caseAttach` (Salesforce) Logs the following: * The attached knowledge base article title. API name: `documenttitle` * The attached knowledge base article URL. API name: `resulturihash` * The attached knowledge base article ID. API name: `articleid` * The case ID on which the knowledge base article was attached. API name: `caseid` ### `caseDetach` (Salesforce) Logs the following: * The detached knowledge base article title. API name: `documenttitle` * The detached knowledge base article URL. API name: `resulturihash` * The detached knowledge base article ID. API name: `articleid` * The case ID on which the knowledge base article was detached. API name: `caseid` ### `customfiltersChange` Logs the following: * The custom search filter name. API name: `customfiltername` * The custom search filter type. API name: `customfiltertype` * The custom search filter expression. API name: `customfilterexpression`