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

> ## Agent Instructions
> Use the public API base URL: https://api.teamfollowup.ai/api.
> Authenticate public API requests with Authorization: Bearer YOUR_API_KEY.
> Use product-owned terms: agents, campaigns, projects (GoHighLevel sub-accounts), contacts, calls, outcomes, skills, cadences, phone numbers.
> Scope requests by locationId rather than projectName.
> Read the guide linked from each API reference group before recommending an endpoint.

# Analytics API

> Booking rate, pickup, conversation and transfer figures for a window, scoped to a project, campaign, master agent or split-test variant.

Every figure these endpoints return is defined, with its formula, in
[Metrics and how they are calculated](/analytics/overview).

| Endpoint                                                                              | Use it to                                         |
| ------------------------------------------------------------------------------------- | ------------------------------------------------- |
| [Get analytics summary](/api-reference/analytics/get-analytics-summary)               | Read every count and rate for a window and scope. |
| [Get booking rate by project](/api-reference/analytics/get-booking-rate-by-project)   | Compare projects by `bookingRate`.                |
| [Get transfer rate by project](/api-reference/analytics/get-transfer-rate-by-project) | Compare projects by `transferRate`.               |

Scope with `locationId`, `campaignId`, `masterCampaignId` or `agentVariantId`.
Dates follow the rules in [Conventions](/conventions#dates-and-times).

Scopes: `dashboard:read`. See [Authentication](/authentication#scopes).

## Guides

* [Metrics and how they are calculated](/analytics/overview)
* [Run a split test](/split-testing/run-a-split-test) for per-variant reads.
* [Glossary](/glossary#analytics)