> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://helpdesk.ggcircuit.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API

# API Integration

Leverage ggLeap’s RESTful API to automate workflows, integrate with external systems, and extend your center’s capabilities. Configure your API token, select the appropriate rate-limit plan, and monitor your usage—all from **Settings** ▶ **API**.

---


## Public API Token

Location: Settings ▶ API ▶ **Public API`

![](https://ggcircuit.atlassian.net/wiki/download/attachments/15862859/image-20250519-001436.png?version=1&modificationDate=1747613680044&cacheVersion=1&api=v2)

Generate a secure token tied to your center for authenticating API calls:

* **Email**  
  Enter the developer’s email address. That address will receive updates about API changes.
* **Generate token**  
  Click to create your center’s unique bearer token. Store it securely—this is the only time you’ll see it.
* **API documentation**  
  Opens the full Swagger-style reference at  
  [https://admin.ggleap.com/public-api-documentation](https://admin.ggleap.com/public-api-documentation)

---

## API Rate Limits

Location: Settings ▶ API ▶ API rate limits

![](https://ggcircuit.atlassian.net/wiki/download/attachments/15862859/image-20250519-001442.png?version=1&modificationDate=1747613686164&cacheVersion=1&api=v2)

Choose the plan that matches your integration’s call volume:

| **Plan** | **Max RPM** | **Max RPD** | **Price** | **Action** |
| ---- |
| **Basic** | 20 | 10,000 | Included with ggLeap | (no charge) |
| **Pro** | 50 | 30,000 | $50 / month or $500 / year | **Contact sales** |
| **Enterprise** | 100 | 60,000 | $100 / month or $1,000 / year | **Contact sales** |

* **Subscribed** badge indicates your current plan.
* Click **Contact sales** to upgrade to a higher tier for heavier usage.

---

## API Usage Dashboard

Location: Settings ▶ API ▶ API usage

![](https://ggcircuit.atlassian.net/wiki/download/attachments/15862859/image-20250519-001449.png?version=1&modificationDate=1747613692619&cacheVersion=1&api=v2)

Monitor your center’s real-time API consumption:

1. **Current API usage plan**  
   Displays your active plan name, RPM, and RPD limits.
2. **Quota usage**  
   Visual progress bar showing total daily calls used vs. daily allowance.
3. **API usage statistics**

* **Date range** & **Endpoint** filters to narrow reports.
* **Summary** section with totals for passed, burst-rejected, and quota-rejected calls.
4. **Daily breakdown table**  
   Lists each date with counts of:

* **Passed** requests
* **Burst rejected** (over RPM)
* **Quota rejected** (over RPD)
* **Total** attempted
5. **Endpoint breakdown table**  
   Shows per‐endpoint usage to identify your heaviest API consumers.




> Tip:
> 
> * Track both burst and quota rejections to fine-tune your integration’s throttling logic.
> * Review endpoint usage weekly to ensure you’re on the right plan or if you need to upgrade.