Query Builder

Use Prebuilt PX Metrics

Prebuilt PX metrics allow you to quickly create reports without configuring calculations manually.

The following prebuilt PX metrics are available:

• Active Users: Users who started at least one session during the selected time range.
• Active Accounts: Accounts that had at least one active user during the selected time range.
• All Users:Total distinct users matching your audience criteria, regardless of activity or the selected time range.
• All Accounts: Total distinct accounts matching your audience criteria, regardless of activity or the selected time range.
• New Users: Users first seen during the selected time range.
• New Accounts: Accounts first seen during the selected time range.
• Total Events: Total event occurrences during the selected time range.

To create a report using prebuilt metrics:

1. In the Prebuilt PX Metric section, select a predefined metric (for example, Unique Users or Total Events). PX automatically prefills the WHERE and IN conditions to any events and all audiences respectively (except for All Users and All Accounts).
2. Click the WHERE clause to edit the condition.
3. In the Edit Conditions slide-out panel, configure:
   1. Event: Define the event that needs to be considered for calculation of the metric
      1. Event Type: Select the type of event (for example, Custom Event, or Engagement), followed by the corresponding field.
      2. In the Where section, click Add to apply filters.
      3. Add conditions based on event properties or attributes to refine the dataset.
      4. (Optional) Click Add Event to include additional events in the query.
         
         
          
   2. Audience: Expand the Audience section to include additional audience groups. By default, all audiences are selected.
      1. In the Where section (for example, A1), click Add to define conditions based on user or account attributes.
      2. In the Who Executed section, click Add to define behavioral conditions based on event execution, such as the number of times an event was performed, the time window for the condition and more.
      3. (Optional) Click Add Audience to include additional audience groups.
         
         
          
4. Click Save to update the WHERE clause.
5. Click Add Metric to add additional prebuilt or custom metrics. Once a second metric is added, each metric is assigned a variable (for example, A, B, C, and so on).

Use Custom Metrics

Custom metrics allow you to create reports using aggregation functions and define calculations based on events, attributes, or their properties. This approach provides greater flexibility to analyze data beyond predefined metrics.

The following customer metrics are available:

• Sum
• Average
• Count
• Count Distinct
• Median

To create a report using custom metrics:

1. In the Metric section, select Build Custom Metrics.
2. Select an aggregation function for the report.
3. Select the data source for the aggregation:
   1. Custom Events: Select the custom event, followed by the event property to perform the aggregation.
   2. User Attribute: Select the user attribute to perform the aggregation.
   3. Account Attribute: Select the account attribute to perform the aggregation.
4. Select the specific event, attribute, or property to perform the calculation.
   
   
    
5. Click the WHERE clause to edit the audience. By default, all audiences are selected.
6. In the Edit Conditions slide-out panel, expand the Audience section to include additional audience groups. By default, all audiences are selected.
   1. In the Where section (for example, A1), click Add to define conditions based on user or account attributes.
   2. In the Who Executed section, click Add to define behavioral conditions based on event execution, such as the number of times an event was performed, the time window for the condition and more.
   3. (Optional) Click Add Audience to include additional audience groups.
      
      
       
7. Click Save to update the WHERE clause.
8. Click Add Metric to add additional prebuilt or custom metrics. Each added metric is assigned a variable (for example, A, B, C, and so on).

Custom Event Properties

You can analyze custom event properties based on property values. This may come in handy when you want to measure the event properties such as video play counts or monetary values you're passing to Gainsight PX through Custom Events.

Global Context queries provides you the ability to have granular querying experience. 

For more information, refer to the Use Custom Event API article from.

For more information about all frequently asked questions, refer to the Analytics FAQs article.

When you create a query with numerical attributes of custom events, you can evaluate the results using Property Value aggregations.

Feature Events

Users can select events based on channel/feature in the Event dropdown list. The events are grouped into the following categories:

• Web App Features
• Mobile Features

Engagement Events

Users can now select engagement events in the Query Builder to create custom analytics and gain deeper insights into audience behaviors. You can further refine your query by selecting the required engagement type and its attributes.

Example Business Usecase: Create a query to find the number of views on a NPS Survey engagement among the android users who has submitted the survey response with a promoter score.

Page View Events

The Page View option helps to query on various page view events using various URL and UTM parameters as given below:

 URL parameters:

• Full URL enables grouping and filtering by the complete URL, including path and parameters.
• Hash allows segmentation by in-page anchors or route fragments (for instance, #demo, #faq).
• Hostname identifies the host that holds the resource. 
• Page Title is a short description of a webpage that appears at the top of a browser window 
• Path represents a specific section or page of your application or website. 
• Query Parameter represents a set of parameters added to the base URL (along with a value usually) to get specific content or denote an action from your application or website
• Referrer is the webpage that sends visitors to your site using a link.
• Scheme identifies the protocol to be used to access the resource on the Internet. It can be HTTP (without SSL) or HTTPS (with SSL).
• URI is a sequence of characters that distinguishes one resource from another.

UTM parameters:

• utm_source: Identifies which site sent the traffic.
• utm_medium: Identifies what type of link was used, such as cost per click or email.
• utm_campaign: Identifies a specific product promotion or strategic campaign.
• utm_term: Identifies the (paid) keyword associated with the traffic
• utm_content: Identifies what specifically was clicked to bring the user to the site, such as a banner ad or a text link. 

Mobile Screen Events

Mobile screen events helps you create queries based on the screen events and their attributes such as platform, screen name or screen class. You can also add the Group By attributes to get the required query results.