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

# API Overview

> Learn about the Doozy Public API for reporting and analytics

<Warning>
  The Doozy API is currently in **closed beta**. To request access, please email [hello@doozy.live](mailto:hello@doozy.live).
</Warning>

The Doozy Public API provides access to your Doozy data, designed primarily for reporting and analytics use cases, as well as enrolling users on to tracks. Use it to extract quiz results, survey responses, and other engagement data into your preferred reporting tools.

## Base URL

All API requests should be made to:

```
https://api.doozy.live
```

## Available Endpoints

### Quizzes

The Quiz API allows you to retrieve quiz data and detailed analytics reports:

| Endpoint                          | Description                                                  |
| --------------------------------- | ------------------------------------------------------------ |
| `GET /v1/quizzes`                 | List all quizzes you have access to                          |
| `GET /v1/quizzes/{quizId}`        | Get detailed quiz information including rounds and questions |
| `GET /v1/quizzes/{quizId}/report` | Get comprehensive analytics and participant responses        |

## Pagination

The API uses cursor-based pagination for list endpoints. Use these query parameters:

| Parameter        | Description                                                    | Default | Maximum |
| ---------------- | -------------------------------------------------------------- | ------- | ------- |
| `limit`          | Number of items to return                                      | 25      | 100     |
| `starting_after` | Cursor for pagination (ID of the last item from previous page) | -       | -       |

### Example

```bash theme={null}
# First page
curl https://api.doozy.live/v1/quizzes?limit=25 \
  -H "x-api-key: dzy_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Next page (using the last quiz ID from the previous response)
curl https://api.doozy.live/v1/quizzes?limit=25&starting_after=quiz_abc123 \
  -H "x-api-key: dzy_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
```

## OpenAPI Specification

Download the full OpenAPI specification for use with API clients, code generators, or other tooling:

<Card title="Download OpenAPI Spec" icon="download" href="/openapi.json">
  OpenAPI 3.1 specification (JSON)
</Card>

## Next Steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    Learn how to generate and manage API keys
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/api/errors">
    Understand API error responses
  </Card>
</CardGroup>