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

# Introduction

> Apitally makes API monitoring and analytics simple. Get API metrics, request logs, traces, and alerts by adding just a few lines of code.

<img src="https://assets.apitally.io/screenshots/overview.png" alt="Apitally overview slideshow" className="rounded-xl" />

## Explore

Find out whether Apitally meets your requirements.

<CardGroup cols={3}>
  <Card title="Features" icon="list-check" href="/api-metrics/overview">
    Metrics, request logs, traces, monitoring, and more.
  </Card>

  <Card title="How it works" icon="gears" href="/how-it-works">
    Learn how Apitally integrates with your application.
  </Card>

  <Card title="Data privacy" icon="shield-check" href="/data-privacy">
    Learn how Apitally handles data collection, masking, storage, etc.
  </Card>
</CardGroup>

## Get started

Set up Apitally for your API in under 5 minutes.

<Steps>
  <Step icon="plus" iconType="regular" title="Create app in Apitally dashboard">
    [Sign up](https://app.apitally.io/?signup) to create an account if you don't have one yet.
    Then click the *Create app* button on the dashboard. Provide a name and select your framework.
  </Step>

  <Step icon="code-pull-request" iconType="regular" title="Add middleware to your application">
    Follow the instructions on the dashboard to add the Apitally middleware to your application.
    It's just a small dependency to install and a few lines of code to copy & paste.
  </Step>

  <Step icon="rocket" iconType="regular" title="Deploy your application">
    Deploy your application, or restart it if you're testing locally.
    You'll see the first data in the dashboard within a few seconds.
  </Step>
</Steps>

For a complete setup guide, select your framework from the options below.

<AccordionGroup>
  <Accordion title="Python">
    <CardGroup cols={3}>
      <Card
        title="BlackSheep"
        icon={
<img
  src="https://assets.apitally.io/frameworks/blacksheep-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="BlackSheep icon"
/>
}
        href="/setup-guides/blacksheep"
      />

      <Card
        title="Django Ninja"
        icon={
<img
  src="https://assets.apitally.io/frameworks/django-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Django icon"
/>
}
        href="/setup-guides/django-ninja"
      />

      <Card
        title="Django REST Framework"
        icon={
<img
  src="https://assets.apitally.io/frameworks/django-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Django icon"
/>
}
        href="/setup-guides/django-rest-framework"
      />

      <Card
        title="FastAPI"
        icon={
<img
  src="https://assets.apitally.io/frameworks/fastapi-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="FastAPI icon"
/>
}
        href="/setup-guides/fastapi"
      />

      <Card
        title="Flask"
        icon={
<img
  src="https://assets.apitally.io/frameworks/flask-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Flask icon"
/>
}
        href="/setup-guides/flask"
      />

      <Card
        title="Litestar"
        icon={
<img
  src="https://assets.apitally.io/frameworks/litestar-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Litestar icon"
/>
}
        href="/setup-guides/litestar"
      />

      <Card
        title="Starlette"
        icon={
<img
  src="https://assets.apitally.io/frameworks/starlette-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Starlette icon"
/>
}
        href="/setup-guides/starlette"
      />
    </CardGroup>
  </Accordion>

  <Accordion title="JavaScript">
    <CardGroup cols={3}>
      <Card
        title="AdonisJS"
        icon={
<img
  src="https://assets.apitally.io/frameworks/adonisjs-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="AdonisJS icon"
/>
}
        href="/setup-guides/adonisjs"
      />

      <Card
        title="Elysia"
        icon={
<img
  src="https://assets.apitally.io/frameworks/elysia-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Elysia icon"
/>
}
        href="/setup-guides/elysia"
      />

      <Card
        title="Express"
        icon={
<img
  src="https://assets.apitally.io/frameworks/express-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Express icon"
/>
}
        href="/setup-guides/express"
      />

      <Card
        title="Fastify"
        icon={
<img
  src="https://assets.apitally.io/frameworks/fastify-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Fastify icon"
/>
}
        href="/setup-guides/fastify"
      />

      <Card
        title="H3"
        icon={
<img
  src="https://assets.apitally.io/frameworks/h3-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="H3 icon"
/>
}
        href="/setup-guides/h3"
      />

      <Card
        title="hapi"
        icon={
<img
  src="https://assets.apitally.io/frameworks/hapi-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="hapi icon"
/>
}
        href="/setup-guides/hapi"
      />

      <Card
        title="Hono"
        icon={
<img
  src="https://assets.apitally.io/frameworks/hono-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Hono icon"
/>
}
        href="/setup-guides/hono"
      />

      <Card
        title="Koa"
        icon={
<img
  src="https://assets.apitally.io/frameworks/koa-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Koa icon"
/>
}
        href="/setup-guides/koa"
      />

      <Card
        title="NestJS"
        icon={
<img
  src="https://assets.apitally.io/frameworks/nestjs-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="NestJS icon"
/>
}
        href="/setup-guides/nestjs"
      />
    </CardGroup>
  </Accordion>

  <Accordion title="Go">
    <CardGroup cols={3}>
      <Card
        title="Chi"
        icon={
<img
  src="https://assets.apitally.io/frameworks/chi-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Chi icon"
/>
}
        href="/setup-guides/chi"
      />

      <Card
        title="Echo"
        icon={
<img
  src="https://assets.apitally.io/frameworks/echo-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Echo icon"
/>
}
        href="/setup-guides/echo"
      />

      <Card
        title="Fiber"
        icon={
<img
  src="https://assets.apitally.io/frameworks/fiber-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Fiber icon"
/>
}
        href="/setup-guides/fiber"
      />

      <Card
        title="Gin"
        icon={
<img
  src="https://assets.apitally.io/frameworks/gin-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Gin icon"
/>
}
        href="/setup-guides/gin"
      />
    </CardGroup>
  </Accordion>

  <Accordion title="Java">
    <CardGroup cols={3}>
      <Card
        title="Spring Boot"
        icon={
<img
  src="https://assets.apitally.io/frameworks/spring-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Spring icon"
/>
}
        href="/setup-guides/spring-boot"
      />
    </CardGroup>
  </Accordion>

  <Accordion title=".NET">
    <CardGroup cols={3}>
      <Card
        title="ASP.NET Core"
        icon={
<img
  src="https://assets.apitally.io/frameworks/dotnet-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt=".NET icon"
/>
}
        href="/setup-guides/aspnet-core"
      />
    </CardGroup>
  </Accordion>

  <Accordion title="Cloudflare Workers">
    <CardGroup cols={3}>
      <Card
        title="FastAPI"
        icon={
<img
  src="https://assets.apitally.io/frameworks/fastapi-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="FastAPI icon"
/>
}
        href="/setup-guides/fastapi-cloudflare-workers"
      >
        Cloudflare Workers
      </Card>

      <Card
        title="Hono"
        icon={
<img
  src="https://assets.apitally.io/frameworks/hono-icon.svg"
  style={{ height: "32px", maxWidth: "unset", margin: 0 }}
  alt="Hono icon"
/>
}
        href="/setup-guides/hono-cloudflare-workers"
      >
        Cloudflare Workers
      </Card>
    </CardGroup>
  </Accordion>
</AccordionGroup>

If your framework is not listed here, please [let us know](/support) and we'll consider adding support for it.
