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 Missing Description Wizard is the fastest way to get your catalog from raw event names to fully described. It collects every item still missing a description — events, common parameters, user properties, and any tables that need one — and walks you through them one at a time, accepting AI suggestions, edits, or your own descriptions as you go. Use it during onboarding to clear the initial backlog, and again whenever daily discovery surfaces new items.

​
Starting the Wizard

The sidebar shows a Complete button with the current count of items still missing a description. Click it to open the wizard. On the first run you’ll see a welcome screen that explains the flow and offers to apply ClarityQ’s AI-suggested descriptions where they exist. Continue when you’re ready.

​
How the Wizard Works

The wizard groups items by type and walks through them in order, showing one item per screen.
1

Tables

If your Table Catalog has tables missing descriptions, the wizard starts there. Each table shows its columns and any AI suggestion.
2

Events

Every event in Pending status without an approved description. The wizard shows the event name, type, volume, and a suggested description when ClarityQ has one.
3

Parameters and user properties

Common parameters and user properties are surfaced together. For each one you see its source events, distinct values, and AI suggestion.
For each item you can:
  • Accept the suggestion — Use the ClarityQ-suggested description as-is.
  • Edit and save — Adjust the suggestion or write your own description.
  • Skip — Move to the next item without saving. The item stays in Pending until you come back to it.
When you save a description, the item moves to Approved status. If it’s a parameter or user property whose parent event has already been synced, it auto-syncs as a Dimension on the related Feature.

​
Progress and Resuming

The header shows your position in each section (for example, 3/12) along with Back, Next, and Exit buttons. You can leave the wizard at any time — your progress is remembered, so the next session picks up where you left off.

​
Tips

Start by skimming the AI suggestions before editing. For events ClarityQ recognises (especially standard GA4 events and their common parameters), the suggestion is usually accurate and you can accept it in a single click.
Approving items in the wizard doesn’t sync the parent events to the Semantic Catalog. Once events are described and approved, head to the Events tab and sync them so the agent can use them.