Create New Signal
To create a new Signal, open the Signal Tab in Events section.
Steps to Create a Signal
- Click on the Add Signal button
- Fill in the details to create signal instantly:
| PROPERTY | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| Key | String | Yes | Signal identifier. Use snake_case format and keep it concise to save space. Example: Instead of 'user_order_count_last_24hour', use 'usr_order_cnt_24h' |
| Entity Id Field | String | Yes | Its grouping key on which you want aggreagation, eg. device_id, user_id, flight_id, This will always be in snake case |
| Description | String | No | Description helps to understand the signal's purpose |
| Tags | Dropdown | No | Tags to categorize signals. You can manage tags in the company profile section |
| Type | Dropdown | Yes | Choose either 'realtime' or 'batch' |
Realtime Signal Configuration
| PROPERTY | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| Aggregation Window | Dropdown | Yes | Time period for aggregation (e.g., 1 minute, 1 hour) |
| Aggregation Type | Dropdown | Yes | Choose aggregation type. Supported values: Static, Count, Sum. See Realtime Aggregation Types for details. |
| Aggregation Field | String | No | Aggregation Field (always in snake_case) used for static and sum aggregation types. See Realtime Aggregation Types and Event Property Conversion for more information. |
| Filter Expression | String | Yes | Expression to filter events. For example, to count the number of orders where the order event is identified by event equals 'ORDER_PLACED', use the filter expression: event=='ORDER_PLACED'. Expression should always return true or false See Logical Expression for syntax details. |
Batch Signal Configuration
| PROPERTY | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| Query | String | Yes | SQL query to be executed based on the provided schedule. This query must select a column named user_id. Example: SELECT user_id, device_type FROM events WHERE type='track' This will store the device type for each user. |
| Execution Frequency | Dropdown | Yes | Its periodic interval at which you want to execute the sql query. Depending on freshness requirement select values from 1hr tp 24hr |
Evaluate Signal
To evaluate a signal:
- Click the three dots (⋮) next to the signal in the signal list and select "Evaluate."
- Enter the user_id value and submit.
- The system will return the signal value for the specified user.