> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/developer-guides/events-and-tracking.md).

# Events & Tracking

Build your own analytics from configurator activity. Learn what Mimeeq events are, how to use them and how to link them to logged-in users.

An event is something that Mimeeq fires when an action occurs on the configurator. This article explains how to use Mimeeq events to build your own custom analytics and track how various configurator features are used.

***

## Example events

Events include actions such as:

* Enter Configurator
* Leave Configurator
* Add to cart
* Download PDF
* Generate Image
* Change Quality
* Change Option
* Generate AR (View in Room)

{% hint style="info" %}
For a full list, check our [developer docs events list](https://docs.mimeeq.com/events).
{% endhint %}

***

## How to use these events

Since each event says that an action occurred, you can use these events to store this data in your own analytics system. This can be any system you want to integrate with.

For a practical example, check this [developer docs example](https://docs.mimeeq.com/google-analytics).

***

## How to track events for specific users

{% hint style="info" %}
This section presumes you are using Mimeeq's login (Auth) system.
{% endhint %}

When a user logs in, we return their name (first and last name) and email as part of the user session, so once they have logged in you can see that information. Check our developer docs to [learn how](https://docs.mimeeq.com/events#authentication-events).

Once you know the user is logged in, you can store the user details along with your events as described above. If no user is logged in, you can mark the user as a visitor.

```mermaid
flowchart LR
    A[Mimeeq fires an event] --> B{User logged in?}
    B -- Yes --> C[Store event with name and email]
    B -- No --> D[Store event as visitor]
    C --> E[Your analytics system]
    D --> E
```

{% hint style="success" %}
This gives you a brief outline of how to use custom events to track usage of your product configurators. We suggest passing this article to your developers.
{% endhint %}

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Webhooks</strong></td><td>Send real-time Mimeeq event data to your own systems.</td><td><a href="/developer-guides/webhooks.md">Webhooks</a></td></tr><tr><td><strong>Custom UI</strong></td><td>Build and deploy your own interface around the Mimeeq 3D configurator.</td><td><a href="/developer-guides/custom-ui.md">Custom UI</a></td></tr><tr><td><strong>API Keys</strong></td><td>Create and manage Embed and Admin API keys, and monitor API requests.</td><td><a href="/developer-guides/api-keys.md">API Keys</a></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/developer-guides/events-and-tracking.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
