Get Portfolio Summary
paybond_get_portfolio_summaryFetch a read-only portfolio aggregate for your API key, including operator count, average score, total intents, and receipted volume. Use to monitor Signal portfolio health.
Instructions
Use this when you need a read-only, tenant-scoped Signal portfolio aggregate for the authenticated API key (operator_count, average_score, total_terminal_intents, total_receipted_volume_cents, operators_under_review, and checkpoint_last_ledger_seq). Requires PAYBOND_API_KEY with Signal analytics read access and the private-dashboards feature. Do not use this when you need a portable signed operator list for partner or verifier sharing—call paybond_get_signed_portfolio_artifact instead—or for one operator's signed receipt—call paybond_get_reputation_receipt. Idempotent read with no side effects; auth, RBAC, feature, or gateway failures surface as tool errors.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| score_version | No | Optional Signal score model version to query. Omit to use the gateway default current model (1.0). Example: 1.0. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tenant_id | No | Tenant echoed by the gateway for the authenticated API key (example: tenant-a). | |
| average_score | No | Average operator score across the tenant portfolio for this score model version. | |
| scoring_model | No | Scoring model identifier used by Signal for this summary. | |
| operator_count | No | Number of operators with reputation data for this score model version. | |
| schema_version | No | Portfolio summary schema version (currently 1). | |
| score_model_version | No | Score model version used for the aggregate (echoes the requested score_version or the gateway default 1.0). | |
| operators_under_review | No | Count of operators currently under Signal review for this score model version. | |
| total_terminal_intents | No | Aggregate terminal Harbor intents across operators in the portfolio. | |
| checkpoint_last_ledger_seq | No | Last ledger sequence included in the tenant Signal checkpoint. | |
| total_receipted_volume_cents | No | Aggregate receipted settlement volume in cents across the portfolio. |