Metric App Filter

Metric App Filter: Instruction Manual

Using the App Filter in Metric:

Step 1:

Create a Metric Filter

• In your Metric, create a new filter

• In the "Options" section, select filter type: Guest Token

Create Guest Token Metric Filter

Step 2:

Passing Filter Values Method 1: Passing from Component

• Use the parameter "metric-filter-options" to pass values directly from a component to the metric filter.

• Configuration changes based on the Filter Type and the Data Type.

1. Single-Select Filter:

   • For string-based filters, pass just the value:

     metric-filter-options={JSON.stringify({ // note that invalid options will be filtered out
       "Filter name for a string datatype": {
         options: [
                     { value: 'James Smith', label: 'James' },
                     { value: 'Olivia Johnson', label: 'Olivia' },
                     { value: 'Emma Brown', label: 'Emma' },
                   ] // should have unique elements
         defaultOption: 'James Smith', // value of the selected option
       },
       "Filter name for a number datatype": {
         options: [{ value: 1, label: 'user_1' }, { value: 2, label: 'user_2' }], // should have unique elements
         defaultOption: 1, // value of the selected option
       },

2. Multi-Select Filter:

• For string-based filters, pass an array of values:

  metric-filter-options={JSON.stringify({ // note that invalid options will be filtered out
    "Filter name for a string datatype": {
      options: [
                  { value: 'James Smith', label: 'James' },
                  { value: 'Olivia Johnson', label: 'Olivia' },
                  { value: 'Emma Brown', label: 'Emma' },
                ] // should have unique elements
      defaultOption: ['James Smith', 'Olivia Johnson' ], // value of the selected option
    },
    "Filter name for a number datatype": {
      options: [{ value: 1, label: 'user_1' }, { value: 2, label: 'user_2' }], // should have unique elements
      defaultOption: 1, // value of the selected option
    },

  Refer the below "Options" document for further queries.

✅Options

Method 2: Passing from Guest Token

• You can link a guest token here to pass the filter values dynamically.

Refer the below document to generate a guest token.

ℹ️Token

{
  "clientId": "id",
  "workspaceName": "workspacename",
  "params" : {
     "appFilters": [{
			“metricId”: “The id of the metric you want to have app filters”,
			“values”: {
				“paid_orders”: true,
				“amount”: 500,
				“country”: ["USA", "CANADA"] || "USA" // based on filter variant(select or multi select)
			}
		}]
   }
}

Make sure the options and values match the data type of the filter for successful integration.