---
title: "Partner portal payload"
method: GET
path: "/api/v1/partner/portal"
---

# Partner portal payload

`GET /api/v1/partner/portal`

## Request

- Base URL: `https://streetproof.com`
- URL: `https://streetproof.com/api/v1/partner/portal`
- Auth: HTTP bearer

API-key-authenticated partner portal: usage, quota view, recent request logs, active key prefixes, webhook endpoints, OpenAPI/MCP setup links, sample code, support notes, and attribution text.

## Response `200`

Partner portal payload scoped to the authenticated API client.

- PartnerPortalResponse
  - `schema` 'com.streetproof.partner_portal.v1'
  - `client` object
  - `quota` object
    - `daily` integer
    - `monthly` integer
    - `used_today` integer
    - `used_this_month` integer
    - `daily_remaining` integer
    - `monthly_remaining` integer
  - `usage` object
    - `requests_7d` integer
    - `errors_24h` integer
    - `p95_latency_ms_24h` integer, nullable
    - `endpoint_mix_30d` object[]
    - `recent_requests` object[]
  - `api_keys` object[]
  - `webhooks` object
  - `integrations` object
  - `attribution` object
  - `methodology_url` string, uri
  - `data_as_of` string, date-time: Server-authoritative timestamp.
  - `metric_snapshot` MetricSnapshot
    - `snapshot_id` string, uuid, nullable, required
    - `scope` 'live_ledger', required
    - `data_as_of` string, date-time, required
    - `calculated_at` string, date-time, required
    - `snapshot_type` 'live_ledger', required
    - `metric_scope` 'multi_scope_snapshot', required: This receipt contains metrics from multiple explicitly named scopes; inspect scopes and scope_definitions before using a field.
    - `includes_synthetic` true, required: At least one field in this multi-scope receipt can include labeled synthetic demonstration data. Production-only fields remain identified by their scope.
    - `methodology_version` 'public-metrics-v3', required
    - `scopes` string[], required
    - `scope_definitions` object, required
      - `production_non_synthetic` 'Accepted public physical citations and related counts with synthetic records excluded.', required
      - `public_including_synthetic` 'All public observations, including clearly labeled synthetic demonstration records.', required
      - `ledger_all_rows` 'All ledger rows, including provisional, redacted, rejected, and non-public records.', required
  - `coverage_snapshot` CoverageSnapshot
    - `snapshot_id` string, uuid, nullable, required
    - `scope` 'coverage_snapshot', required
    - `data_as_of` string, date-time, nullable, required
    - `calculated_at` string, date-time, nullable, required
    - `snapshot_type` 'coverage_snapshot', required
    - `metric_scope` 'production_non_synthetic', required
    - `includes_synthetic` false, required
    - `methodology_version` string, nullable, required
    - `evaluated_city_count` integer, required
    - `city_catalog_count` integer, required
    - `cities_with_evidence` integer, required
    - `coverage_tiers` object, required
      - `seed` integer, required
      - `building` integer, required
      - `dense` integer, required
      - `pending_calculation` integer, required
  - `evidence_claim_boundary` EvidenceClaimBoundary
    - `schema` 'com.streetproof.evidence_claim_boundary.v1', required
    - `contract_version` string, required
    - `positive_result` object, required
      - `summary` string, required
      - `presence_kinds` object, required
        - `location_presence` string, required
        - `mobile_presence` string, required
        - `brand_mention` string, required
    - `no_result` object, required
      - `meaning` string, required
      - `limitation` string, required
    - `what_this_proves` string[], required
    - `what_this_does_not_prove` string[], required
  - `coverage_confidence` CoverageConfidence: Versioned per-city dataset maturity. Coverage never changes the evidence standard for an individual citation. A missing record never proves a business is not operating.
    - `level` 'none' | 'low' | 'medium' | 'high'
    - `tier` 'unlaunched' | 'seed' | 'building' | 'dense' | 'null', nullable
    - `freshness` 'current' | 'aging' | 'stale' | 'null', nullable: Null when the city is unlaunched because freshness does not apply.
    - `observed_cells` integer
    - `methodology_version` string
    - `calculated_at` string, date-time, nullable
    - `limitations` string
    - `note` string
  - `coverage_context` CoverageContext: Versioned city dataset maturity and freshness. It does not change individual-citation evidence requirements, and a missing record never proves absence.
    - `tier` 'unlaunched' | 'seed' | 'building' | 'dense' | 'null', nullable
    - `label` string
    - `freshness` 'current' | 'aging' | 'stale' | 'null', nullable: Null when the city is unlaunched because freshness does not apply.
    - `confidence` 'none' | 'low' | 'medium' | 'high'
    - `tier_since` string, date, nullable
    - `calculated_at` string, date-time, nullable
    - `methodology_version` string
    - `limitations` string
    - `metrics` object

## Other responses

- `401`: Missing, invalid, or inactive API key.
- `403`: Client is disabled or portal access is not enabled.

---

[API](https://skmtc.dev/streetproof/apis/streetproof-physical-brand-index-api.md) · [All operations](https://skmtc.dev/streetproof/apis/streetproof-physical-brand-index-api/llms.txt) · [OpenAPI document](https://skmtc.dev/streetproof/apis/streetproof-physical-brand-index-api/revisions/81072718cfa2?raw)