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

# Plaid API Usage

> Admin dashboard showing Plaid API request counts, rate limit hits, and sync success rates by institution in Finance & Revenue.

The Plaid API Usage dashboard at `/fa/banking/plaid-usage` provides operational metrics for the Plaid bank connection integration, including API request counts, rate limit events, and per-institution sync success rates.

## Overview

The route `/fa/banking/plaid-usage` loads `PlaidApiUsageDashboard` (permission: `fa.banking.admin`). The dashboard displays:

* Five summary metric cards (observable from skeleton layout: 5 cards).
* Two side-by-side charts (area chart and bar chart using Recharts).
* A detail table (per-institution breakdown).

Date range is selectable: 7 days, 30 days (default), or 90 days. Data is fetched via `usePlaidApiUsageDashboard`. A manual refresh button is present.

## Who it's for

Requires permission `fa.banking.admin`.

## Before you start

* Plaid must be configured and at least one bank connection established.
* This dashboard is for operational/administrative monitoring only.

## Steps

1. Navigate to **Finance & Revenue → Banking → Plaid API Usage**, or go to `/fa/banking/plaid-usage`.
2. Select the desired date range (7d, 30d, or 90d).
3. Review the summary metrics, charts, and per-institution table.
4. Use the refresh button to reload the latest data.

## Key concepts

**`DateRangeOption`** — Accepted values: `'7d'`, `'30d'`, `'90d'`.

**Rate limit hits** — Events where the Plaid API returned a rate-limit response; visible in the dashboard for monitoring integration health.

**Sync success rate** — The ratio of successful data syncs to total sync attempts per institution.

## Related

<Columns cols={2}>
  <Card title="Finance & Revenue" icon="building-columns" href="/fa/overview">
    Finance & Revenue core overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index" />
</Columns>

<Note>
  This page documents shipped product behavior. It is not medical, legal, or
  billing advice. Verify against your organization's policies and applicable
  regulations before using it for clinical, compliance, or billing decisions.
  Protected health information (PHI) shown in the product is governed by your
  tenant's access controls and is never exposed in this documentation.
</Note>

<Accordion title="Documentation sources">
  * src/routes/fa.tsx
  * src/cores/fa/pages/PlaidApiUsageDashboard.tsx
  * src/cores/fa/hooks/usePlaidApiUsageDashboard.ts
</Accordion>