> For the complete documentation index, see [llms.txt](https://userflux.gitbook.io/userflux-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://userflux.gitbook.io/userflux-docs/feature-guides/data-management/data-dictionary.md).

# Data Dictionary

The Data Dictionary provides a complete and real-time view of the data schema for your workspace. It automatically discovers and lists all the User Events and Profile Properties you send to UserFlux, helping you maintain data consistency and easily find the information you need when building automations and segments.

This guide explains how to navigate the Data Dictionary and understand the structure of your data.

***

### Navigating to the Data Dictionary

You can access the Data Dictionary from your main organisational settings.

1. In the left-hand navigation sidebar, click on the **Organisation** icon (four squares).
2. From the settings menu, select **Data Dictionary**.

![](/files/e7WRW1zXSeuyR7yeTECI)<br>

You will now see the main Data Dictionary screen, which is divided into two primary sections: **User Events** and **Profile Properties**.

***

### Exploring Your Data Schema

The Data Dictionary automatically categorises your data, making it easy to inspect.

#### User Events

This section lists every unique event that has been tracked in your workspace. For each event, you can see:

* **Event Name:** The name of the event (e.g., page\_view, user\_onboarding\_completed).
* **Properties Count:** The number of data points (properties) associated with that event.
* **Occurrences:** The total number of times the event has been recorded.

To inspect the specific properties of an event, simply click on it. This will expand the entry to show a list of all its associated properties and their detected data types (e.g., String, Number, Array, Boolean).

<figure><img src="/files/J0Q9n0l009OQffr2HKv4" alt=""><figcaption></figcaption></figure>

#### Profile Properties

This section lists all properties that have been associated with your user profiles. Similar to events, you can see the property name and its data type. This is useful for verifying that you are sending user attributes with the correct format.<br>

<figure><img src="/files/M0mjBJh57oFefFXArCcR" alt=""><figcaption></figcaption></figure>

***

### Updating Your Schema

UserFlux automatically discovers your schema over time. However, if you have recently started sending new events or properties and do not see them listed, you can manually trigger a rediscovery.<br>

1. Navigate to the Data Dictionary.
2. At the top right of either the **User Events** or **Profile Properties** section, click the **Sync** icon.

<figure><img src="/files/Pm3GvkC6XQlUStj4HhCo" alt=""><figcaption></figcaption></figure>

A notification will appear stating "Schema discovery running". The process will run in the background and the dictionary will be updated shortly with any newly found data points.

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://userflux.gitbook.io/userflux-docs/feature-guides/data-management/data-dictionary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
