Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clarityq.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Event Catalog is ClarityQ’s repository for your product analytics events — the user actions and product behaviors tracked in your warehouse (think signup_completed, purchase_made, screen_viewed). It automatically discovers events as they appear, captures the parameters and user properties they carry, and gives you one place to describe and approve them before they flow into the Semantic Catalog. Without an Event Catalog, ClarityQ would only know your events by their raw names. With it, every event has a business meaning attached, and the agent can reason about user behavior in your product’s terms.

​
What It Contains

The Event Catalog is organized into three tabs.

​
Events

For each event tracked in your product, the Event Catalog stores:
  • Event Name — The identifier as it appears in your warehouse (e.g., signup_completed)
  • Description — User-provided or AI-suggested explanation of when the event fires
  • Type — Automatic for events the analytics platform collects out of the box (e.g., GA4’s session_start, screen_view) or Custom for events your team instrumented
  • Platforms — The platforms the event has been observed on (e.g., iOS, Web, Android)
  • Volume — Total occurrence count
  • Params — The number of the event parameters; click the number to open the parameters list
  • First Fired — When the event was first seen
  • Last Fired — When the event was most recently seen
  • Data Status — Whether the event is still active in your warehouse (see Statuses below)
Click the arrow next to an event name — or the number in the Params column — to expand the row in place. The expanded view lists every parameter the event carries, split into Custom and Automatic tabs. Each parameter shows its name, approval status, description, data type, distinct value count, and example values — and you can edit a parameter’s description directly from there. Click the event name itself to open the Event page, the full detail view for a single event. The page shows the event’s approval status and approver, description, type, data status, volume, last modified date, the platform and version where the event first and last fired, and the timestamps of its first and last occurrence. Below the metadata is the full parameters table — the same one shown in the expanded row. From this page you can edit the event’s description, hide or unhide it, and sync it to the Semantic Catalog once it’s approved.

​
Common Parameters

Parameters are the attributes attached to events (e.g., button_id on a click event). The Common Parameters tab lists parameters that appear across multiple events — describe each one once, and ClarityQ understands it everywhere it shows up. For each parameter:
  • Name — The parameter identifier as it appears on events (e.g., button_id)
  • Description — User-provided or AI-suggested
  • Type — Automatic for parameters the analytics platform attaches to events out of the box (e.g., GA4’s page_location, ga_session_id) or Custom for parameters your team added
  • Data Type — The parameter’s SQL data type (e.g., STRING, INTEGER, FLOAT, BOOLEAN)
  • # Values — The number of distinct values seen for this parameter
  • Platforms — The platforms the parameter has been observed on (e.g., iOS, Web, Android)
  • % Events — The share of your events that include this parameter
  • # Events — The number of distinct events that include this parameter
  • First Fired — When the parameter was first seen
  • Last Fired — When the parameter was most recently seen
  • Data Status — Whether the parameter is still active in your warehouse (see Statuses below)
  • Approval — Who approved the description
  • Status — Approval status (Pending or Approved)
Click the arrow next to a parameter name — or the number in the # Values column — to expand the row in place. The expanded view shows up to ten example values seen for that parameter, useful for spot-checking what it actually contains without leaving the table. Click the parameter name itself to open the Common Parameter page, the full detail view for a single parameter. The page shows the parameter’s approval status and approver, description, type, data type, data status, % Events (share of events that include it), and # Events (count of events that include it), along with the platforms and versions where the parameter first and last appeared and the timestamps of its first and last occurrence. Below the metadata, two sections give you context: a Values section listing example values, and an Events with This Parameter table showing every event that includes the parameter, with each event’s name, type, approval status, description, and the parameter’s description as used in that specific event. From this page you can edit the parameter’s description (which applies everywhere it’s used) and hide or unhide it.

​
User Properties

User properties are user-level attributes that accompany events (e.g., subscription_tier, country). They’re tracked separately from event parameters because they describe the user, not the event. The Event Catalog stores the same fields for each user property as it does for common parameters. Click the arrow next to a user property name — or the number in the # Values column — to expand the row in place and see up to ten example values inline. Click the user property name to open the User Property page, which mirrors the Common Parameter page: full metadata (approval status and approver, description, type, data type, data status, % Events, # Events, platforms and versions, first and last fired), a Values section, and an Events with This User Property table listing every event the user property appears on. From this page you can edit the user property’s description (which applies everywhere it’s used) and hide or unhide it.

​
Statuses

Every event, parameter, and user property has two statuses. Approval status reflects where the item is in its lifecycle:
  • Pending — No approved description yet
  • Approved — Has a verified description and is ready to sync to the Semantic Catalog
  • Synced — Already synced to the Semantic Catalog as a Feature (for events) or Dimension (for parameters and user properties)
Data status reflects whether it’s still active in your warehouse:
  • Active — Seen during the most recent discovery window
  • Inactive — Not seen recently (the event may have been deprecated or renamed)

​
How It Fits into the Context Layer

The Event Catalog is updated continuously by daily discovery jobs that scan your warehouse for new events, parameters, user properties, and value changes. Once an event has an approved description, you can sync it to the Semantic Catalog. The event becomes a Feature, and its parameters and user properties become Dimensions — making them available in metrics, segments, and ad-hoc questions. From that point on, the agent draws on these components automatically whenever a question touches that part of your product, with no need to point it at the raw event. Whether you’re setting up the catalog for the first time or keeping up with newly-discovered items afterward, the Missing Description Wizard batches everything that’s still missing a description into a single guided workflow.