> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nebuly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

Nebuly’s analytics platform provides deep insights into your AI system usage by leveraging both **user interactions** and **eligible user metadata**. One of the most important concepts for accurate metric computation is the **Eligible User**.

## What are Eligible Users?

Eligible users represent the population of users who have access to your AI agent. Unlike interaction events, which capture **what users do**, eligible users define **who is allowed** to use the platform, and **when**.

Tracking eligible users is essential for calculating high-level KPIs such as:

* **Activation rate** – the percentage of eligible users who are actively using the AI agent.

Each eligible user has:

* A **unique identifier** (`end_user`)
* A set of **tags** that describe user attributes (e.g., region, department, role)
* A **start date** (`active_from`) indicating when the user gained access
* An optional **end date** (`active_to`) marking when access was removed

<Tip>
  We recommend frequently updating the list of eligible users to keep the system
  aware of the currently active user base.
</Tip>

## Step 0: Get your API key

Before sending eligible users, you must create a project and retrieve your associated API key.

<Accordion title="How to get a Nebuly API Key">
  * Head to ⚙️ settings and navigate to “project settings”; - Create a new
    project (if you don’t have one already) and give it a name (e.g. Internal
    chatbot); - Copy the nebuly `default_key` that has been assigned to the
    project.
</Accordion>

## Step 1: Send Eligible Users

There are three available endpoints to manage eligible users:

<CardGroup cols={3}>
  <Card title="Send Eligible Users" icon="user-plus" href="/eligible-users/api-reference/send-eligible-users" />

  <Card title="Update Eligible Users" icon="user-gear" href="/eligible-users/api-reference/update-eligible-users" />

  <Card title="Delete Eligible Users" icon="user-minus" href="/eligible-users/api-reference/delete-eligible-users" />
</CardGroup>

Each endpoint allows you to insert, update, or delete eligible users by providing a list of user records with structured metadata. This gives Nebuly visibility into your total addressable user base at any point in time.

We also provide a `GET` endpoint to retrieve all eligible users for inspection:

<CardGroup cols={3}>
  <Card title="View Eligible Users" icon="users" href="/eligible-users/api-reference/get-eligible-users" />
</CardGroup>

## Why are Eligible Users Important?

While interaction events tell us **what users did**, eligible users tell us **who could have done it**. This context is crucial for meaningful metrics:

* If you had 100 users with access last week, and only 10 used the system, your **activation rate** is 10%.
* If you remove old users or add new ones but don’t update the eligible user list, metrics like activation rate become misleading.

Keeping the eligible user list **fresh and synchronized** ensures accurate metric computation.