> For the complete documentation index, see [llms.txt](https://docs.metrical.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.metrical.xyz/developers/how-to-track-events.md).

# How to track events

You can add Events to custom actions done by your users on your website. \
 

Every time a user does an action, **Metrical** tracks that Event and displays it on the events tab of your Website dashboard. \
 \
Here are some examples of Events that you can track: 

* When a user clicks on a specific button;
* When a user completes a payment;
* When a user downloads something (a pdf, an e-book, etc...).

### How to track an event

It's really easy: just call inside your page (assuming you have already added the [Metrical script](https://docs.metrical.xyz/developers/how-to-start-tracking-users))

```javascript
window.metrical.trackEvent("type_of_event")
```

With the type of event that you added when you created the event on **Metrical**.

Every event will be associated with the nearest visit of that user, so that you can filter events by any visit field.

For example, if you filter only the visits that have as referrer producthunt.com and you go to the **Events** tab, you will also see only the events that are connected to one of those visit. 


---

# 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://docs.metrical.xyz/developers/how-to-track-events.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.