Provides analytics for forms, including submission and conversion metrics, aggregated by the specified granularity.

Select

The driver uses the Klaviyo API to process WHERE clause conditions with the following fields and operators. Remaining filters are evaluated client-side within the driver.

• GroupBy: List of attributes to group the data by. Allowed values are form_id and form_version_id. If not specified, data is grouped by form_id. If a group has prerequisites, they must be included together. The prerequisite for form_version_id is form_id.
• Granularity: Determines how granular the data points are within the time range specified by StartDateTime and EndDateTime. Specify this field if you want to query series stats. Valid values:
  • hourly
  • daily
  • weekly
  • monthly
  • total (default)
• StartDateTime and EndDateTime: Define the time window. The window cannot exceed 1 year. If both values are provided, the driver requests data for that range. If only one is provided, the driver calculates the missing value based on the default interval for the selected granularity. Defaults:
  • monthly or total: Last 1 year
  • weekly: Last 52 weeks
  • daily: Last 60 days
  • hourly: Last 7 days
• FormId: Supports the operators = and IN.

Notes:

• Setting Granularity to total returns the same result as omitting it.
• If Granularity is hourly, the time window cannot exceed 7 days. For daily, 60 days. For weekly, 52 weeks. For monthly, 1 year.
• When Granularity is not total, IntervalStartDateTime and IntervalEndDateTime are based on the current interval. When set to total, they match the StartDateTime and EndDateTime.
• Only one filter can be applied to FormId. Multiple values can be provided with the IN operator, and multiple filters must be combined with AND. The OR operator is not supported.
• A maximum of 100 values can be provided for FormId when using the IN operator.

For example, the following query returns monthly form stats for a defined time range and multiple form IDs:

SELECT * FROM FormStats 
WHERE Granularity = 'monthly' 
  AND StartDateTime = '2024-07-07' 
  AND EndDateTime = '2024-09-09' 
  AND FormId IN ('form-1', 'form-2', 'form-3')

There are no required filters to query this table. However, it is recommended to specify a time window (StartDateTime and EndDateTime) and Granularity when you want to retrieve series stats (granular data).

You can also run simplified queries depending on your data needs:

-- Retrieve all form stats without filters
SELECT * FROM FormStats;

-- Retrieve form stats for a defined time window
SELECT * FROM FormStats 
WHERE StartDateTime = '2024-07-07' 
  AND EndDateTime = '2024-09-09'

-- Retrieve monthly form stats for a defined time window
SELECT * FROM FormStats 
WHERE Granularity = 'monthly' 
  AND StartDateTime = '2024-07-07' 
  AND EndDateTime = '2024-09-09'

Columns