@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/agency.md

@@ -0,0 +1,845 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.agency`: Agency
+
+24 operations (24 read).
+
+2 of these also have a hand-written method (`g8.agency`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [agency.d.ts](agency.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`getAccountHealth`](#op-getaccounthealth) | `GET /api/v1/agency/reports/health` | read | `analytics:read` | Get Account Health |
+| [`getAgencyDialerDashboard`](#op-getagencydialerdashboard) | `GET /api/v1/agency/reports/dialer/dashboard` | read | `analytics:read` | Get Agency Dialer Dashboard |
+| [`getAgencyDialerLeaderboard`](#op-getagencydialerleaderboard) | `GET /api/v1/agency/reports/dialer/leaderboard` | read | `analytics:read` | Get Agency Dialer Leaderboard |
+| [`getAgencyDialerQualityLeaderboard`](#op-getagencydialerqualityleaderboard) | `GET /api/v1/agency/reports/dialer/quality-leaderboard` | read | `analytics:read` | Get Agency Dialer Quality Leaderboard |
+| [`getAgencyLeaderboard`](#op-getagencyleaderboard) | `GET /api/v1/agency/reports/leaderboard` | read | `analytics:read` | Get Agency Leaderboard |
+| [`getAgencyMe`](#op-getagencyme) ★ | `GET /api/v1/agency/me` | read | `account:read` | Get Agency Me |
+| [`getAgencySdrLeaderboard`](#op-getagencysdrleaderboard) | `GET /api/v1/agency/reports/sdr-leaderboard` | read | `analytics:read` | Get Agency Sdr Leaderboard |
+| [`getAgencySequenceLeaderboard`](#op-getagencysequenceleaderboard) | `GET /api/v1/agency/reports/sequence-leaderboard` | read | `analytics:read` | Get Agency Sequence Leaderboard |
+| [`getAgencyTrends`](#op-getagencytrends) | `GET /api/v1/agency/reports/trends` | read | `analytics:read` | Get Agency Trends |
+| [`getClientComparison`](#op-getclientcomparison) | `GET /api/v1/agency/reports/comparison` | read | `analytics:read` | Get Client Comparison |
+| [`getClientDeliverability`](#op-getclientdeliverability) | `GET /api/v1/agency/reports/clients/{org_id}/deliverability` | read | `analytics:read` | Get Client Deliverability |
+| [`getClientDetail`](#op-getclientdetail) | `GET /api/v1/agency/reports/clients/{org_id}` | read | `analytics:read` | Get Client Detail |
+| [`getClientSequences`](#op-getclientsequences) | `GET /api/v1/agency/reports/clients/{org_id}/sequences` | read | `analytics:read` | Get Client Sequences |
+| [`getConsolidatedSummary`](#op-getconsolidatedsummary) | `GET /api/v1/agency/reports/summary` | read | `analytics:read` | Get Consolidated Summary |
+| [`getCrossOrgDeliverability`](#op-getcrossorgdeliverability) | `GET /api/v1/agency/reports/deliverability` | read | `analytics:read` | Get Cross Org Deliverability |
+| [`getMeetingsByChannel`](#op-getmeetingsbychannel) | `GET /api/v1/agency/reports/meetings/by-channel` | read | `analytics:read` | Get Meetings By Channel |
+| [`getMeetingsCountForChannel`](#op-getmeetingscountforchannel) | `GET /api/v1/agency/reports/meetings/count` | read | `analytics:read` | Get Meetings Count For Channel |
+| [`getMeetingsLeaderboard`](#op-getmeetingsleaderboard) | `GET /api/v1/agency/reports/meetings` | read | `analytics:read` | Get Meetings Leaderboard |
+| [`getVoiceAiAgentLeaderboard`](#op-getvoiceaiagentleaderboard) | `GET /api/v1/agency/reports/voice-ai/agent-leaderboard` | read | `analytics:read` | Get Voice Ai Agent Leaderboard |
+| [`getVoiceAiDashboard`](#op-getvoiceaidashboard) | `GET /api/v1/agency/reports/voice-ai/dashboard` | read | `analytics:read` | Get Voice Ai Dashboard |
+| [`getVoiceAiQualityLeaderboard`](#op-getvoiceaiqualityleaderboard) | `GET /api/v1/agency/reports/voice-ai/quality-leaderboard` | read | `analytics:read` | Get Voice Ai Quality Leaderboard |
+| [`listAgencyClients`](#op-listagencyclients) ★ | `GET /api/v1/agency/clients` | read | `account:read` | List Agency Clients |
+| [`searchAgencyGradedCalls`](#op-searchagencygradedcalls) | `POST /api/v1/agency/reports/dialer/grading/search` | read | `analytics:read` | Search Agency Graded Calls |
+| [`searchVoiceAiGradedCalls`](#op-searchvoiceaigradedcalls) | `POST /api/v1/agency/reports/voice-ai/grading/search` | read | `analytics:read` | Search Voice Ai Graded Calls |
+
+---
+
+<a id="op-getaccounthealth"></a>
+
+### `g8.api.agency.getAccountHealth(input?)`
+
+**Get Account Health**
+
+- HTTP: `GET /api/v1/agency/reports/health`
+- operationId: `get_account_health_agency_reports_health_get` (also callable as `g8.api.call("get_account_health_agency_reports_health_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+A health score per client - which accounts need attention.
+
+The report to poll if you only poll one: it is the agency's own churn
+early-warning, and it is cached for five minutes rather than one.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAccountHealth();
+```
+
+---
+
+<a id="op-getagencydialerdashboard"></a>
+
+### `g8.api.agency.getAgencyDialerDashboard(input)`
+
+**Get Agency Dialer Dashboard**
+
+- HTTP: `GET /api/v1/agency/reports/dialer/dashboard`
+- operationId: `get_agency_dialer_dashboard_agency_reports_dialer_dashboard_get` (also callable as `g8.api.call("get_agency_dialer_dashboard_agency_reports_dialer_dashboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Dialer KPIs aggregated over every client.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.start_date` | `string` | yes | Start date, `YYYY-MM-DD`. |
+| `query.end_date` | `string` | yes | End date, `YYYY-MM-DD`. |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencyDialerDashboard({ query: { start_date: "example", end_date: "example" } });
+```
+
+---
+
+<a id="op-getagencydialerleaderboard"></a>
+
+### `g8.api.agency.getAgencyDialerLeaderboard(input)`
+
+**Get Agency Dialer Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/dialer/leaderboard`
+- operationId: `get_agency_dialer_leaderboard_agency_reports_dialer_leaderboard_get` (also callable as `g8.api.call("get_agency_dialer_leaderboard_agency_reports_dialer_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Every rep's dialling, across every client, ranked.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.start_date` | `string` | yes | Start date, `YYYY-MM-DD`. |
+| `query.end_date` | `string` | yes | End date, `YYYY-MM-DD`. |
+| `query.sort_by` | `"dials" \| "meetings_booked" \| "connect_rate" \| "talk_time_minutes" \| "avg_quality_score"` | no | Metric to rank on. default `"dials"` |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencyDialerLeaderboard({ query: { start_date: "example", end_date: "example" } });
+```
+
+---
+
+<a id="op-getagencydialerqualityleaderboard"></a>
+
+### `g8.api.agency.getAgencyDialerQualityLeaderboard(input)`
+
+**Get Agency Dialer Quality Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/dialer/quality-leaderboard`
+- operationId: `get_agency_dialer_quality_leaderboard_agency_reports_dialer_quality_leaderboard_get` (also callable as `g8.api.call("get_agency_dialer_quality_leaderboard_agency_reports_dialer_quality_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Call QUALITY scores, across every client - how calls went, not how many.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.start_date` | `string` | yes | Start date, `YYYY-MM-DD`. |
+| `query.end_date` | `string` | yes | End date, `YYYY-MM-DD`. |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencyDialerQualityLeaderboard({ query: { start_date: "example", end_date: "example" } });
+```
+
+---
+
+<a id="op-getagencyleaderboard"></a>
+
+### `g8.api.agency.getAgencyLeaderboard(input?)`
+
+**Get Agency Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/leaderboard`
+- operationId: `get_agency_leaderboard_agency_reports_leaderboard_get` (also callable as `g8.api.call("get_agency_leaderboard_agency_reports_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Clients ranked against each other - best and worst performers.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+| `query.sort_by` | `"reply_rate" \| "emails_sent" \| "meetings_booked" \| "connect_rate"` | no | Metric to rank on. default `"reply_rate"` |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+| `query.meetings_channel` | `string \| null` | no | Count `meetings_booked` from ONE source channel instead of all of them. Changes what the ranking means, so set it deliberately. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencyLeaderboard();
+```
+
+---
+
+<a id="op-getagencyme"></a>
+
+### `g8.api.agency.getAgencyMe(input?)`
+
+**Get Agency Me**
+
+- HTTP: `GET /api/v1/agency/me`
+- operationId: `get_agency_me_agency_me_get` (also callable as `g8.api.call("get_agency_me_agency_me_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+- ★ Hand-written: [`g8.agency.me()`](../sdk-clients.md#g8-agency-me)
+
+Describe the agency credential: agency org + authorized client count.
+
+**Input**: none.
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencyMe();
+```
+
+---
+
+<a id="op-getagencysdrleaderboard"></a>
+
+### `g8.api.agency.getAgencySdrLeaderboard(input?)`
+
+**Get Agency Sdr Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/sdr-leaderboard`
+- operationId: `get_agency_sdr_leaderboard_agency_reports_sdr_leaderboard_get` (also callable as `g8.api.call("get_agency_sdr_leaderboard_agency_reports_sdr_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Every rep at every client, ranked together.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+| `query.sort_by` | `"reply_rate" \| "emails_sent" \| "meetings_booked" \| "activity_score" \| "dials" \| "connected" \| "talk_time_minutes" \| "grade_overall"` | no | Metric to rank on. default `"reply_rate"` |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencySdrLeaderboard();
+```
+
+---
+
+<a id="op-getagencysequenceleaderboard"></a>
+
+### `g8.api.agency.getAgencySequenceLeaderboard(input?)`
+
+**Get Agency Sequence Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/sequence-leaderboard`
+- operationId: `get_agency_sequence_leaderboard_agency_reports_sequence_leaderboard_get` (also callable as `g8.api.call("get_agency_sequence_leaderboard_agency_reports_sequence_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Every sequence at every client, ranked together.
+
+What an agency reuses a playbook on: the sequence that works at one client
+is the one to run at the next.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+| `query.sort_by` | `"reply_rate" \| "contacted" \| "meetings_booked" \| "voice_ai_dials"` | no | Metric to rank on. default `"reply_rate"` |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencySequenceLeaderboard();
+```
+
+---
+
+<a id="op-getagencytrends"></a>
+
+### `g8.api.agency.getAgencyTrends(input?)`
+
+**Get Agency Trends**
+
+- HTTP: `GET /api/v1/agency/reports/trends`
+- operationId: `get_agency_trends_agency_reports_trends_get` (also callable as `g8.api.call("get_agency_trends_agency_reports_trends_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Activity across every client over time.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+| `query.granularity` | `"day" \| "week"` | no | Bucket size. default `"day"` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getAgencyTrends();
+```
+
+---
+
+<a id="op-getclientcomparison"></a>
+
+### `g8.api.agency.getClientComparison(input?)`
+
+**Get Client Comparison**
+
+- HTTP: `GET /api/v1/agency/reports/comparison`
+- operationId: `get_client_comparison_agency_reports_comparison_get` (also callable as `g8.api.call("get_client_comparison_agency_reports_comparison_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Every client side by side on every metric, unranked.
+
+The leaderboard sorts on ONE metric; this is the whole grid, for when the
+question is not "who is top" but "who is different".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getClientComparison();
+```
+
+---
+
+<a id="op-getclientdeliverability"></a>
+
+### `g8.api.agency.getClientDeliverability(input)`
+
+**Get Client Deliverability**
+
+- HTTP: `GET /api/v1/agency/reports/clients/{org_id}/deliverability`
+- operationId: `get_client_deliverability_agency_reports_clients__org_id__deliverability_get` (also callable as `g8.api.call("get_client_deliverability_agency_reports_clients__org_id__deliverability_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+One client's sending health.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.org_id` | `string` | yes | Client org id. |
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getClientDeliverability({ path: { org_id: "id" } });
+```
+
+---
+
+<a id="op-getclientdetail"></a>
+
+### `g8.api.agency.getClientDetail(input)`
+
+**Get Client Detail**
+
+- HTTP: `GET /api/v1/agency/reports/clients/{org_id}`
+- operationId: `get_client_detail_agency_reports_clients__org_id__get` (also callable as `g8.api.call("get_client_detail_agency_reports_clients__org_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+One client's full metric set.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.org_id` | `string` | yes | Client org id, from GET /agency/clients. |
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getClientDetail({ path: { org_id: "id" } });
+```
+
+---
+
+<a id="op-getclientsequences"></a>
+
+### `g8.api.agency.getClientSequences(input)`
+
+**Get Client Sequences**
+
+- HTTP: `GET /api/v1/agency/reports/clients/{org_id}/sequences`
+- operationId: `get_client_sequences_agency_reports_clients__org_id__sequences_get` (also callable as `g8.api.call("get_client_sequences_agency_reports_clients__org_id__sequences_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+One client's live sequence states and their performance.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.org_id` | `string` | yes | Client org id. |
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getClientSequences({ path: { org_id: "id" } });
+```
+
+---
+
+<a id="op-getconsolidatedsummary"></a>
+
+### `g8.api.agency.getConsolidatedSummary(input?)`
+
+**Get Consolidated Summary**
+
+- HTTP: `GET /api/v1/agency/reports/summary`
+- operationId: `get_consolidated_summary_agency_reports_summary_get` (also callable as `g8.api.call("get_consolidated_summary_agency_reports_summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Every client's numbers, added up. The agency top line.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getConsolidatedSummary();
+```
+
+---
+
+<a id="op-getcrossorgdeliverability"></a>
+
+### `g8.api.agency.getCrossOrgDeliverability(input?)`
+
+**Get Cross Org Deliverability**
+
+- HTTP: `GET /api/v1/agency/reports/deliverability`
+- operationId: `get_cross_org_deliverability_agency_reports_deliverability_get` (also callable as `g8.api.call("get_cross_org_deliverability_agency_reports_deliverability_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Sending health across every client, in one view.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getCrossOrgDeliverability();
+```
+
+---
+
+<a id="op-getmeetingsbychannel"></a>
+
+### `g8.api.agency.getMeetingsByChannel(input?)`
+
+**Get Meetings By Channel**
+
+- HTTP: `GET /api/v1/agency/reports/meetings/by-channel`
+- operationId: `get_meetings_by_channel_agency_reports_meetings_by_channel_get` (also callable as `g8.api.call("get_meetings_by_channel_agency_reports_meetings_by_channel_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Which channel booked each meeting, across every client.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getMeetingsByChannel();
+```
+
+---
+
+<a id="op-getmeetingscountforchannel"></a>
+
+### `g8.api.agency.getMeetingsCountForChannel(input)`
+
+**Get Meetings Count For Channel**
+
+- HTTP: `GET /api/v1/agency/reports/meetings/count`
+- operationId: `get_meetings_count_for_channel_agency_reports_meetings_count_get` (also callable as `g8.api.call("get_meetings_count_for_channel_agency_reports_meetings_count_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+One channel's meeting count, across every client.
+
+The cheap version of `/meetings/by-channel` when only one channel is
+wanted - it does not compute the rest.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.channel` | `string` | yes | The single channel to count. |
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getMeetingsCountForChannel({ query: { channel: "example" } });
+```
+
+---
+
+<a id="op-getmeetingsleaderboard"></a>
+
+### `g8.api.agency.getMeetingsLeaderboard(input?)`
+
+**Get Meetings Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/meetings`
+- operationId: `get_meetings_leaderboard_agency_reports_meetings_get` (also callable as `g8.api.call("get_meetings_leaderboard_agency_reports_meetings_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Meetings per client, with cost per meeting.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Trailing window, in days, ending today (UTC). default `30` |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getMeetingsLeaderboard();
+```
+
+---
+
+<a id="op-getvoiceaiagentleaderboard"></a>
+
+### `g8.api.agency.getVoiceAiAgentLeaderboard(input)`
+
+**Get Voice Ai Agent Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/voice-ai/agent-leaderboard`
+- operationId: `get_voice_ai_agent_leaderboard_agency_reports_voice_ai_agent_leaderboard_get` (also callable as `g8.api.call("get_voice_ai_agent_leaderboard_agency_reports_voice_ai_agent_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Voice AI agents ranked across every client.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.start_date` | `string` | yes | Start date, `YYYY-MM-DD`. |
+| `query.end_date` | `string` | yes | End date, `YYYY-MM-DD`. |
+| `query.sort_by` | `"calls_initiated" \| "calls_completed" \| "completion_rate" \| "voicemails_left"` | no | Metric to rank on. default `"calls_initiated"` |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getVoiceAiAgentLeaderboard({ query: { start_date: "example", end_date: "example" } });
+```
+
+---
+
+<a id="op-getvoiceaidashboard"></a>
+
+### `g8.api.agency.getVoiceAiDashboard(input)`
+
+**Get Voice Ai Dashboard**
+
+- HTTP: `GET /api/v1/agency/reports/voice-ai/dashboard`
+- operationId: `get_voice_ai_dashboard_agency_reports_voice_ai_dashboard_get` (also callable as `g8.api.call("get_voice_ai_dashboard_agency_reports_voice_ai_dashboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Voice AI totals, per-client summary and daily trend.
+
+The app calls this route `dashboard-v2`. An iteration number is an
+internal fact about how the report was built, not something a customer
+should have to type, so it is published as `dashboard` - there is no v1 in
+this contract for it to be confused with.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.start_date` | `string` | yes | Start date, `YYYY-MM-DD`. |
+| `query.end_date` | `string` | yes | End date, `YYYY-MM-DD`. |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getVoiceAiDashboard({ query: { start_date: "example", end_date: "example" } });
+```
+
+---
+
+<a id="op-getvoiceaiqualityleaderboard"></a>
+
+### `g8.api.agency.getVoiceAiQualityLeaderboard(input)`
+
+**Get Voice Ai Quality Leaderboard**
+
+- HTTP: `GET /api/v1/agency/reports/voice-ai/quality-leaderboard`
+- operationId: `get_voice_ai_quality_leaderboard_agency_reports_voice_ai_quality_leaderboard_get` (also callable as `g8.api.call("get_voice_ai_quality_leaderboard_agency_reports_voice_ai_quality_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Voice AI agents ranked on call QUALITY rather than volume.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.start_date` | `string` | yes | Start date, `YYYY-MM-DD`. |
+| `query.end_date` | `string` | yes | End date, `YYYY-MM-DD`. |
+| `query.limit` | `integer` | no | Rows to return. default `20` |
+| `query.org_filter` | `string \| null` | no | Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.getVoiceAiQualityLeaderboard({ query: { start_date: "example", end_date: "example" } });
+```
+
+---
+
+<a id="op-listagencyclients"></a>
+
+### `g8.api.agency.listAgencyClients(input?)`
+
+**List Agency Clients**
+
+- HTTP: `GET /api/v1/agency/clients`
+- operationId: `list_agency_clients_agency_clients_get` (also callable as `g8.api.call("list_agency_clients_agency_clients_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+- ★ Hand-written: [`g8.agency.clients()`](../sdk-clients.md#g8-agency-clients)
+
+List the client orgs this agency key may target via X-Target-Org-Id.
+
+Each entry's ``org_id`` is the value to pass in the ``X-Target-Org-Id``
+header on any subsequent request to operate that client org.
+
+**Input**: none.
+
+**Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.listAgencyClients();
+```
+
+---
+
+<a id="op-searchagencygradedcalls"></a>
+
+### `g8.api.agency.searchAgencyGradedCalls(input)`
+
+**Search Agency Graded Calls**
+
+- HTTP: `POST /api/v1/agency/reports/dialer/grading/search`
+- operationId: `search_agency_graded_calls_agency_reports_dialer_grading_search_post` (also callable as `g8.api.call("search_agency_graded_calls_agency_reports_dialer_grading_search_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Find graded calls across every client.
+
+A POST because the filter is a body, NOT because it writes - it reads, and
+it is tiered `read` for that reason rather than deriving `write` from the
+method. The body is an open dict here because it is an open dict in the
+app: the handler reads known keys off it with `.get` and ignores the rest,
+so mirroring it as a closed model would REJECT filters the app accepts.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `Record<string, unknown>` | yes | Request body; fields below. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.searchAgencyGradedCalls({ body: {} });
+```
+
+---
+
+<a id="op-searchvoiceaigradedcalls"></a>
+
+### `g8.api.agency.searchVoiceAiGradedCalls(input)`
+
+**Search Voice Ai Graded Calls**
+
+- HTTP: `POST /api/v1/agency/reports/voice-ai/grading/search`
+- operationId: `search_voice_ai_graded_calls_agency_reports_voice_ai_grading_search_post` (also callable as `g8.api.call("search_voice_ai_graded_calls_agency_reports_voice_ai_grading_search_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Find graded Voice AI calls across every client. Reads; does not write.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `Record<string, unknown>` | yes | Request body; fields below. |
+
+**Returns** `ApiResponse_ReportPayload_`: the envelope `{ data: ReportPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.agency.searchVoiceAiGradedCalls({ body: {} });
+```