SQL Transformations give you the full power of ANSI SQL to transform your events. Any transformation you can express with SQL, you can perform with SQL transformations. When you write a SQL transformation you will have access to an
incoming_eventtable. This table has a number of columns that correspond to the built-in data Freshpaint collects and you will have access to an additional JSON column called
propswhere you will have access to any custom properties. The full schema of the
incoming_eventtable is described here.
SQL Transformations are part of the Freshpaint SQL add-on. Contact [email protected] to request access.
SQL Transformations are only available when either the event being transformed is a server-side event or the destination is in server-side mode. If you want to make as much use of SQL Transformations as possible, we recommend configuring your destinations in server-side mode.
When you write a SQL Transformation you are writing a SQL query against the
incoming_eventtable. Your query should return either a single row or no rows. Any columns returned by your query will be attached to the event as custom properties. If your query returns zero rows, the event will filtered out and not sent to any destinations. As an example, the query:
SELECT 10 AS example_prop FROM incoming_event;
Will create a new property
example_propwith the value
10. If you return
NULLfor the value of a property, that property will instead be deleted.
There are two reserved column names that have special behavior when you return them:
event_name- When you return this from a query, the name of the event will become the provided value.
user_id- When you return this from a query, the user_id of the event will become the provided value.
This transformation will prepend all events with the prefix
SQL:. If the incoming event name is
Login, the transformed event will have the name
SELECT CONCAT('SQL: ', event_name) AS event_name FROM incoming_event;
This example will double the value of the custom property
SELECT 2 * JSON_EXTRACT_DOUBLE(props, 'a') AS a FROM incoming_event;
This example extracts a URL parameter from the url of the event using regular expressions:
SELECT REGEXP_REPLACE(url, '^.*param=(\\w+).*$', '\\1') AS param FROM incoming_event;
This example creates a new property called
new_propertyan always sets it to the value
SELECT 10 AS new_property FROM incoming_event;
This example deletes the property
sensitive_identifierfrom the event. This is done by setting the value of the property to
SELECT NULL AS sensitive_identifier FROM incoming_event;
This example filters out all events where the email is a gmail address:
WHERE JSON_EXTRACT_STRING(props, 'email') NOT RLIKE 'gmail.com$';
incoming_eventtable has the following schema:
The name of the event definition matched by the event.
The Unix time in seconds the event occurred at.
The id of the pageview the event belongs to. All events performed in the same pageview will have the same
The id of the session the event belongs to. A session is a group of actions perform in the same time frame. A session ends after 30 minutes of inactivity. All events performed in the same session will have the same
The name of the web browser.
The version of the web browser.
A Freshpaint generated unique identifier for the device the event was sent from. This is sometimes referred to as the
Either "Desktop" or "Mobile" depending on the device type.
The domain of the page the event occurred on.
The full URL of the page that first referred the user to your site.
The domain of the page that first referred the user to your site.
The name of the operating system the user was using.
The URL path of the page the event was performed on.
The URL of the page the user was on before the page they performed the event on.
The domain of the page the user was on before the page they perfomed the event on. It may be your own domain.
The height of the user's screen.
The width of the user's screen.
The text of the element that was clicked on.
The full URL of the page the event was performed on.
The identity associated with the user through Identify.
The most recent value of the utm_campaign UTM property.
The most recent value of the utm_content UTM property.
The most recent value of the utm_medium UTM property.
The most recent value of the utm_source UTM property.
The most recent value of the utm_term UTM property.