# Getting Started

## Sign up

Head over to [app.plaudy.com/signup](https://app.plaudy.com/signup) to create an account and [get your api key](https://app.plaudy.com/settings/workspace/keys). That's it! 🔥

## Install

Install plaudy using `yarn` or `npm`:

```javascript
// Using npm
npm install plaudy

// or yarn
yarn add plaudy
```

## Import

One installed, use a simple `require` or `import` statement:

```javascript
import Plaudy from 'plaudy';
```

## Initialize

Init your workspace with `.init()`, where `` `YOUR API KEY` `` is replaced with [the API Key in your dashboard.](https://app.plaudy.com/settings/keys)

```javascript
Plaudy.init(`YOUR_API_KEY`);
```

{% hint style="success" %}
Make sure to replace `YOUR_API_KEY` with your actual key or Plaudy will not track any events for you. 
{% endhint %}

## Identify (optional)

Identify the user and/or object that will be tracked for subsequent events. This benefits you by allowing you to skip passing these fields in for every single event tracked. However, you can always pass these fields through when calling `.track()` .\
\
`USER_ID` is your customer that you want to track this event for. `OBJECT_ID` is a secondary identifier for when the user has multiple spaces/workspaces/locations within a single account:

```javascript
Plaudy.identify(`USER_ID`, `OBJECT_ID`);
```

{% hint style="info" %}
It is possible to track events without identifying the user. In this case, the tracked user recorded for the event will be `no_tracked_user`. This allows you to still have query-friendly events for things like overall app usage, button clicks on your landing page, etc. We've done this on [our landing page](https://plaudy.com/#demo) as an example. 
{% endhint %}

Now you know how to get it set up. It's time to [start tracking events](https://docs.plaudy.com/tracking-analytics)! :raised\_hands: 


---

# Agent Instructions: 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:

```
GET https://docs.plaudy.com/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.