{ "openapi": "3.1.0", "info": { "title": "Tomedia", "version": "0.0.1", "description": "# Tomedia API\n\nThis API reference is generated from Laravel route definitions and request metadata.\nIt covers endpoints under `/api`, including module routes (Seer, Political Machine, Discover, TOAST, and related services).\n\n## Documentation layers\n\n- Human-readable guides: `/documentation`\n- API Documentation: `/docs/api`\n- OpenAPI JSON schema: `/docs/api.json`\n\nThe documentation preview is public so teams can review endpoint coverage before they provision access.\nActual API calls still require the appropriate Bearer token and plan entitlements.\n\n## Authentication\n\n- All Seer public API endpoints under `/api/seer/v1/*` require a Sanctum Bearer token.\n- TOAST integration endpoints under `/api/toast/v1/*` also require a Sanctum Bearer token.\n- Header format: `Authorization: Bearer YOUR_API_KEY`\n- API scopes currently include:\n - `seer.read`\n - `seer.write`\n - `toast.read`\n - `toast.write`\n- Optional TOAST resource scoping abilities:\n - `toast.website:{website_id}`\n - `toast.business:{business_id}`\n\n## Pagination\n\n- Seer list endpoints support `page` and `per_page` query params.\n- `limit` is still accepted as a backward-compatible alias for `per_page`.\n- Responses include a `pagination` object with `page`, `per_page`, `count`, `total`, `last_page`, and `has_more`.\n- Very large list endpoints are bounded by endpoint-specific scan windows for safety; out-of-range pages return `422`.\n\n## Rate limiting\n\n- Seer API read endpoints are rate-limited per token/user/IP.\n- Seer API write endpoints are rate-limited per token/user/IP.\n- Default limits:\n - Read: `120` requests/minute\n - Write: `60` requests/minute\n\n## Integration notes\n\n- Use explicit filters (`year`, `event_scope`, and similar query controls) for deterministic payloads.\n- Treat future-dated records as invalid unless your integration explicitly supports forecast data.\n- Public webhook endpoints may allow unauthenticated POST requests by design.\n" }, "servers": [ { "url": "https://tomedia.com.au/api", "description": "Current" } ], "paths": { "/seer/v1/analyst/ask": { "post": { "operationId": "seer.v1.analyst.ask", "tags": [ "SeerAnalyst" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "business_id": { "type": "integer" }, "question": { "type": "string", "minLength": 3, "maxLength": 800 }, "intent": { "type": [ "string", "null" ] }, "filters": { "type": "object", "properties": { "state": { "type": [ "string", "null" ], "maxLength": 20 }, "postcode": { "type": [ "string", "null" ], "maxLength": 12 }, "sector": { "type": [ "string", "null" ], "maxLength": 120 }, "limit": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 24 }, "per_page": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 24 } } } }, "required": [ "business_id", "question" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "question": { "type": "string" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "market_summary", "area_growth", "competitor_narrative", "risk_explanation", "acquisition_targets" ] } ] }, "answer": { "type": "string" }, "briefing": { "type": "object", "properties": { "headline": { "type": "string" }, "what_changed": { "type": "array", "items": [] }, "why_it_matters": { "type": "array", "items": [] }, "watch_next": { "type": "array", "items": [] } }, "required": [ "headline", "what_changed", "why_it_matters", "watch_next" ] }, "recommendations": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Treat this as a partial read" ] }, "reason": { "type": "string", "enum": [ "Some supporting evidence is unavailable, so the answer should not be used as the only basis for action." ] }, "priority": { "type": "string", "enum": [ "medium" ] } }, "required": [ "label", "reason", "priority" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "evidence": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "ranked_entities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "timeline_events": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "citations": { "type": "array", "items": { "type": "string" } }, "data_status": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "insufficient_evidence", "partial", "available" ] }, "freshness": { "type": "string" }, "missing": { "type": "string" } }, "required": [ "state", "freshness", "missing" ] }, "filters_used": { "type": "array", "items": [] }, "follow_up_questions": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Which ranked targets have the strongest evidence?" ] }, { "type": "string", "enum": [ "What risks would block outreach?" ] }, { "type": "string", "enum": [ "Which source changed most recently?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "What changed first?" ] }, { "type": "string", "enum": [ "Which signals are highest severity?" ] }, { "type": "string", "enum": [ "What should be watched next week?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Which competitor is gaining ground?" ] }, { "type": "string", "enum": [ "Where is the competitor set weakest?" ] }, { "type": "string", "enum": [ "What changed since the last briefing?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Which nearby postcode should I compare?" ] }, { "type": "string", "enum": [ "What growth signal is strongest?" ] }, { "type": "string", "enum": [ "Which area has the clearest caveats?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "What changed this week?" ] }, { "type": "string", "enum": [ "What should I care about first?" ] }, { "type": "string", "enum": [ "Which risks are most material?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } ] }, "evidence_pack": { "type": "object", "properties": { "question": { "type": "string" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "market_summary", "area_growth", "competitor_narrative", "risk_explanation", "acquisition_targets" ] } ] }, "workspace_business_id": { "type": "integer" }, "normalized_filters": { "type": "array", "items": [] }, "evidence_cards": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "ranked_entities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "timeline_events": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_status": { "type": "array", "items": { "type": "string" } }, "citations": { "type": "array", "items": { "type": "string" } }, "missing_data": { "type": "object", "properties": { "blocks_answer": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "blocks_answer", "items" ] }, "confidence": { "type": "string", "enum": [ "blocked", "medium", "high", "low" ] }, "recommended_actions": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Treat this as a partial read" ] }, "reason": { "type": "string", "enum": [ "Some supporting evidence is unavailable, so the answer should not be used as the only basis for action." ] }, "priority": { "type": "string", "enum": [ "medium" ] } }, "required": [ "label", "reason", "priority" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "follow_up_questions": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Which ranked targets have the strongest evidence?" ] }, { "type": "string", "enum": [ "What risks would block outreach?" ] }, { "type": "string", "enum": [ "Which source changed most recently?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "What changed first?" ] }, { "type": "string", "enum": [ "Which signals are highest severity?" ] }, { "type": "string", "enum": [ "What should be watched next week?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Which competitor is gaining ground?" ] }, { "type": "string", "enum": [ "Where is the competitor set weakest?" ] }, { "type": "string", "enum": [ "What changed since the last briefing?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Which nearby postcode should I compare?" ] }, { "type": "string", "enum": [ "What growth signal is strongest?" ] }, { "type": "string", "enum": [ "Which area has the clearest caveats?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "What changed this week?" ] }, { "type": "string", "enum": [ "What should I care about first?" ] }, { "type": "string", "enum": [ "Which risks are most material?" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } ] } }, "required": [ "question", "intent", "workspace_business_id", "normalized_filters", "evidence_cards", "ranked_entities", "timeline_events", "source_status", "citations", "missing_data", "confidence", "recommended_actions", "follow_up_questions" ] } }, "required": [ "question", "intent", "answer", "briefing", "recommendations", "evidence", "ranked_entities", "timeline_events", "citations", "data_status", "filters_used", "follow_up_questions", "evidence_pack" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/catalog": { "get": { "operationId": "seer.v1.catalog", "tags": [ "SeerApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Tomedia Seer API" ] }, "version": { "type": "string", "enum": [ "v1" ] }, "generated_at": { "type": "string" }, "auth": { "type": "object", "properties": { "scheme": { "type": "string", "enum": [ "Bearer token (Sanctum personal access token)" ] }, "settings_path": { "type": "string", "enum": [ "/settings/api-access" ] }, "required_scopes": { "type": "object", "properties": { "read_endpoints": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "seer.read" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "write_endpoints": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "seer.write" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "read_endpoints", "write_endpoints" ] } }, "required": [ "scheme", "settings_path", "required_scopes" ] }, "request_contract": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "parameters": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "page" ] }, { "type": "string", "enum": [ "per_page" ] }, { "type": "string", "enum": [ "limit (legacy alias for per_page)" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, "response_key": { "type": "string", "enum": [ "pagination" ] }, "scan_windows": { "type": "string" } }, "required": [ "parameters", "response_key", "scan_windows" ] }, "rate_limits": { "type": "object", "properties": { "read_per_minute": { "type": "integer" }, "write_per_minute": { "type": "integer" } }, "required": [ "read_per_minute", "write_per_minute" ] } }, "required": [ "pagination", "rate_limits" ] }, "viewer": { "type": "object", "properties": { "plan": { "type": [ "string", "null" ] }, "can_apex": { "type": "boolean" }, "can_seer": { "type": "boolean" } }, "required": [ "plan", "can_apex", "can_seer" ] }, "tiers": { "type": "object", "properties": { "apex": { "type": "object", "properties": { "description": { "type": "string", "enum": [ "Industry intelligence cards and operational business data." ] }, "endpoints": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "GET /api/seer/v1/sources" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/search" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/intel" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/flags" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/donations" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/abn/{abn}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/demographics/postcodes/{postcode}" ] }, { "type": "string", "enum": [ "GET|POST /api/seer/v1/demographics/search" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/living-standards/postcodes/{postcode}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/living-standards/states/{state}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/living-standards/geographies/{geoLevel}/{geoCode}" ] } ], "minItems": 11, "maxItems": 11, "additionalItems": false } }, "required": [ "description", "endpoints" ] }, "seer": { "type": "object", "properties": { "description": { "type": "string", "enum": [ "Full entity graph, ownership and deep business connection data." ] }, "endpoints": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/connections" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/graph" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/graph/business/{business}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/graph/business/{business}/shared-infrastructure" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/graph/business/{business}/political-exposure" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/graph/directors/{person}/businesses" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/web-intelligence" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/authority/business/{business}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/authority/{domain}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/people-graph" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/businesses/{business}/key-people" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/people" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/people/{person}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/people/{person}/appointments" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/people/{person}/network" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/market/business/{business}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/market/postcodes/{postcode}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/market/sectors/health" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/market/sectors/correlations" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/market/listed-companies" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/market/briefs/{geo}" ] }, { "type": "string", "enum": [ "POST /api/seer/v1/analyst/ask" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/data-gov/opportunities" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/data-gov/business-signals" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/trust/business/{business}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/trust/explain" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/trust/sources/status" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/rba/status" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/rba/tables" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/rba/tables/{table_code}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/rba/series" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/rba/series/{series_id}/observations" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/personas" ] }, { "type": "string", "enum": [ "POST /api/seer/v1/personas" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/personas/{persona}" ] }, { "type": "string", "enum": [ "PUT /api/seer/v1/personas/{persona}" ] }, { "type": "string", "enum": [ "POST /api/seer/v1/personas/{persona}/compute" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/personas/{persona}/scores" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/personas/{persona}/map" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/political-machine/summary" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/political-machine/dashboard" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/political-machine/parties/{partyKey}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/political-machine/departments/{departmentKey}" ] }, { "type": "string", "enum": [ "GET /api/seer/v1/political-machine/donors/{donorKey}" ] } ], "minItems": 44, "maxItems": 44, "additionalItems": false }, "enabled_for_viewer": { "type": "boolean" } }, "required": [ "description", "endpoints", "enabled_for_viewer" ] } }, "required": [ "apex", "seer" ] }, "dataset_versions": { "type": "string" } }, "required": [ "name", "version", "generated_at", "auth", "request_contract", "viewer", "tiers", "dataset_versions" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/sources": { "get": { "operationId": "seer.v1.sources", "tags": [ "SeerApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "sources": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "dataset_badges": { "type": "string" }, "status": { "type": "string", "enum": [ "available" ] }, "last_run_at": { "type": [ "string", "null" ] }, "last_success_at": { "type": [ "string", "null" ] }, "rows_read": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "rows_upserted": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "rows_failed": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] } }, "required": [ "key", "name", "dataset_badges", "status", "last_run_at", "last_success_at", "rows_read", "rows_upserted", "rows_failed" ] }, { "type": "string" } ] } } }, "required": [ "generated_at", "sources" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/search": { "get": { "operationId": "seer.v1.businesses.search", "tags": [ "SeerApi" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 160 } }, { "name": "abn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "acn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "state", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 20 } }, { "name": "suburb", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "postcode", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 10 } }, { "name": "status", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 20 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "count", "results", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/intel": { "get": { "operationId": "seer.v1.businesses.intel", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "business": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "plan": { "type": "string" }, "abn": { "type": [ "string", "null" ] }, "acn": { "type": [ "string", "null" ] }, "legal_name": { "type": [ "string", "null" ] }, "entity_type": { "type": [ "string", "null" ] }, "location": { "type": "object", "properties": { "suburb": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] } }, "required": [ "suburb", "state", "postcode" ] }, "flags": { "type": "object", "properties": { "banned_org": { "type": "boolean" }, "charity": { "type": "boolean" }, "enforcement": { "type": "boolean" }, "has_donations_data": { "type": "boolean" }, "last_reconciled_at": { "type": "string" } }, "required": [ "banned_org", "charity", "enforcement", "has_donations_data", "last_reconciled_at" ] } }, "required": [ "id", "name", "slug", "status", "plan", "abn", "acn", "legal_name", "entity_type", "location", "flags" ] }, "flags": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "banned_org": { "type": "boolean" }, "charity": { "type": "boolean" }, "enforcement": { "type": "boolean" }, "has_donations_data": { "type": "boolean" }, "last_reconciled_at": { "type": "string" }, "records_count": { "type": "integer", "minimum": 0 }, "records_by_type": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "banned_org", "charity", "enforcement", "has_donations_data", "last_reconciled_at", "records_count", "records_by_type" ] }, "records": { "type": "array", "items": { "type": "string" } } }, "required": [ "summary", "records" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "banned_org": { "type": "boolean" }, "charity": { "type": "boolean" }, "enforcement": { "type": "boolean" }, "has_donations_data": { "type": "boolean" }, "last_reconciled_at": { "type": "string" } }, "required": [ "banned_org", "charity", "enforcement", "has_donations_data", "last_reconciled_at" ] }, "records": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "summary", "records" ] } ] }, "personas": { "anyOf": [ { "type": "object", "properties": { "active_count": { "type": "string" }, "primary_persona": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "is_active": { "type": "boolean" }, "last_computed_at": { "type": "string" } }, "required": [ "id", "name", "status", "is_active", "last_computed_at" ] }, "top_postcodes": { "type": "array", "items": { "type": "string" } } }, "required": [ "active_count", "primary_persona", "top_postcodes" ] }, { "type": "object", "properties": { "active_count": { "type": "string" }, "primary_persona": { "type": "null" }, "top_postcodes": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "active_count", "primary_persona", "top_postcodes" ] }, { "type": "object", "properties": { "active_count": { "type": "integer", "enum": [ 0 ] }, "primary_persona": { "type": "null" }, "top_postcodes": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "active_count", "primary_persona", "top_postcodes" ] }, { "type": "null" } ] }, "apex_snapshot": { "type": "object", "properties": { "asic_company": { "type": [ "object", "null" ], "properties": { "company_name": { "type": [ "string", "null" ] }, "current_name": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "class": { "type": [ "string", "null" ] }, "sub_class": { "type": [ "string", "null" ] }, "state_of_registration": { "type": [ "string", "null" ] }, "date_registered": { "type": [ "string", "null" ] }, "date_deregistered": { "type": [ "string", "null" ] }, "acn": { "type": [ "string", "null" ] }, "abn": { "type": [ "string", "null" ] } }, "required": [ "company_name", "current_name", "status", "type", "class", "sub_class", "state_of_registration", "date_registered", "date_deregistered", "acn", "abn" ] }, "charity": { "type": "object", "properties": { "is_registered": { "type": "boolean" }, "main": { "type": [ "object", "null" ], "properties": { "charity_legal_name": { "type": [ "string", "null" ] }, "charity_size": { "type": [ "string", "null" ] }, "reporting_year": { "type": [ "integer", "null" ] }, "registration_date": { "type": [ "string", "null" ] }, "financial_year_end": { "type": [ "string", "null" ] } }, "required": [ "charity_legal_name", "charity_size", "reporting_year", "registration_date", "financial_year_end" ] }, "ais_latest": { "type": [ "object", "null" ], "properties": { "reporting_year": { "type": [ "integer", "null" ] }, "total_revenue": { "type": [ "number", "null" ] }, "total_expenses": { "type": [ "number", "null" ] }, "net_surplus_deficit": { "type": [ "number", "null" ] } }, "required": [ "reporting_year", "total_revenue", "total_expenses", "net_surplus_deficit" ] } }, "required": [ "is_registered", "main", "ais_latest" ] }, "donations": { "type": "string" }, "demographics": { "type": "object", "properties": { "postcode": { "type": [ "string", "null" ] }, "profile_counts": { "type": "string" }, "sample_metrics": { "type": "string" } }, "required": [ "postcode", "profile_counts", "sample_metrics" ] }, "abs": { "type": "object", "description": "Backward compatible alias.", "properties": { "postcode": { "type": [ "string", "null" ] }, "profile_counts": { "type": "string" }, "sample_metrics": { "type": "string" } }, "required": [ "postcode", "profile_counts", "sample_metrics" ] } }, "required": [ "asic_company", "charity", "donations", "demographics", "abs" ] }, "seer_connections": { "type": [ "object", "null" ], "properties": { "linked": { "type": "string" }, "primary_entity": { "type": "string" }, "relationship_count": { "type": "integer", "minimum": 0 }, "relationships": { "type": "array", "items": { "type": "string" } }, "relationship_breakdown": { "type": "object", "additionalProperties": { "type": "integer", "minimum": 0 } }, "sources": { "type": "object", "properties": { "wikidata": { "type": "boolean" }, "web_intelligence": { "type": "boolean" } }, "required": [ "wikidata", "web_intelligence" ] } }, "required": [ "linked", "primary_entity", "relationship_count", "relationships", "relationship_breakdown", "sources" ] }, "web_intelligence": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "business": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": [ "object", "null" ] } ] }, "name": { "type": [ "string", "null" ] }, "abn": { "type": [ "string", "null" ] }, "acn": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "contact_email": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "suburb": { "type": [ "string", "null" ] }, "categories": { "type": "array", "items": [] } }, "required": [ "id", "name", "abn", "acn", "website", "contact_email", "postcode", "state", "suburb", "categories" ] }, "linked": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": [ "string", "null" ] }, "trust_label": [], "risk_label": [], "digital_label": [], "freshness_label": [], "alert_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "watchlist_count": { "type": "integer" } }, "required": [ "primary_domain", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count", "watchlist_count" ] }, "primary_domain": { "type": [ "string", "null" ] }, "safe_web_authority": { "type": "array", "items": { "anyOf": [ [], { "type": [ "string", "null" ] } ] } }, "size_estimation": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "estimated_size_score": { "type": "null" }, "estimated_employees_low": { "type": "null" }, "estimated_employees_high": { "type": "null" }, "estimated_revenue_floor": { "type": "null" }, "digital_maturity_score": { "type": "null" }, "commercial_confidence_score": { "type": "null" }, "digital_label": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "estimated_size_score", "estimated_employees_low", "estimated_employees_high", "estimated_revenue_floor", "digital_maturity_score", "commercial_confidence_score", "digital_label" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "classification": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "trust_label": { "type": "string", "enum": [ "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Unknown" ] }, "digital_label": { "type": "string", "enum": [ "Unknown" ] }, "freshness_label": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "trust_label", "risk_label", "digital_label", "freshness_label" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "freshness": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Unknown" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "No primary domain resolved yet." ] } }, "required": [ "label", "is_stale", "stale_reason" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence_score": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "number", "enum": [ 0 ] } ] }, "explain": { "type": [ "string", "null" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer" }, "relationship_breakdown": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "primary_domains": { "type": "array", "items": [] } }, "required": [ "relationship_count", "relationship_breakdown", "primary_domains" ] }, "domains": { "type": "array", "items": [] }, "owned_domains": { "type": "array", "items": [] }, "connected_domains": { "type": "array", "items": [] }, "network": { "type": "object", "properties": { "connections": { "type": "array", "items": [] }, "website_domain": { "type": [ "string", "null" ] }, "email_domain": { "type": [ "string", "null" ] }, "summary": { "type": "object", "properties": { "outbound_link_count": { "type": "integer" }, "inbound_link_count": { "type": "integer" }, "shared_signal_count": { "type": "integer" }, "peer_link_count": { "type": "integer" }, "internal_link_count": { "type": "integer" } }, "required": [ "outbound_link_count", "inbound_link_count", "shared_signal_count", "peer_link_count", "internal_link_count" ] } }, "required": [ "connections", "website_domain", "email_domain", "summary" ] }, "connected_businesses": { "type": "array", "items": [] }, "brand_integrity": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "label": { "type": "string", "enum": [ "Fragmented" ] }, "domain_count": { "type": "integer" }, "linked_abn_count": { "type": "integer" } }, "required": [ "score", "label", "domain_count", "linked_abn_count" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "mismatch_detection": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "label": { "type": "string", "enum": [ "Mismatch risk", "Review", "Aligned" ] }, "flags": { "type": "array", "items": [] } }, "required": [ "score", "label", "flags" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "suspicious_clusters": { "anyOf": [ { "type": "object", "properties": { "score": { "type": [ "object", "null" ] }, "label": { "type": "string", "enum": [ "Cluster risk", "Watch", "Clear" ] }, "connected_high_risk_domains": { "type": "array", "items": [] }, "alerts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "suspicious_cluster" ] }, "label": { "type": "string", "enum": [ "Multiple connected high-risk domains are sitting in the same web neighborhood." ] } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "watch_connected_risk" ] }, "label": { "type": "string", "enum": [ "A connected domain is carrying high-risk trust signals." ] } }, "required": [ "severity", "type", "label" ] } ] } } }, "required": [ "score", "label", "connected_high_risk_domains", "alerts" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "abandonment_indicators": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "signals": { "type": "array", "items": [] } }, "required": [ "count", "signals" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "acquisition_indicators": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "signals": { "type": "array", "items": [] } }, "required": [ "count", "signals" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "trend": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "No trend yet" ] }, "score_delta_30d": { "type": "number", "enum": [ 0 ] }, "score_delta_90d": { "type": "number", "enum": [ 0 ] } }, "required": [ "label", "score_delta_30d", "score_delta_90d" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "benchmarks": { "anyOf": [ { "type": "object", "properties": { "postcode": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "postcode" ] }, "scope_label": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "business_count": { "type": "integer" }, "average_safe_web_authority_score": { "type": "number" }, "average_risk_score": { "type": "number" }, "average_digital_maturity_score": { "type": "number" } }, "required": [ "scope_type", "scope_label", "available", "business_count", "average_safe_web_authority_score", "average_risk_score", "average_digital_maturity_score" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "business_id": { "type": "integer" }, "business_name": { "type": "string" }, "slug": { "type": "string" }, "abn": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "safe_web_authority_score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_visibility_score": { "type": "number" }, "primary_domain": { "type": [ "string", "null" ] } }, "required": [ "business_id", "business_name", "slug", "abn", "safe_web_authority_score", "authority_score", "risk_score", "digital_maturity_score", "commercial_confidence_score", "digital_visibility_score", "primary_domain" ] } }, "top_trusted": { "type": "array", "items": [] }, "top_risk": { "type": "array", "items": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "Peer trust benchmarks are calculated from ClickHouse business identities joined to the latest Safe Web Authority metrics by ABN." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Peer benchmark" ] }, "summary": { "type": "string", "enum": [ "This benchmark compares the business to a local or industry peer set." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string" }, "formula": { "type": "string", "enum": [ "peer_average = average(latest peer Safe Web Authority scores)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "scope_label" ] }, "value": { "type": [ "string", "null" ] }, "source_field": { "type": "string", "enum": [ "seer_discover_businesses_fact + discover category facts" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "business_count" ] }, "value": { "type": "integer" }, "source_field": { "type": "string", "enum": [ "ClickHouse peer cohort size" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_safe_web_authority_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_risk_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Discover businesses fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "main_address_postcode" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "postcode" ] }, "scope_label": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "scope_type", "scope_label", "available", "business_count" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_trusted": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_risk": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "No peer rows resolved from ClickHouse for this benchmark scope yet." ] }, "sections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] } ] }, "industry": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "industry" ] }, "scope_label": { "type": "string" }, "available": { "type": "boolean" }, "business_count": { "type": "integer" }, "average_safe_web_authority_score": { "type": "number" }, "average_risk_score": { "type": "number" }, "average_digital_maturity_score": { "type": "number" } }, "required": [ "scope_type", "scope_label", "available", "business_count", "average_safe_web_authority_score", "average_risk_score", "average_digital_maturity_score" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "business_id": { "type": "integer" }, "business_name": { "type": "string" }, "slug": { "type": "string" }, "abn": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "safe_web_authority_score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_visibility_score": { "type": "number" }, "primary_domain": { "type": [ "string", "null" ] } }, "required": [ "business_id", "business_name", "slug", "abn", "safe_web_authority_score", "authority_score", "risk_score", "digital_maturity_score", "commercial_confidence_score", "digital_visibility_score", "primary_domain" ] } }, "top_trusted": { "type": "array", "items": [] }, "top_risk": { "type": "array", "items": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "Peer trust benchmarks are calculated from ClickHouse business identities joined to the latest Safe Web Authority metrics by ABN." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Peer benchmark" ] }, "summary": { "type": "string", "enum": [ "This benchmark compares the business to a local or industry peer set." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string" }, "formula": { "type": "string", "enum": [ "peer_average = average(latest peer Safe Web Authority scores)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "scope_label" ] }, "value": { "type": "string" }, "source_field": { "type": "string", "enum": [ "seer_discover_businesses_fact + discover category facts" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "business_count" ] }, "value": { "type": "integer" }, "source_field": { "type": "string", "enum": [ "ClickHouse peer cohort size" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_safe_web_authority_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_risk_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Discover businesses fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "main_address_postcode" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "industry" ] }, "scope_label": { "type": "string" }, "available": { "type": "boolean" }, "business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "scope_type", "scope_label", "available", "business_count" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_trusted": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_risk": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "No peer rows resolved from ClickHouse for this benchmark scope yet." ] }, "sections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] } ] } }, "required": [ "postcode", "industry" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "monitoring": { "type": "object", "properties": { "watchlist": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "alert_count": { "type": "integer" }, "entries": { "type": "array", "items": [] } }, "required": [ "count", "alert_count", "entries" ] }, { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "entries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "entries" ] } ] }, "alerts": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "recrawl_recommended": { "type": "boolean" } }, "required": [ "watchlist", "alerts", "recrawl_recommended" ] }, "alerts": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "enum": [ "Safe Web Authority calculations" ] }, "summary": { "type": "string", "enum": [ "Every figure below is derived from ClickHouse-backed Seer web, business, and trust signals." ] }, "sections": { "type": "array", "items": [] } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "enabled", "business", "linked", "summary", "primary_domain", "safe_web_authority", "size_estimation", "classification", "freshness", "confidence_score", "explain", "internet_map", "domains", "owned_domains", "connected_domains", "network", "connected_businesses", "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "trend", "benchmarks", "monitoring", "alerts", "debug" ] }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "business": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id" ] }, "linked": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": "null" }, "trust_label": { "type": "string", "enum": [ "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Unknown" ] }, "digital_label": { "type": "string", "enum": [ "Unknown" ] }, "freshness_label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "alert_count": { "type": "integer", "enum": [ 0 ] }, "watchlist_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "primary_domain", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count", "watchlist_count" ] }, "primary_domain": { "type": "null" }, "safe_web_authority": { "type": "null" }, "size_estimation": { "type": "null" }, "classification": { "type": "null" }, "freshness": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "business_identity_not_synced_to_clickhouse" ] }, "recommended_recrawl": { "type": "boolean" } }, "required": [ "label", "is_stale", "stale_reason", "recommended_recrawl" ] }, "confidence_score": { "type": "integer", "enum": [ 0 ] }, "explain": { "type": "object", "properties": { "summary": { "type": "string", "enum": [ "No ClickHouse-backed business identity has been synced for this business yet." ] }, "strengths": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "risks": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "missing_signals": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Business identity not synced into Seer ClickHouse facts." ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "top_drivers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "summary", "strengths", "risks", "missing_signals", "top_drivers" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer", "enum": [ 0 ] }, "relationship_breakdown": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "primary_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "relationship_count", "relationship_breakdown", "primary_domains" ] }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "owned_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "connected_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "network": { "type": "object", "properties": { "connections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "website_domain": { "type": "null" }, "email_domain": { "type": "null" } }, "required": [ "connections", "website_domain", "email_domain" ] }, "connected_businesses": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "brand_integrity": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "domain_count": { "type": "integer", "enum": [ 0 ] }, "linked_abn_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "score", "label", "domain_count", "linked_abn_count" ] }, "mismatch_detection": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "flags": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "score", "label", "flags" ] }, "suspicious_clusters": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "connected_high_risk_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "score", "label", "connected_high_risk_domains", "alerts" ] }, "abandonment_indicators": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "signals" ] }, "acquisition_indicators": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "signals" ] }, "benchmarks": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "monitoring": { "type": "object", "properties": { "watchlist": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "entries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "entries" ] }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "recrawl_recommended": { "type": "boolean" } }, "required": [ "watchlist", "alerts", "recrawl_recommended" ] }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": "null" } }, "required": [ "enabled", "business", "linked", "summary", "primary_domain", "safe_web_authority", "size_estimation", "classification", "freshness", "confidence_score", "explain", "internet_map", "domains", "owned_domains", "connected_domains", "network", "connected_businesses", "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "benchmarks", "monitoring", "alerts", "debug" ] }, { "type": "null" } ] }, "people_graph": { "type": [ "object", "null" ], "properties": { "linked": { "type": "boolean" }, "count": { "type": "integer" }, "nodes": { "type": "array", "items": [] }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string" }, "target": { "type": "string" }, "property_label": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "source_dataset": { "type": [ "string", "null" ] } }, "required": [ "id", "source", "target", "property_label", "direction", "source_dataset" ] } } }, "required": [ "linked", "count", "nodes", "edges" ] }, "access": { "type": "object", "properties": { "can_apex": { "type": "boolean" }, "can_seer": { "type": "boolean" } }, "required": [ "can_apex", "can_seer" ] } }, "required": [ "business", "flags", "personas", "apex_snapshot", "seer_connections", "web_intelligence", "people_graph", "access" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/flags": { "get": { "operationId": "seer.v1.businesses.flags", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "banned_org": { "type": "boolean" }, "charity": { "type": "boolean" }, "enforcement": { "type": "boolean" }, "has_donations_data": { "type": "boolean" }, "last_reconciled_at": { "type": "string" }, "records_count": { "type": "integer", "minimum": 0 }, "records_by_type": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "banned_org", "charity", "enforcement", "has_donations_data", "last_reconciled_at", "records_count", "records_by_type" ] }, "records": { "type": "array", "items": { "type": "string" } } }, "required": [ "summary", "records" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "banned_org": { "type": "boolean" }, "charity": { "type": "boolean" }, "enforcement": { "type": "boolean" }, "has_donations_data": { "type": "boolean" }, "last_reconciled_at": { "type": "string" } }, "required": [ "banned_org", "charity", "enforcement", "has_donations_data", "last_reconciled_at" ] }, "records": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "summary", "records" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/donations": { "get": { "operationId": "seer.v1.businesses.donations", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "years", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 25 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "count": { "type": "integer" }, "records": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "summary", "count", "records", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/abn/{abn}": { "get": { "operationId": "seer.v1.abn.record", "tags": [ "SeerApi" ], "parameters": [ { "name": "abn", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "abn": { "type": "string" }, "record": { "type": [ "object", "null" ], "additionalProperties": [] } }, "required": [ "abn", "record" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, "record": { "type": "null" } }, "required": [ "abn", "record" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/demographics/postcodes/{postcode}": { "get": { "operationId": "seer.v1.demographics.postcode", "tags": [ "SeerApi" ], "parameters": [ { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": { "anyOf": [ [], { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, "profile": [], "count": { "type": "integer" }, "rows": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "postcode", "profile", "count", "rows", "pagination" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/demographics/search": { "get": { "operationId": "seer.v1.demographics.search", "tags": [ "SeerApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "rows": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "count", "rows", "pagination" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/living-standards/postcodes/{postcode}": { "get": { "operationId": "seer.v1.living_standards.postcode", "tags": [ "SeerApi" ], "parameters": [ { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1900, "maximum": 2200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "geo": { "type": "object", "properties": { "geo_level": { "type": "string" }, "geo_code": { "type": "string" }, "geo_name": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "population": { "type": [ "number", "null" ] } }, "required": [ "geo_level", "geo_code", "geo_name", "state", "postcode", "population" ] }, "year": { "type": "integer" }, "index_version": { "type": "string", "enum": [ "v1" ] }, "score": { "type": "null" }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "coverage": { "type": "object", "properties": { "status": { "type": "string" }, "domains_available": { "type": "integer" }, "domains_total": { "type": "integer" }, "minimum_coverage_met": { "type": "boolean" }, "required_anchor_met": { "type": "boolean" }, "missing_domains": { "type": "array", "items": [] }, "row_count": { "type": "integer" } }, "required": [ "status", "domains_available", "domains_total", "minimum_coverage_met", "required_anchor_met", "missing_domains", "row_count" ] }, "rank": { "type": "null" }, "percentile": { "type": "null" }, "comparisons": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "array", "items": [] } }, "required": [ "geo", "year", "index_version", "score", "domains", "coverage", "rank", "percentile", "comparisons", "diagnostics" ] }, { "type": "object", "additionalProperties": [] }, { "type": "array", "items": [] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/living-standards/states/{state}": { "get": { "operationId": "seer.v1.living_standards.state", "tags": [ "SeerApi" ], "parameters": [ { "name": "state", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1900, "maximum": 2200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "geo": { "type": "object", "properties": { "geo_level": { "type": "string" }, "geo_code": { "type": "string" }, "geo_name": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "population": { "type": [ "number", "null" ] } }, "required": [ "geo_level", "geo_code", "geo_name", "state", "postcode", "population" ] }, "year": { "type": "integer" }, "index_version": { "type": "string", "enum": [ "v1" ] }, "score": { "type": "null" }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "coverage": { "type": "object", "properties": { "status": { "type": "string" }, "domains_available": { "type": "integer" }, "domains_total": { "type": "integer" }, "minimum_coverage_met": { "type": "boolean" }, "required_anchor_met": { "type": "boolean" }, "missing_domains": { "type": "array", "items": [] }, "row_count": { "type": "integer" } }, "required": [ "status", "domains_available", "domains_total", "minimum_coverage_met", "required_anchor_met", "missing_domains", "row_count" ] }, "rank": { "type": "null" }, "percentile": { "type": "null" }, "comparisons": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "array", "items": [] } }, "required": [ "geo", "year", "index_version", "score", "domains", "coverage", "rank", "percentile", "comparisons", "diagnostics" ] }, { "type": "object", "additionalProperties": [] }, { "type": "array", "items": [] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/living-standards/geographies/{geoLevel}/{geoCode}": { "get": { "operationId": "seer.v1.living_standards.geography", "tags": [ "SeerApi" ], "parameters": [ { "name": "geoLevel", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "geoCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1900, "maximum": 2200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "geo": { "type": "object", "properties": { "geo_level": { "type": "string" }, "geo_code": { "type": "string" }, "geo_name": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "population": { "type": [ "number", "null" ] } }, "required": [ "geo_level", "geo_code", "geo_name", "state", "postcode", "population" ] }, "year": { "type": "integer" }, "index_version": { "type": "string", "enum": [ "v1" ] }, "score": { "type": "null" }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "coverage": { "type": "object", "properties": { "status": { "type": "string" }, "domains_available": { "type": "integer" }, "domains_total": { "type": "integer" }, "minimum_coverage_met": { "type": "boolean" }, "required_anchor_met": { "type": "boolean" }, "missing_domains": { "type": "array", "items": [] }, "row_count": { "type": "integer" } }, "required": [ "status", "domains_available", "domains_total", "minimum_coverage_met", "required_anchor_met", "missing_domains", "row_count" ] }, "rank": { "type": "null" }, "percentile": { "type": "null" }, "comparisons": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "array", "items": [] } }, "required": [ "geo", "year", "index_version", "score", "domains", "coverage", "rank", "percentile", "comparisons", "diagnostics" ] }, { "type": "object", "additionalProperties": [] }, { "type": "array", "items": [] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/abs/postcodes/{postcode}": { "get": { "operationId": "seer.v1.abs.postcode", "description": "⚠️ Cannot generate request documentation: Scope is not initialized for route.", "tags": [ "SeerApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": { "anyOf": [ [], { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, "profile": [], "count": { "type": "integer" }, "rows": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "postcode", "profile", "count", "rows", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/abs/search": { "get": { "operationId": "seer.v1.abs.search", "description": "⚠️ Cannot generate request documentation: Scope is not initialized for route.", "tags": [ "SeerApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "rows": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "count", "rows", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/connections": { "get": { "operationId": "seer.v1.businesses.connections", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "linked": { "type": "string" }, "primary_entity": { "type": "string" }, "relationship_count": { "type": "integer" }, "relationships": { "type": "array", "items": [] }, "relationship_breakdown": { "type": "object", "additionalProperties": { "type": "integer", "minimum": 0 } }, "sources": { "type": "object", "properties": { "wikidata": { "type": "boolean" }, "web_intelligence": { "type": "boolean" } }, "required": [ "wikidata", "web_intelligence" ] }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" }, "window": { "type": [ "object", "null" ] }, "window_limited": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more", "window", "window_limited" ] } }, "required": [ "linked", "primary_entity", "relationship_count", "relationships", "relationship_breakdown", "sources", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/graph": { "get": { "operationId": "seer.v1.businesses.graph", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "max_edges", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 20, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "linked": { "type": "string" }, "nodes": { "type": "array", "items": [] }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "source": { "type": "string" }, "target": { "type": "string" }, "property_id": { "type": [ "string", "null" ] }, "property_label": { "type": [ "string", "null" ] }, "direction": { "type": [ "string", "null" ] }, "source_dataset": { "type": [ "string", "null" ] }, "connection_type": { "type": [ "string", "null" ] }, "weight": { "type": [ "number", "null" ] } }, "required": [ "id", "source", "target", "property_id", "property_label", "direction", "source_dataset", "connection_type", "weight" ] } } }, "required": [ "linked", "nodes", "edges" ] }, { "type": "object", "properties": { "linked": { "type": "boolean" }, "nodes": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "edges": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "linked", "nodes", "edges" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/web-intelligence": { "get": { "operationId": "seer.v1.businesses.web_intelligence", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/people-graph": { "get": { "operationId": "seer.v1.businesses.people_graph", "tags": [ "SeerApi" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "max_edges", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 20, "maximum": 600 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "linked": { "type": "boolean" }, "count": { "type": "integer" }, "nodes": { "type": "array", "items": [] }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string" }, "target": { "type": "string" }, "property_label": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "source_dataset": { "type": [ "string", "null" ] } }, "required": [ "id", "source", "target", "property_label", "direction", "source_dataset" ] } } }, "required": [ "linked", "count", "nodes", "edges" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/data-gov/opportunities": { "get": { "operationId": "seer.v1.data_gov.opportunities", "tags": [ "SeerApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "generated_at": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "disabled" ] }, "summary": { "type": "object", "properties": { "source_count": { "type": "integer" }, "add_count": { "type": "integer" }, "defer_count": { "type": "integer" }, "baseline_count": { "type": "integer" }, "p0_count": { "type": "integer" }, "p1_count": { "type": "integer" }, "p2_count": { "type": "integer" } }, "required": [ "source_count", "add_count", "defer_count", "baseline_count", "p0_count", "p1_count", "p2_count" ] }, "sources": { "type": "array", "items": [] }, "backlog": { "type": "array", "items": [] }, "fact_tables": { "type": "object", "additionalProperties": { "type": "string" } }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "deferred" ] }, "missing_tables": { "type": "array", "items": [] }, "stale_sources": { "type": "array", "items": [] }, "empty_sources": { "type": "array", "items": [] }, "deferred_sources": { "type": "array", "items": [] }, "sources": { "type": "array", "items": { "type": "array", "items": [] } } }, "required": [ "available", "status", "missing_tables", "stale_sources", "empty_sources", "deferred_sources", "sources" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "reason": { "type": "string", "enum": [ "ClickHouse is not enabled for Seer analytics reads." ] }, "missing_tables": { "type": "array", "items": [] }, "stale_sources": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "empty_sources": { "type": "array", "items": [] }, "sources": { "type": "array", "items": [] } }, "required": [ "available", "status", "reason", "missing_tables", "stale_sources", "empty_sources", "sources" ] } ] }, "metadata": { "type": "object", "properties": { "generated_at": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "partial", "missing_resource", "metadata_failed", "not_applicable" ] }, "summary": { "type": "object", "properties": { "source_count": { "type": "integer" }, "available_count": { "type": "integer" }, "partial_count": { "type": "integer" }, "missing_resource_count": { "type": "integer" }, "metadata_failed_count": { "type": "integer" }, "skipped_count": { "type": "integer" } }, "required": [ "source_count", "available_count", "partial_count", "missing_resource_count", "metadata_failed_count", "skipped_count" ] }, "sources": { "type": "array", "items": [] } }, "required": [ "generated_at", "status", "summary", "sources" ] } }, "required": [ "generated_at", "status", "summary", "sources", "backlog", "fact_tables", "readiness", "metadata" ] }, { "type": "string", "enum": [ "Required analytics facts are unavailable." ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/data-gov/business-signals": { "get": { "operationId": "seer.v1.data_gov.business_signals", "tags": [ "SeerApi" ], "parameters": [ { "name": "abn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "acn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "name", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 180 } }, { "name": "business_name", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 180 } }, { "name": "postcode", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 12 } }, { "name": "latitude", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": -44, "maximum": -9 } }, { "name": "longitude", "in": "query", "schema": { "type": [ "number", "null" ], "minimum": 112, "maximum": 154 } }, { "name": "lane", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "priority", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "status", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available" ] }, "available": { "type": "boolean" }, "generated_at": { "type": "string" }, "identity": { "type": "object", "properties": { "abn": { "type": "string" }, "acn": { "type": "string" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "postcode": { "type": "string" }, "latitude": { "type": [ "number", "null" ] }, "longitude": { "type": [ "number", "null" ] } }, "required": [ "abn", "acn", "name", "name_normalized", "postcode", "latitude", "longitude" ] }, "match_order": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "acn" ] }, { "type": "string", "enum": [ "name_postcode" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "coordinates" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false }, "signals": { "type": "string" }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available" ] }, "sources": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "status", "sources" ] } }, "required": [ "status", "available", "generated_at", "identity", "match_order", "signals", "diagnostics" ] }, { "type": "object", "properties": { "status": { "type": "string" }, "available": { "type": "boolean" }, "generated_at": { "type": "string" }, "identity": { "type": "object", "properties": { "abn": { "type": "string" }, "acn": { "type": "string" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "postcode": { "type": "string" }, "latitude": { "type": [ "number", "null" ] }, "longitude": { "type": [ "number", "null" ] } }, "required": [ "abn", "acn", "name", "name_normalized", "postcode", "latitude", "longitude" ] }, "match_order": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "acn" ] }, { "type": "string", "enum": [ "name_postcode" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "coordinates" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "deferred" ] }, "missing_tables": { "type": "array", "items": [] }, "stale_sources": { "type": "array", "items": [] }, "empty_sources": { "type": "array", "items": [] }, "deferred_sources": { "type": "array", "items": [] }, "sources": { "type": "array", "items": { "type": "array", "items": [] } } }, "required": [ "available", "status", "missing_tables", "stale_sources", "empty_sources", "deferred_sources", "sources" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "reason": { "type": "string", "enum": [ "ClickHouse is not enabled for Seer analytics reads." ] }, "missing_tables": { "type": "array", "items": [] }, "stale_sources": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "empty_sources": { "type": "array", "items": [] }, "sources": { "type": "array", "items": [] } }, "required": [ "available", "status", "reason", "missing_tables", "stale_sources", "empty_sources", "sources" ] } ] } }, "required": [ "status", "available", "generated_at", "identity", "match_order", "signals", "diagnostics" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_identity" ] }, "available": { "type": "boolean" }, "generated_at": { "type": "string" }, "identity": { "type": "object", "properties": { "abn": { "type": "string" }, "acn": { "type": "string" }, "name": { "type": "string" }, "name_normalized": { "type": "string" }, "postcode": { "type": "string" }, "latitude": { "type": [ "number", "null" ] }, "longitude": { "type": [ "number", "null" ] } }, "required": [ "abn", "acn", "name", "name_normalized", "postcode", "latitude", "longitude" ] }, "match_order": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "acn" ] }, { "type": "string", "enum": [ "name_postcode" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "coordinates" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_identity" ] }, "message": { "type": "string", "enum": [ "No ABN, ACN, name, postcode, or coordinate signal was supplied for data.gov opportunity joins." ] } }, "required": [ "status", "message" ] } }, "required": [ "status", "available", "generated_at", "identity", "match_order", "signals", "diagnostics" ] }, { "type": "string", "enum": [ "Required analytics facts are unavailable." ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/atlas/opportunities": { "get": { "operationId": "seer.v1.atlas.opportunities", "tags": [ "SeerAtlas" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "filters": { "type": "object", "properties": { "lens": { "type": "string" }, "layer": { "type": "string" }, "state": { "type": "array", "items": [] }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "postcode_prefix": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "q": { "type": "string" }, "min_score": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lens", "layer", "state", "postcode", "postcode_prefix", "sector", "q", "min_score", "limit" ] }, "lenses": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "affluent_growth_low_digital_competition_infrastructure" ] }, "label": { "type": "string", "enum": [ "Affluent growth / low competition / rising investment" ] }, "description": { "type": "string", "enum": [ "Ranks postcodes where economic capacity, demand, growth, and infrastructure strength are high while the digital competition gap is still open." ] }, "primary_layer": { "type": "string", "enum": [ "atlas_opportunity" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "postcode_health" ] }, "label": { "type": "string", "enum": [ "Postcode health score" ] }, "description": { "type": "string", "enum": [ "Overall market health blended from economic strength, growth, coverage, and risk pressure." ] }, "primary_layer": { "type": "string", "enum": [ "postcode_health" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "business_saturation" ] }, "label": { "type": "string", "enum": [ "Business saturation" ] }, "description": { "type": "string", "enum": [ "Highlights crowded markets where provider density is high relative to local opportunity." ] }, "primary_layer": { "type": "string", "enum": [ "business_saturation" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "underserved_market" ] }, "label": { "type": "string", "enum": [ "Underserved market finder" ] }, "description": { "type": "string", "enum": [ "Surfaces postcodes where demand and capacity outrun visible digital maturity and provider coverage." ] }, "primary_layer": { "type": "string", "enum": [ "underserved_market" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_stress" ] }, "label": { "type": "string", "enum": [ "Economic stress heatmap" ] }, "description": { "type": "string", "enum": [ "Ranks postcodes by insolvency, employment, charity dependency, and broader pressure signals." ] }, "primary_layer": { "type": "string", "enum": [ "economic_stress" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "government_spending_density" ] }, "label": { "type": "string", "enum": [ "Government-spending density" ] }, "description": { "type": "string", "enum": [ "Finds local markets with concentrated government contracts, grants, or public-sector demand." ] }, "primary_layer": { "type": "string", "enum": [ "government_spending" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "retail_opportunity" ] }, "label": { "type": "string", "enum": [ "Retail opportunity" ] }, "description": { "type": "string", "enum": [ "Ranks retail and consumer-service pockets where demand is high and local digital competition is weak." ] }, "primary_layer": { "type": "string", "enum": [ "retail_opportunity" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "infrastructure_growth_corridors" ] }, "label": { "type": "string", "enum": [ "Infrastructure growth corridors" ] }, "description": { "type": "string", "enum": [ "Tracks infrastructure investment, contracts, facility anchors, and growth momentum by postcode." ] }, "primary_layer": { "type": "string", "enum": [ "infrastructure_growth" ] } }, "required": [ "key", "label", "description", "primary_layer" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false }, "layers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "atlas_opportunity" ] }, "label": { "type": "string", "enum": [ "Atlas opportunity" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Saved-lens score for affluent growth, digital gap, demand, infrastructure, and risk drag." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "postcode_health" ] }, "label": { "type": "string", "enum": [ "Postcode health" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Composite health score for the postcode." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_strength" ] }, "label": { "type": "string", "enum": [ "Economic strength" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Income, property, employment, and capacity signals." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "growth_momentum" ] }, "label": { "type": "string", "enum": [ "Growth momentum" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Population, infrastructure, and over-time movement signals." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "digital_gap" ] }, "label": { "type": "string", "enum": [ "Digital gap" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Opportunity created by weak observed digital maturity versus demand." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "business_saturation" ] }, "label": { "type": "string", "enum": [ "Business saturation" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Provider density and crowding pressure." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "underserved_market" ] }, "label": { "type": "string", "enum": [ "Underserved market" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Demand and affluence minus competitive service coverage." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_stress" ] }, "label": { "type": "string", "enum": [ "Economic stress" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Insolvency, charity dependency, employment pressure, and risk pressure." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "government_spending" ] }, "label": { "type": "string", "enum": [ "Government spending" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Public spending and contract density." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "infrastructure_growth" ] }, "label": { "type": "string", "enum": [ "Infrastructure growth" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Facility anchors, projects, corridors, and investment momentum." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "charity_dependency" ] }, "label": { "type": "string", "enum": [ "Charity dependency" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Charity and grant-dependency concentration." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "retail_opportunity" ] }, "label": { "type": "string", "enum": [ "Retail opportunity" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Consumer demand and retail/service white space." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "asx_exposure" ] }, "label": { "type": "string", "enum": [ "ASX exposure" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Listed-company and market-exposure concentration." ] } }, "required": [ "key", "label", "unit", "description" ] } ], "minItems": 13, "maxItems": 13, "additionalItems": false }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "lens": { "type": "string" }, "active_layer": { "type": "string" }, "row_count": { "type": "integer" }, "top_postcode": { "type": [ "string", "null" ] }, "top_label": { "type": [ "string", "null" ] }, "top_score": { "type": [ "number", "null" ] }, "average_score": { "type": [ "number", "null" ] }, "average_opportunity_score": { "type": [ "number", "null" ] }, "states": { "type": "array", "items": [] }, "message": { "type": "string", "enum": [ "Atlas opportunity facts are available for the current filters.", "No Atlas postcodes match the current filters." ] } }, "required": [ "available", "status", "lens", "active_layer", "row_count", "top_postcode", "top_label", "top_score", "average_score", "average_opportunity_score", "states", "message" ] }, "map": { "type": "object", "properties": { "active_layer": { "type": "string" }, "features": { "type": "array", "items": [] } }, "required": [ "active_layer", "features" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "rank": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "state": { "type": [ "string", "null" ] }, "primary_suburb": { "type": [ "string", "null" ] }, "suburbs": { "type": "array", "items": [] }, "lga_name": { "type": [ "string", "null" ] }, "sa2_name": { "type": [ "string", "null" ] }, "sector_key": { "type": [ "string", "null" ] }, "sector_name": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "All sectors" ] } ] }, "scores": { "type": "object", "properties": { "active_score": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "atlas_opportunity": { "type": [ "number", "null" ] }, "postcode_health": { "type": [ "number", "null" ] }, "confidence": { "type": [ "number", "null" ] }, "coverage": { "type": [ "number", "null" ] } }, "required": [ "active_score", "atlas_opportunity", "postcode_health", "confidence", "coverage" ] }, "layers": { "type": "object", "properties": { "atlas_opportunity": { "type": [ "number", "null" ] }, "postcode_health": { "type": [ "number", "null" ] }, "economic_strength": { "type": [ "number", "null" ] }, "growth_momentum": { "type": [ "number", "null" ] }, "digital_gap": { "type": [ "number", "null" ] }, "business_saturation": { "type": [ "number", "null" ] }, "underserved_market": { "type": [ "number", "null" ] }, "economic_stress": { "type": [ "number", "null" ] }, "government_spending": { "type": [ "number", "null" ] }, "infrastructure_growth": { "type": [ "number", "null" ] }, "charity_dependency": { "type": [ "number", "null" ] }, "retail_opportunity": { "type": [ "number", "null" ] }, "asx_exposure": { "type": [ "number", "null" ] } }, "required": [ "atlas_opportunity", "postcode_health", "economic_strength", "growth_momentum", "digital_gap", "business_saturation", "underserved_market", "economic_stress", "government_spending", "infrastructure_growth", "charity_dependency", "retail_opportunity", "asx_exposure" ] }, "metrics": { "type": "object", "properties": { "population": { "type": [ "integer", "null" ] }, "households": { "type": [ "integer", "null" ] }, "median_household_income_aud": { "type": [ "number", "null" ] }, "business_count": { "type": [ "integer", "null" ] }, "active_abn_count": { "type": [ "integer", "null" ] }, "competitor_count": { "type": [ "integer", "null" ] }, "government_contract_count": { "type": [ "integer", "null" ] }, "government_contract_value_aud": { "type": [ "number", "null" ] }, "facility_anchor_count": { "type": [ "integer", "null" ] }, "charity_count": { "type": [ "integer", "null" ] }, "insolvency_notice_count": { "type": [ "integer", "null" ] } }, "required": [ "population", "households", "median_household_income_aud", "business_count", "active_abn_count", "competitor_count", "government_contract_count", "government_contract_value_aud", "facility_anchor_count", "charity_count", "insolvency_notice_count" ] }, "drivers": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_strength" ] }, "label": { "type": "string", "enum": [ "Economic capacity" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "positive" ] } }, "required": [ "key", "label", "value", "direction" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "growth_momentum" ] }, "label": { "type": "string", "enum": [ "Growth momentum" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "positive" ] } }, "required": [ "key", "label", "value", "direction" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "demand_signal" ] }, "label": { "type": "string", "enum": [ "Demand signal" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "positive" ] } }, "required": [ "key", "label", "value", "direction" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "digital_gap" ] }, "label": { "type": "string", "enum": [ "Digital competition gap" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "positive" ] } }, "required": [ "key", "label", "value", "direction" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "infrastructure_growth" ] }, "label": { "type": "string", "enum": [ "Infrastructure investment" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "positive" ] } }, "required": [ "key", "label", "value", "direction" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "government_spending" ] }, "label": { "type": "string", "enum": [ "Government spending" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "positive" ] } }, "required": [ "key", "label", "value", "direction" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "stress_risk" ] }, "label": { "type": "string", "enum": [ "Stress risk drag" ] }, "value": { "type": [ "number", "null" ] }, "direction": { "type": "string", "enum": [ "negative" ] } }, "required": [ "key", "label", "value", "direction" ] } ] } }, "risk_flags": { "type": "array", "items": { "type": "string", "enum": [ "High economic stress", "Insolvency pressure", "Employment pressure", "Charity dependency" ] } }, "badges": { "type": "array", "items": [] }, "insight": { "type": "string" }, "explainability": { "type": "object", "additionalProperties": [] }, "source_vintage": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "map_feature": { "type": "object", "properties": { "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "state": { "type": [ "string", "null" ] }, "geo_name": { "type": "string" }, "label": { "type": "string" }, "business_count": { "type": [ "integer", "null" ] }, "centroid": { "type": [ "object", "null" ], "properties": { "lat": { "type": [ "number", "null" ] }, "lng": { "type": [ "number", "null" ] }, "source": { "type": "string", "enum": [ "seer_atlas" ] } }, "required": [ "lat", "lng", "source" ] }, "geometry": { "type": [ "object", "null" ], "additionalProperties": [] }, "value_by_layer": { "type": "object", "properties": { "atlas_opportunity": { "type": [ "number", "null" ] }, "postcode_health": { "type": [ "number", "null" ] }, "economic_strength": { "type": [ "number", "null" ] }, "growth_momentum": { "type": [ "number", "null" ] }, "digital_gap": { "type": [ "number", "null" ] }, "business_saturation": { "type": [ "number", "null" ] }, "underserved_market": { "type": [ "number", "null" ] }, "economic_stress": { "type": [ "number", "null" ] }, "government_spending": { "type": [ "number", "null" ] }, "infrastructure_growth": { "type": [ "number", "null" ] }, "charity_dependency": { "type": [ "number", "null" ] }, "retail_opportunity": { "type": [ "number", "null" ] }, "asx_exposure": { "type": [ "number", "null" ] } }, "required": [ "atlas_opportunity", "postcode_health", "economic_strength", "growth_momentum", "digital_gap", "business_saturation", "underserved_market", "economic_stress", "government_spending", "infrastructure_growth", "charity_dependency", "retail_opportunity", "asx_exposure" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "null" } ] }, "value_label": { "type": "string" }, "value_text": { "type": "string" }, "note": { "type": "string" }, "selected": { "type": "boolean" }, "": { "anyOf": [ { "type": "object", "properties": { "abs_2021_poa_match": { "type": "boolean" }, "signal_only": { "type": "boolean" }, "data_classification": { "type": "string", "enum": [ "signal_only" ] }, "data_status_label": { "type": "string", "enum": [ "Signal-only" ] }, "data_status_message": { "type": "string", "enum": [ "No 2021 ABS POA match; ABS-dependent atlas metrics are unavailable until this postcode is deliberately mapped to a current or nearest POA." ] }, "excluded_from_abs_rankings": { "type": "boolean" } }, "required": [ "abs_2021_poa_match", "signal_only", "data_classification", "data_status_label", "data_status_message", "excluded_from_abs_rankings" ] }, { "type": "object", "properties": { "abs_2021_poa_match": { "type": "boolean" }, "signal_only": { "type": "boolean" }, "data_classification": { "type": "string", "enum": [ "abs_2021_poa" ] }, "data_status_label": { "type": "string", "enum": [ "2021 POA match" ] }, "data_status_message": { "type": "string", "enum": [ "2021 ABS POA boundary and demographic facts are available for this postcode." ] }, "excluded_from_abs_rankings": { "type": "boolean" } }, "required": [ "abs_2021_poa_match", "signal_only", "data_classification", "data_status_label", "data_status_message", "excluded_from_abs_rankings" ] } ] } }, "required": [ "postcode", "state", "geo_name", "label", "business_count", "centroid", "geometry", "value_by_layer", "value", "value_label", "value_text", "note", "selected", null ] }, "": { "anyOf": [ { "type": "object", "properties": { "abs_2021_poa_match": { "type": "boolean" }, "signal_only": { "type": "boolean" }, "data_classification": { "type": "string", "enum": [ "signal_only" ] }, "data_status_label": { "type": "string", "enum": [ "Signal-only" ] }, "data_status_message": { "type": "string", "enum": [ "No 2021 ABS POA match; ABS-dependent atlas metrics are unavailable until this postcode is deliberately mapped to a current or nearest POA." ] }, "excluded_from_abs_rankings": { "type": "boolean" } }, "required": [ "abs_2021_poa_match", "signal_only", "data_classification", "data_status_label", "data_status_message", "excluded_from_abs_rankings" ] }, { "type": "object", "properties": { "abs_2021_poa_match": { "type": "boolean" }, "signal_only": { "type": "boolean" }, "data_classification": { "type": "string", "enum": [ "abs_2021_poa" ] }, "data_status_label": { "type": "string", "enum": [ "2021 POA match" ] }, "data_status_message": { "type": "string", "enum": [ "2021 ABS POA boundary and demographic facts are available for this postcode." ] }, "excluded_from_abs_rankings": { "type": "boolean" } }, "required": [ "abs_2021_poa_match", "signal_only", "data_classification", "data_status_label", "data_status_message", "excluded_from_abs_rankings" ] } ] } }, "required": [ "rank", "postcode", "state", "primary_suburb", "suburbs", "lga_name", "sa2_name", "sector_key", "sector_name", "scores", "layers", "metrics", "drivers", "risk_flags", "badges", "insight", "explainability", "source_vintage", "updated_at", "map_feature", null ] } }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Atlas source diagnostics are empty." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "message": { "type": "string", "enum": [ "Atlas source diagnostics have not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": "object", "properties": { "missing_table": { "type": "string" } }, "required": [ "missing_table" ] } }, "required": [ "available", "status", "message", "rows", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "message": { "type": "string", "enum": [ "Atlas source diagnostics are unavailable because the analytics pipeline is disabled." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] } ] }, "generated_at": { "type": "string" }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "postcode_facts": { "type": "string" }, "source_status": { "type": "string" } }, "required": [ "postcode_facts", "source_status" ] }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "postcode_fact_rows": { "type": "integer" }, "source_status_available": { "type": "boolean" } }, "required": [ "postcode_fact_rows", "source_status_available" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Atlas postcode facts have not been materialized yet." ] }, "empty_tables": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Atlas postcode facts are not available yet." ] }, "missing_tables": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Atlas intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "available", "status", "filters", "lenses", "layers", "summary", "map", "rows", "source_status", "generated_at", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "filters": { "type": "object", "properties": { "lens": { "type": "string" }, "layer": { "type": "string" }, "state": { "type": "array", "items": [] }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "postcode_prefix": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "q": { "type": "string" }, "min_score": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lens", "layer", "state", "postcode", "postcode_prefix", "sector", "q", "min_score", "limit" ] }, "lenses": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "affluent_growth_low_digital_competition_infrastructure" ] }, "label": { "type": "string", "enum": [ "Affluent growth / low competition / rising investment" ] }, "description": { "type": "string", "enum": [ "Ranks postcodes where economic capacity, demand, growth, and infrastructure strength are high while the digital competition gap is still open." ] }, "primary_layer": { "type": "string", "enum": [ "atlas_opportunity" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "postcode_health" ] }, "label": { "type": "string", "enum": [ "Postcode health score" ] }, "description": { "type": "string", "enum": [ "Overall market health blended from economic strength, growth, coverage, and risk pressure." ] }, "primary_layer": { "type": "string", "enum": [ "postcode_health" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "business_saturation" ] }, "label": { "type": "string", "enum": [ "Business saturation" ] }, "description": { "type": "string", "enum": [ "Highlights crowded markets where provider density is high relative to local opportunity." ] }, "primary_layer": { "type": "string", "enum": [ "business_saturation" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "underserved_market" ] }, "label": { "type": "string", "enum": [ "Underserved market finder" ] }, "description": { "type": "string", "enum": [ "Surfaces postcodes where demand and capacity outrun visible digital maturity and provider coverage." ] }, "primary_layer": { "type": "string", "enum": [ "underserved_market" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_stress" ] }, "label": { "type": "string", "enum": [ "Economic stress heatmap" ] }, "description": { "type": "string", "enum": [ "Ranks postcodes by insolvency, employment, charity dependency, and broader pressure signals." ] }, "primary_layer": { "type": "string", "enum": [ "economic_stress" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "government_spending_density" ] }, "label": { "type": "string", "enum": [ "Government-spending density" ] }, "description": { "type": "string", "enum": [ "Finds local markets with concentrated government contracts, grants, or public-sector demand." ] }, "primary_layer": { "type": "string", "enum": [ "government_spending" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "retail_opportunity" ] }, "label": { "type": "string", "enum": [ "Retail opportunity" ] }, "description": { "type": "string", "enum": [ "Ranks retail and consumer-service pockets where demand is high and local digital competition is weak." ] }, "primary_layer": { "type": "string", "enum": [ "retail_opportunity" ] } }, "required": [ "key", "label", "description", "primary_layer" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "infrastructure_growth_corridors" ] }, "label": { "type": "string", "enum": [ "Infrastructure growth corridors" ] }, "description": { "type": "string", "enum": [ "Tracks infrastructure investment, contracts, facility anchors, and growth momentum by postcode." ] }, "primary_layer": { "type": "string", "enum": [ "infrastructure_growth" ] } }, "required": [ "key", "label", "description", "primary_layer" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false }, "layers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "atlas_opportunity" ] }, "label": { "type": "string", "enum": [ "Atlas opportunity" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Saved-lens score for affluent growth, digital gap, demand, infrastructure, and risk drag." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "postcode_health" ] }, "label": { "type": "string", "enum": [ "Postcode health" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Composite health score for the postcode." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_strength" ] }, "label": { "type": "string", "enum": [ "Economic strength" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Income, property, employment, and capacity signals." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "growth_momentum" ] }, "label": { "type": "string", "enum": [ "Growth momentum" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Population, infrastructure, and over-time movement signals." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "digital_gap" ] }, "label": { "type": "string", "enum": [ "Digital gap" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Opportunity created by weak observed digital maturity versus demand." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "business_saturation" ] }, "label": { "type": "string", "enum": [ "Business saturation" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Provider density and crowding pressure." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "underserved_market" ] }, "label": { "type": "string", "enum": [ "Underserved market" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Demand and affluence minus competitive service coverage." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "economic_stress" ] }, "label": { "type": "string", "enum": [ "Economic stress" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Insolvency, charity dependency, employment pressure, and risk pressure." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "government_spending" ] }, "label": { "type": "string", "enum": [ "Government spending" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Public spending and contract density." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "infrastructure_growth" ] }, "label": { "type": "string", "enum": [ "Infrastructure growth" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Facility anchors, projects, corridors, and investment momentum." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "charity_dependency" ] }, "label": { "type": "string", "enum": [ "Charity dependency" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Charity and grant-dependency concentration." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "retail_opportunity" ] }, "label": { "type": "string", "enum": [ "Retail opportunity" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Consumer demand and retail/service white space." ] } }, "required": [ "key", "label", "unit", "description" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "asx_exposure" ] }, "label": { "type": "string", "enum": [ "ASX exposure" ] }, "unit": { "type": "string", "enum": [ "/100" ] }, "description": { "type": "string", "enum": [ "Listed-company and market-exposure concentration." ] } }, "required": [ "key", "label", "unit", "description" ] } ], "minItems": 13, "maxItems": 13, "additionalItems": false }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "row_count": { "type": "integer", "enum": [ 0 ] }, "message": { "type": "string", "enum": [ "Atlas intelligence is unavailable because the analytics pipeline is disabled.", "Atlas postcode facts are not available yet.", "Atlas postcode facts have not been materialized yet." ] } }, "required": [ "available", "status", "row_count", "message" ] }, "map": { "type": "object", "properties": { "active_layer": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "active_layer", "features" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Atlas source diagnostics are empty." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "message": { "type": "string", "enum": [ "Atlas source diagnostics have not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": "object", "properties": { "missing_table": { "type": "string" } }, "required": [ "missing_table" ] } }, "required": [ "available", "status", "message", "rows", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "message": { "type": "string", "enum": [ "Atlas source diagnostics are unavailable because the analytics pipeline is disabled." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] } ] }, "generated_at": { "type": "string" }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "postcode_facts": { "type": "string" }, "source_status": { "type": "string" } }, "required": [ "postcode_facts", "source_status" ] }, "diagnostics": { "type": "string" } }, "required": [ "tables", "diagnostics" ] } }, "required": [ "available", "status", "filters", "lenses", "layers", "summary", "map", "rows", "source_status", "generated_at", "debug" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/atlas/postcodes/{postcode}": { "get": { "operationId": "seer.v1.atlas.postcodes.show", "tags": [ "SeerAtlas" ], "parameters": [ { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": [] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/atlas/sources/status": { "get": { "operationId": "seer.v1.atlas.sources.status", "tags": [ "SeerAtlas" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Atlas source diagnostics are empty." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "message": { "type": "string", "enum": [ "Atlas source diagnostics have not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": "object", "properties": { "missing_table": { "type": "string" } }, "required": [ "missing_table" ] } }, "required": [ "available", "status", "message", "rows", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "message": { "type": "string", "enum": [ "Atlas source diagnostics are unavailable because the analytics pipeline is disabled." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/authority/business/{business}": { "get": { "operationId": "seer.v1.authority.business", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 30 } }, { "name": "include_debug", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "business": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": [ "object", "null" ] } ] }, "name": { "type": [ "string", "null" ] }, "abn": { "type": [ "string", "null" ] }, "acn": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "contact_email": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "suburb": { "type": [ "string", "null" ] }, "categories": { "type": "array", "items": [] } }, "required": [ "id", "name", "abn", "acn", "website", "contact_email", "postcode", "state", "suburb", "categories" ] }, "linked": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": [ "string", "null" ] }, "trust_label": [], "risk_label": [], "digital_label": [], "freshness_label": [], "alert_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "watchlist_count": { "type": "integer" } }, "required": [ "primary_domain", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count", "watchlist_count" ] }, "primary_domain": { "type": [ "string", "null" ] }, "safe_web_authority": { "type": "array", "items": { "anyOf": [ [], { "type": [ "string", "null" ] } ] } }, "size_estimation": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "estimated_size_score": { "type": "null" }, "estimated_employees_low": { "type": "null" }, "estimated_employees_high": { "type": "null" }, "estimated_revenue_floor": { "type": "null" }, "digital_maturity_score": { "type": "null" }, "commercial_confidence_score": { "type": "null" }, "digital_label": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "estimated_size_score", "estimated_employees_low", "estimated_employees_high", "estimated_revenue_floor", "digital_maturity_score", "commercial_confidence_score", "digital_label" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "classification": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "trust_label": { "type": "string", "enum": [ "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Unknown" ] }, "digital_label": { "type": "string", "enum": [ "Unknown" ] }, "freshness_label": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "trust_label", "risk_label", "digital_label", "freshness_label" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "freshness": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Unknown" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "No primary domain resolved yet." ] } }, "required": [ "label", "is_stale", "stale_reason" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence_score": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "number", "enum": [ 0 ] } ] }, "explain": { "type": [ "string", "null" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer" }, "relationship_breakdown": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "primary_domains": { "type": "array", "items": [] } }, "required": [ "relationship_count", "relationship_breakdown", "primary_domains" ] }, "domains": { "type": "array", "items": [] }, "owned_domains": { "type": "array", "items": [] }, "connected_domains": { "type": "array", "items": [] }, "network": { "type": "object", "properties": { "connections": { "type": "array", "items": [] }, "website_domain": { "type": [ "string", "null" ] }, "email_domain": { "type": [ "string", "null" ] }, "summary": { "type": "object", "properties": { "outbound_link_count": { "type": "integer" }, "inbound_link_count": { "type": "integer" }, "shared_signal_count": { "type": "integer" }, "peer_link_count": { "type": "integer" }, "internal_link_count": { "type": "integer" } }, "required": [ "outbound_link_count", "inbound_link_count", "shared_signal_count", "peer_link_count", "internal_link_count" ] } }, "required": [ "connections", "website_domain", "email_domain", "summary" ] }, "connected_businesses": { "type": "array", "items": [] }, "brand_integrity": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "label": { "type": "string", "enum": [ "Fragmented" ] }, "domain_count": { "type": "integer" }, "linked_abn_count": { "type": "integer" } }, "required": [ "score", "label", "domain_count", "linked_abn_count" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "mismatch_detection": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "label": { "type": "string", "enum": [ "Mismatch risk", "Review", "Aligned" ] }, "flags": { "type": "array", "items": [] } }, "required": [ "score", "label", "flags" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "suspicious_clusters": { "anyOf": [ { "type": "object", "properties": { "score": { "type": [ "object", "null" ] }, "label": { "type": "string", "enum": [ "Cluster risk", "Watch", "Clear" ] }, "connected_high_risk_domains": { "type": "array", "items": [] }, "alerts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "suspicious_cluster" ] }, "label": { "type": "string", "enum": [ "Multiple connected high-risk domains are sitting in the same web neighborhood." ] } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "watch_connected_risk" ] }, "label": { "type": "string", "enum": [ "A connected domain is carrying high-risk trust signals." ] } }, "required": [ "severity", "type", "label" ] } ] } } }, "required": [ "score", "label", "connected_high_risk_domains", "alerts" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "abandonment_indicators": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "signals": { "type": "array", "items": [] } }, "required": [ "count", "signals" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "acquisition_indicators": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "signals": { "type": "array", "items": [] } }, "required": [ "count", "signals" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "trend": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "No trend yet" ] }, "score_delta_30d": { "type": "number", "enum": [ 0 ] }, "score_delta_90d": { "type": "number", "enum": [ 0 ] } }, "required": [ "label", "score_delta_30d", "score_delta_90d" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "benchmarks": { "anyOf": [ { "type": "object", "properties": { "postcode": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "postcode" ] }, "scope_label": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "business_count": { "type": "integer" }, "average_safe_web_authority_score": { "type": "number" }, "average_risk_score": { "type": "number" }, "average_digital_maturity_score": { "type": "number" } }, "required": [ "scope_type", "scope_label", "available", "business_count", "average_safe_web_authority_score", "average_risk_score", "average_digital_maturity_score" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "business_id": { "type": "integer" }, "business_name": { "type": "string" }, "slug": { "type": "string" }, "abn": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "safe_web_authority_score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_visibility_score": { "type": "number" }, "primary_domain": { "type": [ "string", "null" ] } }, "required": [ "business_id", "business_name", "slug", "abn", "safe_web_authority_score", "authority_score", "risk_score", "digital_maturity_score", "commercial_confidence_score", "digital_visibility_score", "primary_domain" ] } }, "top_trusted": { "type": "array", "items": [] }, "top_risk": { "type": "array", "items": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "Peer trust benchmarks are calculated from ClickHouse business identities joined to the latest Safe Web Authority metrics by ABN." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Peer benchmark" ] }, "summary": { "type": "string", "enum": [ "This benchmark compares the business to a local or industry peer set." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string" }, "formula": { "type": "string", "enum": [ "peer_average = average(latest peer Safe Web Authority scores)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "scope_label" ] }, "value": { "type": [ "string", "null" ] }, "source_field": { "type": "string", "enum": [ "seer_discover_businesses_fact + discover category facts" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "business_count" ] }, "value": { "type": "integer" }, "source_field": { "type": "string", "enum": [ "ClickHouse peer cohort size" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_safe_web_authority_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_risk_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Discover businesses fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "main_address_postcode" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "postcode" ] }, "scope_label": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "scope_type", "scope_label", "available", "business_count" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_trusted": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_risk": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "No peer rows resolved from ClickHouse for this benchmark scope yet." ] }, "sections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] } ] }, "industry": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "industry" ] }, "scope_label": { "type": "string" }, "available": { "type": "boolean" }, "business_count": { "type": "integer" }, "average_safe_web_authority_score": { "type": "number" }, "average_risk_score": { "type": "number" }, "average_digital_maturity_score": { "type": "number" } }, "required": [ "scope_type", "scope_label", "available", "business_count", "average_safe_web_authority_score", "average_risk_score", "average_digital_maturity_score" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "business_id": { "type": "integer" }, "business_name": { "type": "string" }, "slug": { "type": "string" }, "abn": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "safe_web_authority_score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_visibility_score": { "type": "number" }, "primary_domain": { "type": [ "string", "null" ] } }, "required": [ "business_id", "business_name", "slug", "abn", "safe_web_authority_score", "authority_score", "risk_score", "digital_maturity_score", "commercial_confidence_score", "digital_visibility_score", "primary_domain" ] } }, "top_trusted": { "type": "array", "items": [] }, "top_risk": { "type": "array", "items": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "Peer trust benchmarks are calculated from ClickHouse business identities joined to the latest Safe Web Authority metrics by ABN." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Peer benchmark" ] }, "summary": { "type": "string", "enum": [ "This benchmark compares the business to a local or industry peer set." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string" }, "formula": { "type": "string", "enum": [ "peer_average = average(latest peer Safe Web Authority scores)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "scope_label" ] }, "value": { "type": "string" }, "source_field": { "type": "string", "enum": [ "seer_discover_businesses_fact + discover category facts" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "business_count" ] }, "value": { "type": "integer" }, "source_field": { "type": "string", "enum": [ "ClickHouse peer cohort size" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_safe_web_authority_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_risk_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Discover businesses fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "main_address_postcode" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "industry" ] }, "scope_label": { "type": "string" }, "available": { "type": "boolean" }, "business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "scope_type", "scope_label", "available", "business_count" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_trusted": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_risk": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "No peer rows resolved from ClickHouse for this benchmark scope yet." ] }, "sections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] } ] } }, "required": [ "postcode", "industry" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "monitoring": { "type": "object", "properties": { "watchlist": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "alert_count": { "type": "integer" }, "entries": { "type": "array", "items": [] } }, "required": [ "count", "alert_count", "entries" ] }, { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "entries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "entries" ] } ] }, "alerts": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "recrawl_recommended": { "type": "boolean" } }, "required": [ "watchlist", "alerts", "recrawl_recommended" ] }, "alerts": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "enum": [ "Safe Web Authority calculations" ] }, "summary": { "type": "string", "enum": [ "Every figure below is derived from ClickHouse-backed Seer web, business, and trust signals." ] }, "sections": { "type": "array", "items": [] } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "enabled", "business", "linked", "summary", "primary_domain", "safe_web_authority", "size_estimation", "classification", "freshness", "confidence_score", "explain", "internet_map", "domains", "owned_domains", "connected_domains", "network", "connected_businesses", "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "trend", "benchmarks", "monitoring", "alerts", "debug" ] }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "business": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id" ] }, "linked": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": "null" }, "trust_label": { "type": "string", "enum": [ "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Unknown" ] }, "digital_label": { "type": "string", "enum": [ "Unknown" ] }, "freshness_label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "alert_count": { "type": "integer", "enum": [ 0 ] }, "watchlist_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "primary_domain", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count", "watchlist_count" ] }, "primary_domain": { "type": "null" }, "safe_web_authority": { "type": "null" }, "size_estimation": { "type": "null" }, "classification": { "type": "null" }, "freshness": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "business_identity_not_synced_to_clickhouse" ] }, "recommended_recrawl": { "type": "boolean" } }, "required": [ "label", "is_stale", "stale_reason", "recommended_recrawl" ] }, "confidence_score": { "type": "integer", "enum": [ 0 ] }, "explain": { "type": "object", "properties": { "summary": { "type": "string", "enum": [ "No ClickHouse-backed business identity has been synced for this business yet." ] }, "strengths": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "risks": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "missing_signals": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Business identity not synced into Seer ClickHouse facts." ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "top_drivers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "summary", "strengths", "risks", "missing_signals", "top_drivers" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer", "enum": [ 0 ] }, "relationship_breakdown": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "primary_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "relationship_count", "relationship_breakdown", "primary_domains" ] }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "owned_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "connected_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "network": { "type": "object", "properties": { "connections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "website_domain": { "type": "null" }, "email_domain": { "type": "null" } }, "required": [ "connections", "website_domain", "email_domain" ] }, "connected_businesses": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "brand_integrity": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "domain_count": { "type": "integer", "enum": [ 0 ] }, "linked_abn_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "score", "label", "domain_count", "linked_abn_count" ] }, "mismatch_detection": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "flags": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "score", "label", "flags" ] }, "suspicious_clusters": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "connected_high_risk_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "score", "label", "connected_high_risk_domains", "alerts" ] }, "abandonment_indicators": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "signals" ] }, "acquisition_indicators": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "signals" ] }, "benchmarks": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "monitoring": { "type": "object", "properties": { "watchlist": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "entries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "entries" ] }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "recrawl_recommended": { "type": "boolean" } }, "required": [ "watchlist", "alerts", "recrawl_recommended" ] }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": "null" } }, "required": [ "enabled", "business", "linked", "summary", "primary_domain", "safe_web_authority", "size_estimation", "classification", "freshness", "confidence_score", "explain", "internet_map", "domains", "owned_domains", "connected_domains", "network", "connected_businesses", "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "benchmarks", "monitoring", "alerts", "debug" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/authority/{domain}": { "get": { "operationId": "seer.v1.authority.domain", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_debug", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": [ "object", "null" ], "properties": { "domain": { "type": "string" }, "name": { "type": "string" }, "abn": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "last_crawled_at": { "type": "string" }, "last_scored_at": { "type": "string" }, "source_data_as_of": { "type": "string" }, "confidence_score": { "type": "number" }, "freshness": { "type": "object", "properties": { "last_crawled_at": { "type": "string" }, "last_scored_at": { "type": "string" }, "source_data_as_of": { "type": "string" }, "age_minutes": { "type": [ "object", "null" ] }, "label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "The crawl is materially out of date for trust decisions." ] }, "recommended_recrawl": { "type": "boolean" } }, "required": [ "last_crawled_at", "last_scored_at", "source_data_as_of", "age_minutes", "label", "is_stale", "stale_reason", "recommended_recrawl" ] }, "classification": { "type": "object", "properties": { "trust_label": { "type": "string", "enum": [ "Unverified", "Watch", "Established", "Trusted", "High Risk", "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Low Risk", "Moderate", "Elevated", "High Risk" ] }, "digital_label": { "type": "string", "enum": [ "Dormant", "Weak", "Basic", "Functional", "Digitally Mature" ] }, "freshness_label": { "type": "string", "enum": [ "Needs Recrawl" ] } }, "required": [ "trust_label", "risk_label", "digital_label", "freshness_label" ] }, "safe_web_authority": { "type": "object", "properties": { "score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "is_scam": { "type": "boolean" }, "label": { "type": "string", "enum": [ "Unverified", "Watch", "Established", "Trusted", "High Risk", "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Low Risk", "Moderate", "Elevated", "High Risk" ] } }, "required": [ "score", "authority_score", "risk_score", "is_scam", "label", "risk_label" ] }, "size_estimation": { "type": "object", "properties": { "estimated_size_score": { "type": "number" }, "estimated_employees_low": { "type": [ "object", "null" ] }, "estimated_employees_high": { "type": [ "object", "null" ] }, "estimated_revenue_floor": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_label": { "type": "string", "enum": [ "Dormant", "Weak", "Basic", "Functional", "Digitally Mature" ] } }, "required": [ "estimated_size_score", "estimated_employees_low", "estimated_employees_high", "estimated_revenue_floor", "digital_maturity_score", "commercial_confidence_score", "digital_label" ] }, "trend": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Strengthening" ] }, "score_delta_30d": { "type": "number" }, "score_delta_90d": { "type": "number" }, "authority_delta_30d": { "type": "number" }, "risk_delta_30d": { "type": "number" } }, "required": [ "label", "score_delta_30d", "score_delta_90d", "authority_delta_30d", "risk_delta_30d" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "No trend yet" ] }, "score_delta_30d": { "type": "number", "enum": [ 0 ] }, "score_delta_90d": { "type": "number", "enum": [ 0 ] }, "authority_delta_30d": { "type": "number", "enum": [ 0 ] }, "risk_delta_30d": { "type": "number", "enum": [ 0 ] } }, "required": [ "label", "score_delta_30d", "score_delta_90d", "authority_delta_30d", "risk_delta_30d" ] } ] }, "explain": { "type": "object", "properties": { "summary": { "type": "string" }, "strengths": { "type": "array", "items": [] }, "risks": { "type": "array", "items": [] }, "missing_signals": { "type": "array", "items": [] }, "top_drivers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Authority" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Risk" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Digital maturity" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Commercial confidence" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "summary", "strengths", "risks", "missing_signals", "top_drivers" ] }, "watchlist_rule": { "type": "null" }, "alerts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "score_floor_breach" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "risk_ceiling_breach" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "trend_drop_alert" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "stale_watch" ] }, "label": { "type": "string", "enum": [ "This watch entry now needs a recrawl before trusting the score." ] } }, "required": [ "severity", "type", "label" ] } ] } }, "flags": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "Scam threshold crossed", "Elevated risk posture" ] }, { "type": "string", "enum": [ "Stale crawl" ] } ] }, { "type": "string", "enum": [ "Trust trend deteriorating", "Weak SSL posture", "Suspicious page signals", "Dense connected-domain cluster" ] } ] } }, "connection_summary": { "type": "object", "properties": { "count": { "type": "integer" }, "types": { "type": "object", "additionalProperties": { "type": "integer" } } }, "required": [ "count", "types" ] }, "linked_businesses": { "type": "array", "items": [] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "signals": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "history": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "debug": { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Safe Web Authority domain model" ] }, "summary": { "type": "string", "enum": [ "This is the canonical Seer contract for trust, risk, digital maturity, freshness, and watchlist logic on a domain." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Trust score" ] }, "summary": { "type": "string", "enum": [ "The headline Safe Web Authority score blends authority and risk into a 0-100 trust-style measure." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Safe Web Authority" ] }, "formula": { "type": "string", "enum": [ "safe_web_authority = 0.72 * authority_score + 0.28 * (100 - risk_score)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "authority_score" ] }, "value": [], "weight": { "type": "string", "enum": [ "72%" ] }, "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.authority_score" ] } }, "required": [ "label", "value", "weight", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "risk_score" ] }, "value": [], "weight": { "type": "string", "enum": [ "28%" ] }, "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.risk_score" ] } }, "required": [ "label", "value", "weight", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "safe_web_authority_score" ] }, "value": [], "source_field": { "type": "string", "enum": [ "derived in SafeWebAuthorityContractService::safeScore" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] }, { "type": "string", "enum": [ "estimated_size_score" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Freshness and trend" ] }, "summary": { "type": "string", "enum": [ "Freshness separates crawl recency from score time, and trend compares the latest domain metrics to the lookback history." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Freshness" ] }, "formula": { "type": "string", "enum": [ "fresh / aging / stale / needs_recrawl from source_data_as_of age thresholds" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "last_crawled_at" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domains_fact.last_crawled" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "last_scored_at" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domains_fact.updated_at" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "age_minutes" ] }, "value": [], "source_field": { "type": "string", "enum": [ "derived in SafeWebAuthorityContractService::freshness" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trend_30d" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.updated_at history" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "last_crawled" ] }, { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "page_count" ] }, { "type": "string", "enum": [ "ssl_valid" ] }, { "type": "string", "enum": [ "sitemap_exists" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Metric history" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "domain", "name", "abn", "source", "updated_at", "last_crawled_at", "last_scored_at", "source_data_as_of", "confidence_score", "freshness", "classification", "safe_web_authority", "size_estimation", "trend", "explain", "watchlist_rule", "alerts", "flags", "connection_summary", "linked_businesses", "infrastructure", "signals", "history", "debug" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "safe_web_authority": { "type": "null" } }, "required": [ "domain", "safe_web_authority" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/web-intelligence/business/{business}": { "get": { "operationId": "seer.v1.web_intelligence.business", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "include_debug", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": [ "string", "null" ] }, "safe_web_authority_score": [], "trust_label": [], "risk_label": [], "freshness_label": [], "relationship_count": { "type": "integer" }, "connected_domain_count": { "type": "integer" }, "outbound_link_count": { "type": "integer" }, "inbound_link_count": { "type": "integer" }, "shared_signal_count": { "type": "integer" }, "network_posture_label": [], "high_risk_connected_count": { "type": "integer" }, "watchlist_count": { "type": "integer" }, "alert_count": { "type": "integer" } }, "required": [ "primary_domain", "safe_web_authority_score", "trust_label", "risk_label", "freshness_label", "relationship_count", "connected_domain_count", "outbound_link_count", "inbound_link_count", "shared_signal_count", "network_posture_label", "high_risk_connected_count", "watchlist_count", "alert_count" ] }, "modules": { "type": "object", "properties": { "safe_web_authority": { "type": "object", "properties": { "safe_web_authority_score": [], "trust_label": [], "risk_label": [], "digital_label": [], "freshness_label": [], "alert_count": { "type": "integer" } }, "required": [ "safe_web_authority_score", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer" }, "owned_domain_count": { "type": "integer" }, "connected_domain_count": { "type": "integer" }, "linked_business_count": { "type": "integer" }, "network_posture_label": [], "high_risk_connected_count": { "type": "integer" } }, "required": [ "relationship_count", "owned_domain_count", "connected_domain_count", "linked_business_count", "network_posture_label", "high_risk_connected_count" ] } }, "required": [ "safe_web_authority", "internet_map" ] }, "safe_web_authority": { "type": "object", "properties": { "summary": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "safe_web_authority": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "classification": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "freshness": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "summary", "safe_web_authority", "classification", "freshness" ] }, "internet_map": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "primary_domain": { "type": [ "string", "null" ] }, "relationship_count": { "type": "integer" }, "owned_domain_count": { "type": "integer" }, "connected_domain_count": { "type": "integer" }, "outbound_link_count": { "type": "integer" }, "inbound_link_count": { "type": "integer" }, "shared_signal_count": { "type": "integer" }, "linked_business_count": { "type": "integer" }, "high_risk_connected_count": { "type": "integer" }, "network_posture_label": { "type": "string", "enum": [ "Focused footprint", "Active neighbourhood", "Expansive footprint", "Established network", "High-risk cluster" ] }, "average_safe_web_authority_score": { "type": [ "number", "null" ] }, "alert_count": { "type": "integer" } }, "required": [ "primary_domain", "relationship_count", "owned_domain_count", "connected_domain_count", "outbound_link_count", "inbound_link_count", "shared_signal_count", "linked_business_count", "high_risk_connected_count", "network_posture_label", "average_safe_web_authority_score", "alert_count" ] }, "overview": { "type": "object", "properties": { "primary_domain": { "type": [ "string", "null" ] }, "focus_business_name": { "type": "string" }, "website_domain": [], "email_domain": [] }, "required": [ "primary_domain", "focus_business_name", "website_domain", "email_domain" ] }, "nodes": { "type": "array", "items": [] }, "edges": { "type": "array", "items": [] }, "clusters": { "type": "array", "items": [] }, "connection_types": { "type": "array", "items": [] }, "link_flows": { "type": "array", "items": [] }, "suspicious_neighbourhoods": { "type": "array", "items": [] }, "connected_businesses": { "type": "array", "items": [] }, "filters": { "type": "object", "properties": { "node_types": { "type": "array", "items": [] }, "trust_labels": { "type": "array", "items": [] }, "risk_labels": { "type": "array", "items": [] }, "freshness_labels": { "type": "array", "items": [] }, "connection_types": { "type": "array", "items": [] }, "flow_directions": { "type": "array", "items": [] } }, "required": [ "node_types", "trust_labels", "risk_labels", "freshness_labels", "connection_types", "flow_directions" ] }, "overlays": { "type": "object", "properties": { "average_safe_web_authority_score": { "type": [ "number", "null" ] }, "average_risk_score": { "type": [ "number", "null" ] }, "trusted_nodes": { "type": "integer" }, "high_risk_nodes": { "type": "integer" }, "stale_nodes": { "type": "integer" }, "digitally_mature_nodes": { "type": "integer" }, "edge_count": { "type": "integer" }, "alert_count": { "type": "integer" }, "brand_integrity_label": [], "mismatch_label": [] }, "required": [ "average_safe_web_authority_score", "average_risk_score", "trusted_nodes", "high_risk_nodes", "stale_nodes", "digitally_mature_nodes", "edge_count", "alert_count", "brand_integrity_label", "mismatch_label" ] }, "detail_panel": { "type": [ "object", "null" ], "additionalProperties": [] } }, "required": [ "summary", "overview", "nodes", "edges", "clusters", "connection_types", "link_flows", "suspicious_neighbourhoods", "connected_businesses", "filters", "overlays", "detail_panel" ] }, "signals": { "type": "object", "properties": { "brand_integrity": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "mismatch_detection": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "suspicious_clusters": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "abandonment_indicators": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "acquisition_indicators": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "trend": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "trend" ] }, "benchmarks": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "monitoring": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "alerts": { "type": "array", "items": [] }, "debug": { "type": [ "string", "null" ] } }, "required": [ "enabled", "summary", "modules", "safe_web_authority", "internet_map", "signals", "benchmarks", "monitoring", "alerts", "debug" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/internet-map/business/{business}": { "get": { "operationId": "seer.v1.internet_map.business", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "include_debug", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "safe_web_authority": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "internet_map": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "signals": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "benchmarks": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "monitoring": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "alerts": { "type": "array", "items": [] }, "debug": { "type": [ "string", "null" ] } }, "required": [ "enabled", "summary", "safe_web_authority", "internet_map", "signals", "benchmarks", "monitoring", "alerts", "debug" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/safe-web-authority/business/{business}": { "get": { "operationId": "seer.v1.safe_web_authority.business", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 30 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "business": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": [ "object", "null" ] } ] }, "name": { "type": [ "string", "null" ] }, "abn": { "type": [ "string", "null" ] }, "acn": { "type": [ "string", "null" ] }, "website": { "type": [ "string", "null" ] }, "contact_email": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "suburb": { "type": [ "string", "null" ] }, "categories": { "type": "array", "items": [] } }, "required": [ "id", "name", "abn", "acn", "website", "contact_email", "postcode", "state", "suburb", "categories" ] }, "linked": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": [ "string", "null" ] }, "trust_label": [], "risk_label": [], "digital_label": [], "freshness_label": [], "alert_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "watchlist_count": { "type": "integer" } }, "required": [ "primary_domain", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count", "watchlist_count" ] }, "primary_domain": { "type": [ "string", "null" ] }, "safe_web_authority": { "type": "array", "items": { "anyOf": [ [], { "type": [ "string", "null" ] } ] } }, "size_estimation": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "estimated_size_score": { "type": "null" }, "estimated_employees_low": { "type": "null" }, "estimated_employees_high": { "type": "null" }, "estimated_revenue_floor": { "type": "null" }, "digital_maturity_score": { "type": "null" }, "commercial_confidence_score": { "type": "null" }, "digital_label": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "estimated_size_score", "estimated_employees_low", "estimated_employees_high", "estimated_revenue_floor", "digital_maturity_score", "commercial_confidence_score", "digital_label" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "classification": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "trust_label": { "type": "string", "enum": [ "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Unknown" ] }, "digital_label": { "type": "string", "enum": [ "Unknown" ] }, "freshness_label": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "trust_label", "risk_label", "digital_label", "freshness_label" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "freshness": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Unknown" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "No primary domain resolved yet." ] } }, "required": [ "label", "is_stale", "stale_reason" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence_score": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "number", "enum": [ 0 ] } ] }, "explain": { "type": [ "string", "null" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer" }, "relationship_breakdown": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "primary_domains": { "type": "array", "items": [] } }, "required": [ "relationship_count", "relationship_breakdown", "primary_domains" ] }, "domains": { "type": "array", "items": [] }, "owned_domains": { "type": "array", "items": [] }, "connected_domains": { "type": "array", "items": [] }, "network": { "type": "object", "properties": { "connections": { "type": "array", "items": [] }, "website_domain": { "type": [ "string", "null" ] }, "email_domain": { "type": [ "string", "null" ] }, "summary": { "type": "object", "properties": { "outbound_link_count": { "type": "integer" }, "inbound_link_count": { "type": "integer" }, "shared_signal_count": { "type": "integer" }, "peer_link_count": { "type": "integer" }, "internal_link_count": { "type": "integer" } }, "required": [ "outbound_link_count", "inbound_link_count", "shared_signal_count", "peer_link_count", "internal_link_count" ] } }, "required": [ "connections", "website_domain", "email_domain", "summary" ] }, "connected_businesses": { "type": "array", "items": [] }, "brand_integrity": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "label": { "type": "string", "enum": [ "Fragmented" ] }, "domain_count": { "type": "integer" }, "linked_abn_count": { "type": "integer" } }, "required": [ "score", "label", "domain_count", "linked_abn_count" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "mismatch_detection": { "anyOf": [ { "type": "object", "properties": { "score": { "type": "number" }, "label": { "type": "string", "enum": [ "Mismatch risk", "Review", "Aligned" ] }, "flags": { "type": "array", "items": [] } }, "required": [ "score", "label", "flags" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "suspicious_clusters": { "anyOf": [ { "type": "object", "properties": { "score": { "type": [ "object", "null" ] }, "label": { "type": "string", "enum": [ "Cluster risk", "Watch", "Clear" ] }, "connected_high_risk_domains": { "type": "array", "items": [] }, "alerts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "suspicious_cluster" ] }, "label": { "type": "string", "enum": [ "Multiple connected high-risk domains are sitting in the same web neighborhood." ] } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "watch_connected_risk" ] }, "label": { "type": "string", "enum": [ "A connected domain is carrying high-risk trust signals." ] } }, "required": [ "severity", "type", "label" ] } ] } } }, "required": [ "score", "label", "connected_high_risk_domains", "alerts" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "abandonment_indicators": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "signals": { "type": "array", "items": [] } }, "required": [ "count", "signals" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "acquisition_indicators": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "signals": { "type": "array", "items": [] } }, "required": [ "count", "signals" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "trend": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "No trend yet" ] }, "score_delta_30d": { "type": "number", "enum": [ 0 ] }, "score_delta_90d": { "type": "number", "enum": [ 0 ] } }, "required": [ "label", "score_delta_30d", "score_delta_90d" ] } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "benchmarks": { "anyOf": [ { "type": "object", "properties": { "postcode": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "postcode" ] }, "scope_label": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "business_count": { "type": "integer" }, "average_safe_web_authority_score": { "type": "number" }, "average_risk_score": { "type": "number" }, "average_digital_maturity_score": { "type": "number" } }, "required": [ "scope_type", "scope_label", "available", "business_count", "average_safe_web_authority_score", "average_risk_score", "average_digital_maturity_score" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "business_id": { "type": "integer" }, "business_name": { "type": "string" }, "slug": { "type": "string" }, "abn": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "safe_web_authority_score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_visibility_score": { "type": "number" }, "primary_domain": { "type": [ "string", "null" ] } }, "required": [ "business_id", "business_name", "slug", "abn", "safe_web_authority_score", "authority_score", "risk_score", "digital_maturity_score", "commercial_confidence_score", "digital_visibility_score", "primary_domain" ] } }, "top_trusted": { "type": "array", "items": [] }, "top_risk": { "type": "array", "items": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "Peer trust benchmarks are calculated from ClickHouse business identities joined to the latest Safe Web Authority metrics by ABN." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Peer benchmark" ] }, "summary": { "type": "string", "enum": [ "This benchmark compares the business to a local or industry peer set." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string" }, "formula": { "type": "string", "enum": [ "peer_average = average(latest peer Safe Web Authority scores)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "scope_label" ] }, "value": { "type": [ "string", "null" ] }, "source_field": { "type": "string", "enum": [ "seer_discover_businesses_fact + discover category facts" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "business_count" ] }, "value": { "type": "integer" }, "source_field": { "type": "string", "enum": [ "ClickHouse peer cohort size" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_safe_web_authority_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_risk_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Discover businesses fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "main_address_postcode" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "postcode" ] }, "scope_label": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "scope_type", "scope_label", "available", "business_count" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_trusted": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_risk": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "No peer rows resolved from ClickHouse for this benchmark scope yet." ] }, "sections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] } ] }, "industry": { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "industry" ] }, "scope_label": { "type": "string" }, "available": { "type": "boolean" }, "business_count": { "type": "integer" }, "average_safe_web_authority_score": { "type": "number" }, "average_risk_score": { "type": "number" }, "average_digital_maturity_score": { "type": "number" } }, "required": [ "scope_type", "scope_label", "available", "business_count", "average_safe_web_authority_score", "average_risk_score", "average_digital_maturity_score" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "business_id": { "type": "integer" }, "business_name": { "type": "string" }, "slug": { "type": "string" }, "abn": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "safe_web_authority_score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_visibility_score": { "type": "number" }, "primary_domain": { "type": [ "string", "null" ] } }, "required": [ "business_id", "business_name", "slug", "abn", "safe_web_authority_score", "authority_score", "risk_score", "digital_maturity_score", "commercial_confidence_score", "digital_visibility_score", "primary_domain" ] } }, "top_trusted": { "type": "array", "items": [] }, "top_risk": { "type": "array", "items": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "Peer trust benchmarks are calculated from ClickHouse business identities joined to the latest Safe Web Authority metrics by ABN." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Peer benchmark" ] }, "summary": { "type": "string", "enum": [ "This benchmark compares the business to a local or industry peer set." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string" }, "formula": { "type": "string", "enum": [ "peer_average = average(latest peer Safe Web Authority scores)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "scope_label" ] }, "value": { "type": "string" }, "source_field": { "type": "string", "enum": [ "seer_discover_businesses_fact + discover category facts" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "business_count" ] }, "value": { "type": "integer" }, "source_field": { "type": "string", "enum": [ "ClickHouse peer cohort size" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_safe_web_authority_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "average_risk_score" ] }, "value": { "type": "number" }, "source_field": { "type": "string", "enum": [ "derived from SeerWebIntelligenceService::businessIntelligenceByAbns" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Discover businesses fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "postcode" ] }, { "type": "string", "enum": [ "main_address_postcode" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "scope_type": { "type": "string", "enum": [ "industry" ] }, "scope_label": { "type": "string" }, "available": { "type": "boolean" }, "business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "scope_type", "scope_label", "available", "business_count" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_trusted": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_risk": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string" }, "summary": { "type": "string", "enum": [ "No peer rows resolved from ClickHouse for this benchmark scope yet." ] }, "sections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "rows", "top_trusted", "top_risk", "debug" ] } ] } }, "required": [ "postcode", "industry" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "monitoring": { "type": "object", "properties": { "watchlist": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer" }, "alert_count": { "type": "integer" }, "entries": { "type": "array", "items": [] } }, "required": [ "count", "alert_count", "entries" ] }, { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "entries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "entries" ] } ] }, "alerts": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "recrawl_recommended": { "type": "boolean" } }, "required": [ "watchlist", "alerts", "recrawl_recommended" ] }, "alerts": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "enum": [ "Safe Web Authority calculations" ] }, "summary": { "type": "string", "enum": [ "Every figure below is derived from ClickHouse-backed Seer web, business, and trust signals." ] }, "sections": { "type": "array", "items": [] } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "enabled", "business", "linked", "summary", "primary_domain", "safe_web_authority", "size_estimation", "classification", "freshness", "confidence_score", "explain", "internet_map", "domains", "owned_domains", "connected_domains", "network", "connected_businesses", "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "trend", "benchmarks", "monitoring", "alerts", "debug" ] }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "business": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" }, { "type": "object" } ] } }, "required": [ "id" ] }, "linked": { "type": "boolean" }, "summary": { "type": "object", "properties": { "primary_domain": { "type": "null" }, "trust_label": { "type": "string", "enum": [ "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Unknown" ] }, "digital_label": { "type": "string", "enum": [ "Unknown" ] }, "freshness_label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "alert_count": { "type": "integer", "enum": [ 0 ] }, "watchlist_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "primary_domain", "trust_label", "risk_label", "digital_label", "freshness_label", "alert_count", "watchlist_count" ] }, "primary_domain": { "type": "null" }, "safe_web_authority": { "type": "null" }, "size_estimation": { "type": "null" }, "classification": { "type": "null" }, "freshness": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "business_identity_not_synced_to_clickhouse" ] }, "recommended_recrawl": { "type": "boolean" } }, "required": [ "label", "is_stale", "stale_reason", "recommended_recrawl" ] }, "confidence_score": { "type": "integer", "enum": [ 0 ] }, "explain": { "type": "object", "properties": { "summary": { "type": "string", "enum": [ "No ClickHouse-backed business identity has been synced for this business yet." ] }, "strengths": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "risks": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "missing_signals": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Business identity not synced into Seer ClickHouse facts." ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "top_drivers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "summary", "strengths", "risks", "missing_signals", "top_drivers" ] }, "internet_map": { "type": "object", "properties": { "relationship_count": { "type": "integer", "enum": [ 0 ] }, "relationship_breakdown": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "primary_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "relationship_count", "relationship_breakdown", "primary_domains" ] }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "owned_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "connected_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "network": { "type": "object", "properties": { "connections": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "website_domain": { "type": "null" }, "email_domain": { "type": "null" } }, "required": [ "connections", "website_domain", "email_domain" ] }, "connected_businesses": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "brand_integrity": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "domain_count": { "type": "integer", "enum": [ 0 ] }, "linked_abn_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "score", "label", "domain_count", "linked_abn_count" ] }, "mismatch_detection": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "flags": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "score", "label", "flags" ] }, "suspicious_clusters": { "type": "object", "properties": { "score": { "type": "integer", "enum": [ 0 ] }, "label": { "type": "string", "enum": [ "Unknown" ] }, "connected_high_risk_domains": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "score", "label", "connected_high_risk_domains", "alerts" ] }, "abandonment_indicators": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "signals" ] }, "acquisition_indicators": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "signals" ] }, "benchmarks": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "monitoring": { "type": "object", "properties": { "watchlist": { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "entries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "count", "entries" ] }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "recrawl_recommended": { "type": "boolean" } }, "required": [ "watchlist", "alerts", "recrawl_recommended" ] }, "alerts": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "debug": { "type": "null" } }, "required": [ "enabled", "business", "linked", "summary", "primary_domain", "safe_web_authority", "size_estimation", "classification", "freshness", "confidence_score", "explain", "internet_map", "domains", "owned_domains", "connected_domains", "network", "connected_businesses", "brand_integrity", "mismatch_detection", "suspicious_clusters", "abandonment_indicators", "acquisition_indicators", "benchmarks", "monitoring", "alerts", "debug" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/safe-web-authority/domain/{domain}": { "get": { "operationId": "seer.v1.safe_web_authority.domain", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": [ "object", "null" ], "properties": { "domain": { "type": "string" }, "name": { "type": "string" }, "abn": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "last_crawled_at": { "type": "string" }, "last_scored_at": { "type": "string" }, "source_data_as_of": { "type": "string" }, "confidence_score": { "type": "number" }, "freshness": { "type": "object", "properties": { "last_crawled_at": { "type": "string" }, "last_scored_at": { "type": "string" }, "source_data_as_of": { "type": "string" }, "age_minutes": { "type": [ "object", "null" ] }, "label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "The crawl is materially out of date for trust decisions." ] }, "recommended_recrawl": { "type": "boolean" } }, "required": [ "last_crawled_at", "last_scored_at", "source_data_as_of", "age_minutes", "label", "is_stale", "stale_reason", "recommended_recrawl" ] }, "classification": { "type": "object", "properties": { "trust_label": { "type": "string", "enum": [ "Unverified", "Watch", "Established", "Trusted", "High Risk", "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Low Risk", "Moderate", "Elevated", "High Risk" ] }, "digital_label": { "type": "string", "enum": [ "Dormant", "Weak", "Basic", "Functional", "Digitally Mature" ] }, "freshness_label": { "type": "string", "enum": [ "Needs Recrawl" ] } }, "required": [ "trust_label", "risk_label", "digital_label", "freshness_label" ] }, "safe_web_authority": { "type": "object", "properties": { "score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "is_scam": { "type": "boolean" }, "label": { "type": "string", "enum": [ "Unverified", "Watch", "Established", "Trusted", "High Risk", "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Low Risk", "Moderate", "Elevated", "High Risk" ] } }, "required": [ "score", "authority_score", "risk_score", "is_scam", "label", "risk_label" ] }, "size_estimation": { "type": "object", "properties": { "estimated_size_score": { "type": "number" }, "estimated_employees_low": { "type": [ "object", "null" ] }, "estimated_employees_high": { "type": [ "object", "null" ] }, "estimated_revenue_floor": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_label": { "type": "string", "enum": [ "Dormant", "Weak", "Basic", "Functional", "Digitally Mature" ] } }, "required": [ "estimated_size_score", "estimated_employees_low", "estimated_employees_high", "estimated_revenue_floor", "digital_maturity_score", "commercial_confidence_score", "digital_label" ] }, "trend": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Strengthening" ] }, "score_delta_30d": { "type": "number" }, "score_delta_90d": { "type": "number" }, "authority_delta_30d": { "type": "number" }, "risk_delta_30d": { "type": "number" } }, "required": [ "label", "score_delta_30d", "score_delta_90d", "authority_delta_30d", "risk_delta_30d" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "No trend yet" ] }, "score_delta_30d": { "type": "number", "enum": [ 0 ] }, "score_delta_90d": { "type": "number", "enum": [ 0 ] }, "authority_delta_30d": { "type": "number", "enum": [ 0 ] }, "risk_delta_30d": { "type": "number", "enum": [ 0 ] } }, "required": [ "label", "score_delta_30d", "score_delta_90d", "authority_delta_30d", "risk_delta_30d" ] } ] }, "explain": { "type": "object", "properties": { "summary": { "type": "string" }, "strengths": { "type": "array", "items": [] }, "risks": { "type": "array", "items": [] }, "missing_signals": { "type": "array", "items": [] }, "top_drivers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Authority" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Risk" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Digital maturity" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Commercial confidence" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "summary", "strengths", "risks", "missing_signals", "top_drivers" ] }, "watchlist_rule": { "type": "null" }, "alerts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "score_floor_breach" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "risk_ceiling_breach" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "trend_drop_alert" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "stale_watch" ] }, "label": { "type": "string", "enum": [ "This watch entry now needs a recrawl before trusting the score." ] } }, "required": [ "severity", "type", "label" ] } ] } }, "flags": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "Scam threshold crossed", "Elevated risk posture" ] }, { "type": "string", "enum": [ "Stale crawl" ] } ] }, { "type": "string", "enum": [ "Trust trend deteriorating", "Weak SSL posture", "Suspicious page signals", "Dense connected-domain cluster" ] } ] } }, "connection_summary": { "type": "object", "properties": { "count": { "type": "integer" }, "types": { "type": "object", "additionalProperties": { "type": "integer" } } }, "required": [ "count", "types" ] }, "linked_businesses": { "type": "array", "items": [] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "signals": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "history": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "debug": { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Safe Web Authority domain model" ] }, "summary": { "type": "string", "enum": [ "This is the canonical Seer contract for trust, risk, digital maturity, freshness, and watchlist logic on a domain." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Trust score" ] }, "summary": { "type": "string", "enum": [ "The headline Safe Web Authority score blends authority and risk into a 0-100 trust-style measure." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Safe Web Authority" ] }, "formula": { "type": "string", "enum": [ "safe_web_authority = 0.72 * authority_score + 0.28 * (100 - risk_score)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "authority_score" ] }, "value": [], "weight": { "type": "string", "enum": [ "72%" ] }, "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.authority_score" ] } }, "required": [ "label", "value", "weight", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "risk_score" ] }, "value": [], "weight": { "type": "string", "enum": [ "28%" ] }, "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.risk_score" ] } }, "required": [ "label", "value", "weight", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "safe_web_authority_score" ] }, "value": [], "source_field": { "type": "string", "enum": [ "derived in SafeWebAuthorityContractService::safeScore" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] }, { "type": "string", "enum": [ "estimated_size_score" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Freshness and trend" ] }, "summary": { "type": "string", "enum": [ "Freshness separates crawl recency from score time, and trend compares the latest domain metrics to the lookback history." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Freshness" ] }, "formula": { "type": "string", "enum": [ "fresh / aging / stale / needs_recrawl from source_data_as_of age thresholds" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "last_crawled_at" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domains_fact.last_crawled" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "last_scored_at" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domains_fact.updated_at" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "age_minutes" ] }, "value": [], "source_field": { "type": "string", "enum": [ "derived in SafeWebAuthorityContractService::freshness" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trend_30d" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.updated_at history" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "last_crawled" ] }, { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "page_count" ] }, { "type": "string", "enum": [ "ssl_valid" ] }, { "type": "string", "enum": [ "sitemap_exists" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Metric history" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "domain", "name", "abn", "source", "updated_at", "last_crawled_at", "last_scored_at", "source_data_as_of", "confidence_score", "freshness", "classification", "safe_web_authority", "size_estimation", "trend", "explain", "watchlist_rule", "alerts", "flags", "connection_summary", "linked_businesses", "infrastructure", "signals", "history", "debug" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "safe_web_authority": { "type": "null" } }, "required": [ "domain", "safe_web_authority" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/safe-web-authority/postcodes/{postcode}": { "get": { "operationId": "seer.v1.safe_web_authority.postcode", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categories[]", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "maxLength": 120 } } }, { "name": "include_debug", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "postcode": { "type": "string" }, "available": { "type": "boolean" }, "summary": { "type": [ "string", "null" ] }, "rows": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "debug": { "type": [ "string", "null" ] } }, "required": [ "postcode", "available", "summary", "rows", "debug" ] }, { "type": "object", "properties": { "postcode": { "type": "null" }, "available": { "type": "boolean" }, "summary": { "type": "null" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "postcode", "available", "summary", "rows" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/safe-web-authority/business/{business}/watchlist": { "post": { "operationId": "seer.v1.safe_web_authority.watchlist.store", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "maxLength": 255 }, "label": { "type": [ "string", "null" ], "maxLength": 120 }, "notes": { "type": [ "string", "null" ], "maxLength": 2000 }, "min_safe_score": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "max_risk_score": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "drop_alert_pct": { "type": [ "number", "null" ], "minimum": 0, "maximum": 100 }, "require_stale": { "type": [ "boolean", "null" ] } }, "required": [ "domain" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/safe-web-authority/business/{business}/watchlist/{domain}": { "delete": { "operationId": "seer.v1.safe_web_authority.watchlist.destroy", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "removed": { "type": "boolean" }, "domain": { "type": "string" } }, "required": [ "removed", "domain" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/safe-web-authority/domain/{domain}/recrawl": { "post": { "operationId": "seer.v1.safe_web_authority.recrawl", "tags": [ "SeerAuthority" ], "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "refreshed": { "type": "boolean" }, "domain": { "type": [ "object", "null" ], "properties": { "domain": { "type": "string" }, "name": { "type": "string" }, "abn": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "last_crawled_at": { "type": "string" }, "last_scored_at": { "type": "string" }, "source_data_as_of": { "type": "string" }, "confidence_score": { "type": "number" }, "freshness": { "type": "object", "properties": { "last_crawled_at": { "type": "string" }, "last_scored_at": { "type": "string" }, "source_data_as_of": { "type": "string" }, "age_minutes": { "type": [ "object", "null" ] }, "label": { "type": "string", "enum": [ "Needs Recrawl" ] }, "is_stale": { "type": "boolean" }, "stale_reason": { "type": "string", "enum": [ "The crawl is materially out of date for trust decisions." ] }, "recommended_recrawl": { "type": "boolean" } }, "required": [ "last_crawled_at", "last_scored_at", "source_data_as_of", "age_minutes", "label", "is_stale", "stale_reason", "recommended_recrawl" ] }, "classification": { "type": "object", "properties": { "trust_label": { "type": "string", "enum": [ "Unverified", "Watch", "Established", "Trusted", "High Risk", "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Low Risk", "Moderate", "Elevated", "High Risk" ] }, "digital_label": { "type": "string", "enum": [ "Dormant", "Weak", "Basic", "Functional", "Digitally Mature" ] }, "freshness_label": { "type": "string", "enum": [ "Needs Recrawl" ] } }, "required": [ "trust_label", "risk_label", "digital_label", "freshness_label" ] }, "safe_web_authority": { "type": "object", "properties": { "score": { "type": "number" }, "authority_score": { "type": "number" }, "risk_score": { "type": "number" }, "is_scam": { "type": "boolean" }, "label": { "type": "string", "enum": [ "Unverified", "Watch", "Established", "Trusted", "High Risk", "Insufficient Data" ] }, "risk_label": { "type": "string", "enum": [ "Low Risk", "Moderate", "Elevated", "High Risk" ] } }, "required": [ "score", "authority_score", "risk_score", "is_scam", "label", "risk_label" ] }, "size_estimation": { "type": "object", "properties": { "estimated_size_score": { "type": "number" }, "estimated_employees_low": { "type": [ "object", "null" ] }, "estimated_employees_high": { "type": [ "object", "null" ] }, "estimated_revenue_floor": { "type": "number" }, "digital_maturity_score": { "type": "number" }, "commercial_confidence_score": { "type": "number" }, "digital_label": { "type": "string", "enum": [ "Dormant", "Weak", "Basic", "Functional", "Digitally Mature" ] } }, "required": [ "estimated_size_score", "estimated_employees_low", "estimated_employees_high", "estimated_revenue_floor", "digital_maturity_score", "commercial_confidence_score", "digital_label" ] }, "trend": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Strengthening" ] }, "score_delta_30d": { "type": "number" }, "score_delta_90d": { "type": "number" }, "authority_delta_30d": { "type": "number" }, "risk_delta_30d": { "type": "number" } }, "required": [ "label", "score_delta_30d", "score_delta_90d", "authority_delta_30d", "risk_delta_30d" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "No trend yet" ] }, "score_delta_30d": { "type": "number", "enum": [ 0 ] }, "score_delta_90d": { "type": "number", "enum": [ 0 ] }, "authority_delta_30d": { "type": "number", "enum": [ 0 ] }, "risk_delta_30d": { "type": "number", "enum": [ 0 ] } }, "required": [ "label", "score_delta_30d", "score_delta_90d", "authority_delta_30d", "risk_delta_30d" ] } ] }, "explain": { "type": "object", "properties": { "summary": { "type": "string" }, "strengths": { "type": "array", "items": [] }, "risks": { "type": "array", "items": [] }, "missing_signals": { "type": "array", "items": [] }, "top_drivers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Authority" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Risk" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Digital maturity" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Commercial confidence" ] }, "value": { "type": "number" } }, "required": [ "label", "value" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "summary", "strengths", "risks", "missing_signals", "top_drivers" ] }, "watchlist_rule": { "type": "null" }, "alerts": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "score_floor_breach" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "high" ] }, "type": { "type": "string", "enum": [ "risk_ceiling_breach" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "trend_drop_alert" ] }, "label": { "type": "string" } }, "required": [ "severity", "type", "label" ] }, { "type": "object", "properties": { "severity": { "type": "string", "enum": [ "medium" ] }, "type": { "type": "string", "enum": [ "stale_watch" ] }, "label": { "type": "string", "enum": [ "This watch entry now needs a recrawl before trusting the score." ] } }, "required": [ "severity", "type", "label" ] } ] } }, "flags": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "Scam threshold crossed", "Elevated risk posture" ] }, { "type": "string", "enum": [ "Stale crawl" ] } ] }, { "type": "string", "enum": [ "Trust trend deteriorating", "Weak SSL posture", "Suspicious page signals", "Dense connected-domain cluster" ] } ] } }, "connection_summary": { "type": "object", "properties": { "count": { "type": "integer" }, "types": { "type": "object", "additionalProperties": { "type": "integer" } } }, "required": [ "count", "types" ] }, "linked_businesses": { "type": "array", "items": [] }, "infrastructure": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "signals": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "history": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "debug": { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Safe Web Authority domain model" ] }, "summary": { "type": "string", "enum": [ "This is the canonical Seer contract for trust, risk, digital maturity, freshness, and watchlist logic on a domain." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Trust score" ] }, "summary": { "type": "string", "enum": [ "The headline Safe Web Authority score blends authority and risk into a 0-100 trust-style measure." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Safe Web Authority" ] }, "formula": { "type": "string", "enum": [ "safe_web_authority = 0.72 * authority_score + 0.28 * (100 - risk_score)" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "authority_score" ] }, "value": [], "weight": { "type": "string", "enum": [ "72%" ] }, "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.authority_score" ] } }, "required": [ "label", "value", "weight", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "risk_score" ] }, "value": [], "weight": { "type": "string", "enum": [ "28%" ] }, "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.risk_score" ] } }, "required": [ "label", "value", "weight", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "safe_web_authority_score" ] }, "value": [], "source_field": { "type": "string", "enum": [ "derived in SafeWebAuthorityContractService::safeScore" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain metrics fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] }, { "type": "string", "enum": [ "digital_maturity_score" ] }, { "type": "string", "enum": [ "commercial_confidence_score" ] }, { "type": "string", "enum": [ "estimated_size_score" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Freshness and trend" ] }, "summary": { "type": "string", "enum": [ "Freshness separates crawl recency from score time, and trend compares the latest domain metrics to the lookback history." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Freshness" ] }, "formula": { "type": "string", "enum": [ "fresh / aging / stale / needs_recrawl from source_data_as_of age thresholds" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "last_crawled_at" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domains_fact.last_crawled" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "last_scored_at" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domains_fact.updated_at" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "age_minutes" ] }, "value": [], "source_field": { "type": "string", "enum": [ "derived in SafeWebAuthorityContractService::freshness" ] } }, "required": [ "label", "value", "source_field" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trend_30d" ] }, "value": [], "source_field": { "type": "string", "enum": [ "seer_web_domain_metrics_fact.updated_at history" ] } }, "required": [ "label", "value", "source_field" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web domain fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "last_crawled" ] }, { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "page_count" ] }, { "type": "string", "enum": [ "ssl_valid" ] }, { "type": "string", "enum": [ "sitemap_exists" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Metric history" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "authority_score" ] }, { "type": "string", "enum": [ "risk_score" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "domain", "name", "abn", "source", "updated_at", "last_crawled_at", "last_scored_at", "source_data_as_of", "confidence_score", "freshness", "classification", "safe_web_authority", "size_estimation", "trend", "explain", "watchlist_rule", "alerts", "flags", "connection_summary", "linked_businesses", "infrastructure", "signals", "history", "debug" ] } }, "required": [ "refreshed", "domain" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "refreshed": { "type": "boolean" } }, "required": [ "domain", "refreshed" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/deals": { "get": { "operationId": "seer.v1.deals.index", "tags": [ "SeerDeals" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "party_role": { "type": "string" }, "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "asx_symbol": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "status", "stage", "party_role", "abn", "acn", "asx_symbol", "sector", "state", "postcode", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "total_count": { "type": "integer" }, "active_count": { "type": "integer" }, "latest_event_date": { "type": [ "string", "null" ] }, "source_count": { "type": "integer" }, "matched_business_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] } }, "required": [ "available", "status", "total_count", "active_count", "latest_event_date", "source_count", "matched_business_count" ] }, "results": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "parties": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "array", "items": [] } }, "required": [ "tables" ] } }, "required": [ "filters", "summary", "results", "parties", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "party_role": { "type": "string" }, "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "asx_symbol": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "status", "stage", "party_role", "abn", "acn", "asx_symbol", "sector", "state", "postcode", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "total_count": { "type": "integer", "enum": [ 0 ] }, "active_count": { "type": "integer", "enum": [ 0 ] }, "latest_event_date": { "type": "null" }, "matched_business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "total_count", "active_count", "latest_event_date", "matched_business_count" ] }, "pipeline": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "parties": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "timeline": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "sectors": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "documents": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "pipeline", "parties", "timeline", "sectors", "documents", "source_status", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/deals/business/{business}": { "get": { "operationId": "seer.v1.deals.business", "tags": [ "SeerDeals" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "party_role": { "type": "string" }, "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "asx_symbol": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "status", "stage", "party_role", "abn", "acn", "asx_symbol", "sector", "state", "postcode", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "total_count": { "type": "integer" }, "active_count": { "type": "integer" }, "latest_event_date": { "type": [ "string", "null" ] }, "source_count": { "type": "integer" }, "matched_business_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] } }, "required": [ "available", "status", "total_count", "active_count", "latest_event_date", "source_count", "matched_business_count" ] }, "pipeline": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "parties": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "timeline": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "sectors": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "documents": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "array", "items": [] }, "business_match_where": { "type": "string" } }, "required": [ "tables", "business_match_where" ] } }, "required": [ "filters", "summary", "pipeline", "parties", "timeline", "sectors", "documents", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "status": { "type": "string" }, "stage": { "type": "string" }, "party_role": { "type": "string" }, "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "asx_symbol": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "status", "stage", "party_role", "abn", "acn", "asx_symbol", "sector", "state", "postcode", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "total_count": { "type": "integer", "enum": [ 0 ] }, "active_count": { "type": "integer", "enum": [ 0 ] }, "latest_event_date": { "type": "null" }, "matched_business_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "total_count", "active_count", "latest_event_date", "matched_business_count" ] }, "pipeline": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "parties": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "timeline": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "sectors": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "documents": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable.", "Official source data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "pipeline", "parties", "timeline", "sectors", "documents", "source_status", "diagnostics" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/deals/sources/status": { "get": { "operationId": "seer.v1.deals.sources.status", "tags": [ "SeerDeals" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Official source data unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/graph/business/{business}": { "get": { "operationId": "seer.v1.graph.business", "tags": [ "SeerGraph" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 240 } }, { "name": "max_edges", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 20, "maximum": 600 } }, { "name": "include_debug", "in": "query", "schema": { "type": [ "boolean", "null" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "target_business": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "Selected business" ] } ] }, "abn": { "type": [ "string", "null" ] }, "acn": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "suburb": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "abn", "acn", "state", "suburb", "postcode" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Relationship intelligence facts are not available for this business yet." ] }, "business_id": { "type": "integer" }, "relationship_count": { "type": "integer" }, "node_count": { "type": "integer" }, "edge_count": { "type": "integer" }, "hidden_company_cluster_count": { "type": "integer" }, "director_ecosystem_count": { "type": "integer" }, "shared_infrastructure_count": { "type": "integer" }, "political_exposure_count": { "type": "integer" }, "competitor_ownership_web_count": { "type": "integer" }, "franchise_relationship_count": { "type": "integer" }, "supply_chain_dependency_count": { "type": "integer" }, "acquisition_opportunity_count": { "type": "integer" } }, "required": [ "available", "status", "message", "business_id", "relationship_count", "node_count", "edge_count", "hidden_company_cluster_count", "director_ecosystem_count", "shared_infrastructure_count", "political_exposure_count", "competitor_ownership_web_count", "franchise_relationship_count", "supply_chain_dependency_count", "acquisition_opportunity_count" ] }, "influence_graph": { "type": "object", "properties": { "linked": { "type": "string" }, "nodes": { "type": "array", "items": [] }, "edges": { "type": "array", "items": [] }, "relationship_breakdown": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "integer", "minimum": 0 } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "linked", "nodes", "edges", "relationship_breakdown" ] }, "hidden_company_clusters": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No hidden company clusters are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "director_ecosystems": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No director ecosystem facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "shared_infrastructure": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No shared infrastructure facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "competitor_ownership_webs": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No competitor ownership web facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "franchise_relationships": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No franchise relationship facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "supply_chain_dependencies": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No supply-chain dependency facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "political_business_relationships": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No political exposure found for this target." ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "summary", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_identity" ] }, "message": { "type": "string", "enum": [ "Political exposure checks need a matched ABN for this target." ] }, "summary": { "type": "object", "properties": { "count_total": { "type": "integer", "enum": [ 0 ] }, "count_as_donor": { "type": "integer", "enum": [ 0 ] }, "count_as_recipient": { "type": "integer", "enum": [ 0 ] }, "count_recent": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "number", "enum": [ 0 ] }, "total_amount_recent": { "type": "number", "enum": [ 0 ] } }, "required": [ "count_total", "count_as_donor", "count_as_recipient", "count_recent", "total_amount", "total_amount_recent" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "summary", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Political exposure facts are unavailable." ] }, "summary": { "type": "object", "properties": { "count_total": { "type": "integer", "enum": [ 0 ] }, "count_as_donor": { "type": "integer", "enum": [ 0 ] }, "count_as_recipient": { "type": "integer", "enum": [ 0 ] }, "count_recent": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "number", "enum": [ 0 ] }, "total_amount_recent": { "type": "number", "enum": [ 0 ] } }, "required": [ "count_total", "count_as_donor", "count_as_recipient", "count_recent", "total_amount", "total_amount_recent" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "summary", "rows" ] } ] }, "acquisition_opportunities": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No adjacent acquisition opportunity facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "rows": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "relationship_graph" ] }, "available": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Relationship graph facts are unavailable." ] } }, "required": [ "source_key", "available", "status", "message" ] }, { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "key_people" ] }, "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Key-people graph facts are unavailable." ] } }, "required": [ "source_key", "available", "status", "message" ] }, { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "shared_infrastructure" ] }, "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Shared infrastructure facts are unavailable." ] } }, "required": [ "source_key", "available", "status", "message" ] }, { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "political_exposure" ] }, "available": { "type": "boolean" }, "status": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "available" ] } ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "source_key", "available", "status", "message" ] }, { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "deal_activity" ] }, "available": { "type": "boolean" }, "status": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "available" ] } ] }, "message": { "type": [ "string", "null" ], "enum": [ "Deal activity facts are unavailable." ] } }, "required": [ "source_key", "available", "status", "message" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "available", "status", "rows" ] }, "debug": { "type": "object", "properties": { "limits": { "type": "object", "properties": { "limit": { "type": "integer" }, "max_edges": { "type": "integer" } }, "required": [ "limit", "max_edges" ] }, "source_flags": { "anyOf": [ { "type": "object", "properties": { "wikidata": { "type": "boolean" }, "web_intelligence": { "type": "boolean" } }, "required": [ "wikidata", "web_intelligence" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "limits", "source_flags" ] } }, "required": [ "generated_at", "target_business", "summary", "influence_graph", "hidden_company_clusters", "director_ecosystems", "shared_infrastructure", "competitor_ownership_webs", "franchise_relationships", "supply_chain_dependencies", "political_business_relationships", "acquisition_opportunities", "source_status", "debug" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/graph/business/{business}/shared-infrastructure": { "get": { "operationId": "seer.v1.graph.business.shared_infrastructure", "tags": [ "SeerGraph" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No shared infrastructure facts are available for this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/graph/business/{business}/political-exposure": { "get": { "operationId": "seer.v1.graph.business.political_exposure", "tags": [ "SeerGraph" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No political exposure found for this target." ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "summary", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_identity" ] }, "message": { "type": "string", "enum": [ "Political exposure checks need a matched ABN for this target." ] }, "summary": { "type": "object", "properties": { "count_total": { "type": "integer", "enum": [ 0 ] }, "count_as_donor": { "type": "integer", "enum": [ 0 ] }, "count_as_recipient": { "type": "integer", "enum": [ 0 ] }, "count_recent": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "number", "enum": [ 0 ] }, "total_amount_recent": { "type": "number", "enum": [ 0 ] } }, "required": [ "count_total", "count_as_donor", "count_as_recipient", "count_recent", "total_amount", "total_amount_recent" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "summary", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Political exposure facts are unavailable." ] }, "summary": { "type": "object", "properties": { "count_total": { "type": "integer", "enum": [ 0 ] }, "count_as_donor": { "type": "integer", "enum": [ 0 ] }, "count_as_recipient": { "type": "integer", "enum": [ 0 ] }, "count_recent": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "number", "enum": [ 0 ] }, "total_amount_recent": { "type": "number", "enum": [ 0 ] } }, "required": [ "count_total", "count_as_donor", "count_as_recipient", "count_recent", "total_amount", "total_amount_recent" ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "summary", "rows" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/graph/directors/{person}/businesses": { "get": { "operationId": "seer.v1.graph.directors.businesses", "tags": [ "SeerGraph" ], "parameters": [ { "name": "person", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No connected business appointments are available for this director." ] }, "person": { "anyOf": [ { "type": "object", "properties": { "person_id": { "type": "integer" }, "display_name": { "type": [ "string", "null" ] }, "confidence_tier": { "type": [ "string", "null" ] }, "entity_count": { "type": "integer" }, "company_count": { "type": "integer" }, "charity_count": { "type": "integer" } }, "required": [ "person_id", "display_name", "confidence_tier", "entity_count", "company_count", "charity_count" ] }, { "type": "object", "properties": { "person_id": { "type": "integer" } }, "required": [ "person_id" ] } ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "person", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_identity" ] }, "message": { "type": [ "string", "null" ], "enum": [ "A valid person id is required." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/gtm/opportunities": { "get": { "operationId": "seer.v1.gtm.opportunities", "tags": [ "SeerGtm" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "q": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "suburb": { "type": "string" }, "sector": { "type": "string" }, "segment": { "type": "string" }, "min_score": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "q", "state", "postcode", "suburb", "sector", "segment", "min_score", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "prospect_count": { "type": "integer" }, "high_priority_count": { "type": "integer" }, "average_score": { "anyOf": [ { "type": "number" }, { "type": "integer", "enum": [ 0 ] } ] }, "top_segments": { "type": "array", "items": [] } }, "required": [ "available", "status", "prospect_count", "high_priority_count", "average_score", "top_segments" ] }, "prospects": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "null" }, { "type": "integer" }, { "type": "number" } ] }, "name": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "Unknown business" ] } ] }, "account_name": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "Unknown business" ] } ] }, "contact_name": { "type": "null" }, "email": { "type": [ "string", "null" ] }, "phone": { "type": "null" }, "mobile": { "type": "null" }, "website": { "type": [ "string", "null" ] }, "domain": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "suburb": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, "source_provider": { "type": "string", "enum": [ "seer_data" ] }, "source_type": { "type": "string", "enum": [ "seer_gtm_opportunity" ] }, "source_ref": { "type": "string" }, "source_business_id": { "type": [ "integer", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "gtm_score": { "type": "number" }, "score_band": { "type": "string", "enum": [ "urgent", "high", "medium", "watch" ] }, "pitch_angle": { "type": "string" }, "opportunity_tags": { "type": "array", "items": [] }, "opportunity_rationale": { "type": "array", "items": [] }, "risk_rationale": { "type": "array", "items": [] }, "score_components": { "type": "array", "items": [] }, "evidence": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Digital maturity score" ] }, "value": { "type": "number" }, "source": { "type": "string", "enum": [ "web intelligence metrics" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Authority score" ] }, "value": { "type": "number" }, "source": { "type": "string", "enum": [ "web intelligence metrics" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Web risk score" ] }, "value": { "type": "number" }, "source": { "type": "string", "enum": [ "web intelligence metrics" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "SSL status" ] }, "value": { "type": "string", "enum": [ "invalid" ] }, "source": { "type": "string", "enum": [ "web crawl" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Indexed/crawled page count" ] }, "value": { "type": [ "object", "null" ] }, "source": { "type": "string", "enum": [ "web crawl" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Paid pixel / conversion gap" ] }, "value": { "type": "string", "enum": [ "present" ] }, "source": { "type": "string", "enum": [ "analytics identifiers and crawl structure" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Hiring/team signals" ] }, "value": { "type": "string" }, "source": { "type": "string", "enum": [ "web crawl" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Government contracts/grants" ] }, "value": { "type": "number" }, "source": { "type": "string", "enum": [ "government demand facts" ] } }, "required": [ "label", "value", "source" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Latest signal" ] }, "value": { "type": "string" }, "source": { "type": "string", "enum": [ "signal events" ] } }, "required": [ "label", "value", "source" ] } ] } }, "competitor_comparison": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "not_materialized" ] }, "message": { "type": "string", "enum": [ "Competitor comparison can be layered from local peer facts after this shortlist is created." ] } }, "required": [ "available", "status", "message" ] } }, "required": [ "id", "name", "account_name", "contact_name", "email", "phone", "mobile", "website", "domain", "state", "suburb", "postcode", "abn", "acn", "source_provider", "source_type", "source_ref", "source_business_id", "freshness_at", "gtm_score", "score_band", "pitch_angle", "opportunity_tags", "opportunity_rationale", "risk_rationale", "score_components", "evidence", "competitor_comparison" ] } }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "source_key": { "type": "string" }, "source_label": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "missing" ] }, "role": { "type": "string", "enum": [ "optional" ] } }, "required": [ "source_key", "source_label", "status", "role" ] }, { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "web_intelligence" ] }, "source_label": { "type": "string", "enum": [ "Web intelligence" ] }, "status": { "type": "string", "enum": [ "available" ] }, "role": { "type": "string", "enum": [ "required" ] } }, "required": [ "source_key", "source_label", "status", "role" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "GTM source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "generated_at": { "type": "string" }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "business_enrichment": { "type": "string" }, "web_domains": { "type": "string" }, "web_domain_company_links": { "type": "string" }, "web_domain_metrics": { "type": "string" }, "government_contracts": { "type": "string" }, "government_grants": { "type": "string" }, "regulated_finance": { "type": "string" }, "signal_events": { "type": "string" } }, "required": [ "business_enrichment", "web_domains", "web_domain_company_links", "web_domain_metrics", "government_contracts", "government_grants", "regulated_finance", "signal_events" ] }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "business_rows": { "type": "integer" }, "web_metric_rows": { "type": "integer" }, "optional_inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "table": { "type": "string" }, "available": { "type": "boolean" } }, "required": [ "key", "table", "available" ] } } }, "required": [ "business_rows", "web_metric_rows", "optional_inputs" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "GTM intelligence has not been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "GTM intelligence is unavailable because required analytics facts are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "GTM intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "filters", "summary", "prospects", "source_status", "generated_at", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "q": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "suburb": { "type": "string" }, "sector": { "type": "string" }, "segment": { "type": "string" }, "min_score": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "q", "state", "postcode", "suburb", "sector", "segment", "min_score", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "GTM intelligence unavailable.", "GTM intelligence has not been materialized yet." ] }, "prospect_count": { "type": "integer", "enum": [ 0 ] }, "high_priority_count": { "type": "integer", "enum": [ 0 ] }, "average_score": { "type": "integer", "enum": [ 0 ] }, "top_segments": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "prospect_count", "high_priority_count", "average_score", "top_segments" ] }, "prospects": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "GTM intelligence unavailable.", "GTM intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "generated_at": { "type": "string" }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "prospects", "source_status", "generated_at", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/gtm/sources/status": { "get": { "operationId": "seer.v1.gtm.sources.status", "tags": [ "SeerGtm" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "source_key": { "type": "string" }, "source_label": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "missing" ] }, "role": { "type": "string", "enum": [ "optional" ] } }, "required": [ "source_key", "source_label", "status", "role" ] }, { "type": "object", "properties": { "source_key": { "type": "string", "enum": [ "web_intelligence" ] }, "source_label": { "type": "string", "enum": [ "Web intelligence" ] }, "status": { "type": "string", "enum": [ "available" ] }, "role": { "type": "string", "enum": [ "required" ] } }, "required": [ "source_key", "source_label", "status", "role" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "GTM source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/industry-packs": { "get": { "operationId": "seer.v1.industry_packs.index", "tags": [ "SeerIndustryPack" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "limit": { "type": "integer" } }, "required": [ "state", "postcode", "q", "limit" ] }, "packs": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "available": { "type": "boolean" }, "status": { "type": "string" }, "generated_at": { "type": [ "string", "null" ] }, "summary": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "slug", "name", "available", "status", "generated_at", "summary", "source_status", "diagnostics" ] } } }, "required": [ "generated_at", "filters", "packs" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/industry-packs/{pack}": { "get": { "operationId": "seer.v1.industry_packs.show", "tags": [ "SeerIndustryPack" ], "parameters": [ { "name": "pack", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "pack": { "type": "string" }, "name": { "type": "string" }, "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "limit": { "type": "integer" } }, "required": [ "state", "postcode", "q", "limit" ] }, "summary": { "type": "array", "items": [] }, "ranked_items": { "type": "array", "items": [] }, "decision_lists": { "type": "string" }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "The required Seer facts are available, but no matching pack rows were found for the current filters.", "Live Seer facts were used for this pack. No fallback dataset was used." ] } }, "required": [ "message" ] }, "debug": { "type": [ "object", "null" ], "properties": { "tables": { "type": "object", "additionalProperties": { "type": "string" } }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "stale" ] }, "source_status": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "row_count": { "type": "integer", "enum": [ 0 ] }, "latest_ingested_at": { "type": "null" }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "table" ] }, { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "query_failed" ] }, "row_count": { "type": "integer", "enum": [ 0 ] }, "latest_ingested_at": { "type": "null" }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "table" ] } ] }, { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "row_count": { "type": [ "object", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "table" ] } ] }, { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "stale" ] }, "row_count": { "type": [ "object", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] }, "age_hours": { "type": [ "string", "null" ] }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "age_hours", "table" ] } ] } }, "diagnostics": { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string", "enum": [ "Required Seer facts could not be queried. No fallback data was used.", "Required Seer facts are unavailable, empty, or stale. No fallback data was used." ] }, { "type": "string", "enum": [ "Required Seer facts are current enough for this pack." ] } ] }, "missing_sources": { "type": "array", "items": [] }, "failed_sources": { "type": "array", "items": [] }, "empty_sources": { "type": "array", "items": [] }, "stale_sources": { "type": "array", "items": [] } }, "required": [ "message", "missing_sources", "failed_sources", "empty_sources", "stale_sources" ] } }, "required": [ "available", "status", "source_status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "source_status": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "The required Seer analytics source is unavailable. No fallback data was used." ] }, "missing_sources": { "type": "array", "items": [] }, "empty_sources": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "stale_sources": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "message", "missing_sources", "empty_sources", "stale_sources" ] } }, "required": [ "available", "status", "source_status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "available", "status", "pack", "name", "generated_at", "filters", "summary", "ranked_items", "decision_lists", "source_status", "diagnostics", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "pack": { "type": "string" }, "name": { "type": "string" }, "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "limit": { "type": "integer" } }, "required": [ "state", "postcode", "q", "limit" ] }, "summary": { "type": "object", "properties": { "ranked_item_count": { "type": "integer", "enum": [ 0 ] }, "decision_list_count": { "type": "integer", "enum": [ 0 ] }, "latest_source_at": { "type": "string" } }, "required": [ "ranked_item_count", "decision_list_count", "latest_source_at" ] }, "ranked_items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "decision_lists": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_status": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "diagnostics": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "enum": [ "The pack could not be assembled from the current Seer facts." ] } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Required Seer facts are unavailable. No fallback data was used." ] } }, "required": [ "message" ] } ] }, "debug": { "type": [ "object", "null" ], "properties": { "tables": { "type": "object", "additionalProperties": { "type": "string" } }, "readiness": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "query_failed" ] }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "The pack could not be assembled from the current Seer facts." ] } }, "required": [ "message" ] } }, "required": [ "available", "status", "source_status", "diagnostics" ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "available", "status", "pack", "name", "generated_at", "filters", "summary", "ranked_items", "decision_lists", "source_status", "diagnostics", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "pack": { "type": "string" }, "name": { "type": "string" }, "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "limit": { "type": "integer" } }, "required": [ "state", "postcode", "q", "limit" ] }, "summary": { "type": "object", "properties": { "ranked_item_count": { "type": "integer", "enum": [ 0 ] }, "decision_list_count": { "type": "integer", "enum": [ 0 ] }, "latest_source_at": { "type": "string" } }, "required": [ "ranked_item_count", "decision_list_count", "latest_source_at" ] }, "ranked_items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "decision_lists": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Required Seer facts are unavailable. No fallback data was used." ] } }, "required": [ "message" ] } ] }, "debug": { "type": [ "object", "null" ], "properties": { "tables": { "type": "object", "additionalProperties": { "type": "string" } }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "stale" ] }, "source_status": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "row_count": { "type": "integer", "enum": [ 0 ] }, "latest_ingested_at": { "type": "null" }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "table" ] }, { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "query_failed" ] }, "row_count": { "type": "integer", "enum": [ 0 ] }, "latest_ingested_at": { "type": "null" }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "table" ] } ] }, { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "row_count": { "type": [ "object", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "table" ] } ] }, { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean" }, "status": { "type": "string", "enum": [ "stale" ] }, "row_count": { "type": [ "object", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] }, "age_hours": { "type": [ "string", "null" ] }, "table": { "type": "string" } }, "required": [ "key", "label", "required", "status", "row_count", "latest_ingested_at", "age_hours", "table" ] } ] } }, "diagnostics": { "type": "object", "properties": { "message": { "anyOf": [ { "type": "string", "enum": [ "Required Seer facts could not be queried. No fallback data was used.", "Required Seer facts are unavailable, empty, or stale. No fallback data was used." ] }, { "type": "string", "enum": [ "Required Seer facts are current enough for this pack." ] } ] }, "missing_sources": { "type": "array", "items": [] }, "failed_sources": { "type": "array", "items": [] }, "empty_sources": { "type": "array", "items": [] }, "stale_sources": { "type": "array", "items": [] } }, "required": [ "message", "missing_sources", "failed_sources", "empty_sources", "stale_sources" ] } }, "required": [ "available", "status", "source_status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "source_status": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "The required Seer analytics source is unavailable. No fallback data was used." ] }, "missing_sources": { "type": "array", "items": [] }, "empty_sources": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "stale_sources": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "message", "missing_sources", "empty_sources", "stale_sources" ] } }, "required": [ "available", "status", "source_status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "available", "status", "pack", "name", "generated_at", "filters", "summary", "ranked_items", "decision_lists", "source_status", "diagnostics", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "not_found" ] }, "pack": { "type": "string" }, "generated_at": { "type": "string" }, "summary": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "ranked_items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "decision_lists": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_status": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "This Seer industry pack is not configured." ] } }, "required": [ "message" ] } }, "required": [ "available", "status", "pack", "generated_at", "summary", "ranked_items", "decision_lists", "source_status", "diagnostics" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/lifecycle": { "get": { "operationId": "seer.v1.lifecycle.index", "tags": [ "SeerLifecycle" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "lifecycle_state": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "trajectory": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "abn": { "type": "string" }, "acn": { "type": "string" }, "min_distress_probability": { "type": "number" }, "min_acquisition_readiness": { "type": "number" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lifecycle_state", "trajectory", "sector", "state", "postcode", "abn", "acn", "min_distress_probability", "min_acquisition_readiness", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "business_count": { "type": "integer" }, "average_health_score": { "type": "number" }, "average_distress_probability": { "type": "number" }, "average_acquisition_readiness": { "type": "number" }, "high_risk_count": { "type": "integer" }, "improving_count": { "type": "integer" }, "weakening_count": { "type": "integer" }, "latest_observed_date": { "type": [ "string", "null" ] } }, "required": [ "available", "status", "business_count", "average_health_score", "average_distress_probability", "average_acquisition_readiness", "high_risk_count", "improving_count", "weakening_count", "latest_observed_date" ] }, "results": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "state_distribution": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "features": { "type": "string" }, "snapshots": { "type": "string" }, "transitions": { "type": "string" }, "status": { "type": "string" } }, "required": [ "features", "snapshots", "transitions", "status" ] }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "snapshot_rows": { "type": "integer" }, "source_status_rows": { "type": "integer" }, "available_source_status_rows": { "type": "integer" } }, "required": [ "snapshot_rows", "source_status_rows", "available_source_status_rows" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Lifecycle intelligence has not been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Lifecycle intelligence is unavailable because lifecycle fact tables are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Lifecycle intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "filters", "summary", "results", "state_distribution", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "lifecycle_state": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "trajectory": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "abn": { "type": "string" }, "acn": { "type": "string" }, "min_distress_probability": { "type": "number" }, "min_acquisition_readiness": { "type": "number" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lifecycle_state", "trajectory", "sector", "state", "postcode", "abn", "acn", "min_distress_probability", "min_acquisition_readiness", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "business_id": { "type": "null" }, "lifecycle_state": { "type": "null" }, "trajectory_direction": { "type": "null" }, "state_confidence": { "type": "integer", "enum": [ 0 ] }, "transition_probability": { "type": "integer", "enum": [ 0 ] }, "health_score": { "type": "integer", "enum": [ 0 ] }, "closure_probability": { "type": "integer", "enum": [ 0 ] }, "distress_probability": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "business_id", "lifecycle_state", "trajectory_direction", "state_confidence", "transition_probability", "health_score", "closure_probability", "distress_probability" ] }, "trajectory": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "products": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "drivers": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "positive": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "negative": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "missing_signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "material_change_events": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "positive", "negative", "missing_signals", "material_change_events" ] }, "evidence": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "transitions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "trajectory", "products", "drivers", "evidence", "transitions", "source_status", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/lifecycle/business/{business}": { "get": { "operationId": "seer.v1.lifecycle.business", "tags": [ "SeerLifecycle" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "lifecycle_state": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "trajectory": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "abn": { "type": "string" }, "acn": { "type": "string" }, "min_distress_probability": { "type": "number" }, "min_acquisition_readiness": { "type": "number" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lifecycle_state", "trajectory", "sector", "state", "postcode", "abn", "acn", "min_distress_probability", "min_acquisition_readiness", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "business_id": { "type": "integer" }, "business_name": { "type": [ "string", "null" ] }, "observed_date": { "type": [ "string", "null" ] }, "lifecycle_state": { "type": [ "string", "null" ] }, "previous_lifecycle_state": { "type": [ "string", "null" ] }, "trajectory_direction": { "type": [ "string", "null" ] }, "state_confidence": { "type": "number" }, "transition_probability": { "type": "number" }, "time_in_state_days": { "type": "integer" }, "health_score": { "type": "number" }, "signal_coverage_score": { "type": "number" }, "closure_probability": { "type": "number" }, "distress_probability": { "type": "number" }, "industry_regime": { "type": [ "string", "null" ] }, "model_version": { "type": [ "string", "null" ] } }, "required": [ "available", "status", "business_id", "business_name", "observed_date", "lifecycle_state", "previous_lifecycle_state", "trajectory_direction", "state_confidence", "transition_probability", "time_in_state_days", "health_score", "signal_coverage_score", "closure_probability", "distress_probability", "industry_regime", "model_version" ] }, "trajectory": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No lifecycle trajectory snapshots matched this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "products": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "business_health_trajectory" ] }, "label": { "type": "string", "enum": [ "Business health trajectory" ] }, "score": { "type": "number" }, "direction": { "type": [ "string", "null" ] }, "interpretation": { "type": "string", "enum": [ "Materialized signals point to accelerating health and opportunity.", "Recent evidence points to improving operating posture.", "Recent evidence points to weakening operating posture.", "Recent evidence points to deteriorating health and rising risk.", "Recent evidence points to a newly actionable opportunity.", "Recent evidence points to a broadly stable posture." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "distress_probability" ] }, "label": { "type": "string", "enum": [ "Distress probability" ] }, "score": { "type": "number" }, "direction": { "type": "string", "enum": [ "risk" ] }, "interpretation": { "type": "string", "enum": [ "Probability of near-term operational stress based on materialized evidence." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "acquisition_readiness" ] }, "label": { "type": "string", "enum": [ "Acquisition readiness" ] }, "score": { "type": "number" }, "direction": { "type": "string", "enum": [ "opportunity" ] }, "interpretation": { "type": "string", "enum": [ "Fit for acquisition screening based on stability, growth, visibility, and risk posture." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "growth_acceleration" ] }, "label": { "type": "string", "enum": [ "Growth acceleration" ] }, "score": { "type": "number" }, "direction": { "type": "string", "enum": [ "opportunity" ] }, "interpretation": { "type": "string", "enum": [ "Recent momentum across demand, visibility, market, hiring, and operating signals." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "digital_stagnation" ] }, "label": { "type": "string", "enum": [ "Digital stagnation" ] }, "score": { "type": "number" }, "direction": { "type": "string", "enum": [ "risk" ] }, "interpretation": { "type": "string", "enum": [ "Web freshness, search demand, traffic, review, and digital-maintenance pressure." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "competitor_fatigue" ] }, "label": { "type": "string", "enum": [ "Competitor fatigue" ] }, "score": { "type": "number" }, "direction": { "type": "string", "enum": [ "opportunity" ] }, "interpretation": { "type": "string", "enum": [ "Relative weakening in nearby or watched competitors where evidence exists." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "closure_probability" ] }, "label": { "type": "string", "enum": [ "Closure probability" ] }, "score": { "type": "number" }, "direction": { "type": "string", "enum": [ "risk" ] }, "interpretation": { "type": "string", "enum": [ "Outcome probability, separated from lifecycle state." ] } }, "required": [ "key", "label", "score", "direction", "interpretation" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false } }, "required": [ "available", "status", "rows" ] }, "drivers": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "positive": { "type": "array", "items": [] }, "negative": { "type": "array", "items": [] }, "missing_signals": { "type": "array", "items": [] }, "material_change_events": { "type": "array", "items": [] } }, "required": [ "available", "status", "positive", "negative", "missing_signals", "material_change_events" ] }, "evidence": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No lifecycle feature evidence matched this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "transitions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "No lifecycle transitions matched this business." ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "features": { "type": "string" }, "snapshots": { "type": "string" }, "transitions": { "type": "string" }, "status": { "type": "string" } }, "required": [ "features", "snapshots", "transitions", "status" ] }, "business_match_where": { "type": "string" }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "snapshot_rows": { "type": "integer" }, "source_status_rows": { "type": "integer" }, "available_source_status_rows": { "type": "integer" } }, "required": [ "snapshot_rows", "source_status_rows", "available_source_status_rows" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Lifecycle intelligence has not been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Lifecycle intelligence is unavailable because lifecycle fact tables are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Lifecycle intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "business_match_where", "readiness" ] } }, "required": [ "filters", "summary", "trajectory", "products", "drivers", "evidence", "transitions", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "lifecycle_state": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "trajectory": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "abn": { "type": "string" }, "acn": { "type": "string" }, "min_distress_probability": { "type": "number" }, "min_acquisition_readiness": { "type": "number" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lifecycle_state", "trajectory", "sector", "state", "postcode", "abn", "acn", "min_distress_probability", "min_acquisition_readiness", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "business_id": { "type": "null" }, "lifecycle_state": { "type": "null" }, "trajectory_direction": { "type": "null" }, "state_confidence": { "type": "integer", "enum": [ 0 ] }, "transition_probability": { "type": "integer", "enum": [ 0 ] }, "health_score": { "type": "integer", "enum": [ 0 ] }, "closure_probability": { "type": "integer", "enum": [ 0 ] }, "distress_probability": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "business_id", "lifecycle_state", "trajectory_direction", "state_confidence", "transition_probability", "health_score", "closure_probability", "distress_probability" ] }, "trajectory": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "products": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "drivers": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "positive": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "negative": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "missing_signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "material_change_events": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "positive", "negative", "missing_signals", "material_change_events" ] }, "evidence": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "transitions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "diagnostics": { "type": "array", "items": [] } }, "required": [ "filters", "summary", "trajectory", "products", "drivers", "evidence", "transitions", "source_status", "diagnostics" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "lifecycle_state": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "trajectory": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "abn": { "type": "string" }, "acn": { "type": "string" }, "min_distress_probability": { "type": "number" }, "min_acquisition_readiness": { "type": "number" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "lifecycle_state", "trajectory", "sector", "state", "postcode", "abn", "acn", "min_distress_probability", "min_acquisition_readiness", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "business_id": { "type": "null" }, "lifecycle_state": { "type": "null" }, "trajectory_direction": { "type": "null" }, "state_confidence": { "type": "integer", "enum": [ 0 ] }, "transition_probability": { "type": "integer", "enum": [ 0 ] }, "health_score": { "type": "integer", "enum": [ 0 ] }, "closure_probability": { "type": "integer", "enum": [ 0 ] }, "distress_probability": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "business_id", "lifecycle_state", "trajectory_direction", "state_confidence", "transition_probability", "health_score", "closure_probability", "distress_probability" ] }, "trajectory": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "products": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "drivers": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "positive": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "negative": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "missing_signals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "material_change_events": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "positive", "negative", "missing_signals", "material_change_events" ] }, "evidence": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "transitions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle intelligence unavailable.", "Lifecycle intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "trajectory", "products", "drivers", "evidence", "transitions", "source_status", "diagnostics" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/lifecycle/sources/status": { "get": { "operationId": "seer.v1.lifecycle.sources.status", "tags": [ "SeerLifecycle" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Lifecycle source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/business/{business}": { "get": { "operationId": "seer.v1.market.business", "tags": [ "SeerMarket" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_id": { "type": "integer" }, "summary": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "null" }, "latest_trade_date": { "type": [ "string", "null" ] }, "matched_sector_count": { "type": "integer" }, "weighted_return_20d": { "type": [ "number", "null" ] }, "weighted_return_90d": { "type": [ "number", "null" ] }, "weighted_volatility_20d": { "type": [ "number", "null" ] }, "weighted_drawdown_252d": { "type": [ "number", "null" ] }, "weighted_price_vs_sma_200": { "type": [ "number", "null" ] }, "market_regime": { "type": "string" }, "is_listed": { "type": "boolean" }, "symbol": { "type": "string" }, "sector_name": { "type": "string" }, "industry_group": { "type": "string" }, "configured_focus_sectors": { "type": "array", "items": { "type": "string" } }, "resolved_focus_sectors": { "type": "array", "items": { "type": "array", "items": [] } }, "focus_sector_source": { "type": "string", "enum": [ "context", "unavailable", "matched", "explicit" ] }, "trend_regime": { "type": "string" }, "volatility_regime": { "type": "string" }, "dividend_regime": { "type": "string" }, "match_confidence": { "type": [ "number", "null" ] }, "market_risk_score": { "type": [ "number", "null" ] }, "market_opportunity_score": { "type": [ "number", "null" ] }, "stress_label": { "type": "string" }, "growth_mode": { "type": "integer" }, "distress_mode": { "type": "integer" }, "restructuring_mode": { "type": "integer" }, "capital_raise_pressure": { "type": "integer" }, "consolidation_likelihood": { "type": "integer" }, "lifecycle_state": { "type": "string" }, "trajectory_label": { "type": "string" }, "lifecycle_confidence_score": { "type": [ "number", "null" ] }, "overheated_flag": { "type": "integer" }, "market_event_flag": { "type": "integer" }, "economic_pulse_label": { "type": "string" }, "economic_pulse_score": { "type": [ "number", "null" ] }, "return_1m": { "type": [ "number", "null" ] }, "return_3m": { "type": [ "number", "null" ] }, "return_12m": { "type": [ "number", "null" ] }, "return_5y": { "type": [ "number", "null" ] }, "volatility_20d": { "type": [ "number", "null" ] }, "drawdown_252d": { "type": [ "number", "null" ] }, "price_vs_sma_200": { "type": [ "number", "null" ] }, "dividend_trailing_12m": { "type": [ "number", "null" ] }, "inflation_signal": { "type": "object", "additionalProperties": [] }, "national_inflation_signal": { "type": "object", "additionalProperties": [] }, "postcode_commercial_weather_label": { "type": "string" }, "explainers": { "type": "array", "items": [] }, "matched_sectors": { "type": "array", "items": { "type": "array", "items": [] } }, "business_market_context": { "type": [ "object", "null" ], "additionalProperties": [] }, "business_market_risk": { "type": [ "object", "null" ], "additionalProperties": [] }, "business_lifecycle_score": { "type": [ "object", "null" ], "additionalProperties": [] }, "business_lifecycle_state": { "type": [ "object", "null" ], "additionalProperties": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "enum": [ "Market context models" ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Business market risk score" ] }, "summary": { "type": "string", "enum": [ "This score blends security stress, sector stress, postcode pressure, and macro pressure into a 0-100 commercial risk read, with inflation resolved to a capital-city proxy when Seer can localise the business." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Listed-business formula" ] }, "formula": { "type": "string", "enum": [ "market_risk_score = security_stress * listed.security_stress + sector_stress * listed.sector_stress + postcode_weather * listed.postcode_weather + macro_pressure * listed.macro_pressure" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "security_stress_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "sector_stress_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "postcode_weather_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_pressure_component" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "macro_pressure_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_scope_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_value" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "national_inflation_value" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market risk fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "market_risk_score" ] }, { "type": "string", "enum": [ "security_stress_component" ] }, { "type": "string", "enum": [ "sector_stress_component" ] }, { "type": "string", "enum": [ "postcode_weather_component" ] }, { "type": "string", "enum": [ "inflation_pressure_component" ] }, { "type": "string", "enum": [ "macro_pressure_component" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "return_1m" ] }, { "type": "string", "enum": [ "return_12m" ] }, { "type": "string", "enum": [ "volatility_20d" ] }, { "type": "string", "enum": [ "drawdown_252d" ] }, { "type": "string", "enum": [ "price_vs_sma_200" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] }, { "type": "string", "enum": [ "national_inflation_value" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Private-business fallback" ] }, "formula": { "type": "string", "enum": [ "market_risk_score = sector_stress * private.sector_stress + postcode_exposure_stress * private.postcode_exposure_stress + local_seer_commercial_stress * private.local_seer_commercial_stress + macro_pressure * private.macro_pressure" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private sector_stress weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private postcode_exposure_stress weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private local_seer_commercial_stress weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private macro_pressure weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "formula", "inputs" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Opportunity and posture" ] }, "formula": { "type": "string", "enum": [ "market_opportunity_score, stress_label, and posture flags are read from the latest Seer market-risk row for this business." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "market_opportunity_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stress_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "growth_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "distress_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "restructuring_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "capital_raise_pressure" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "consolidation_likelihood" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market risk fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "market_opportunity_score" ] }, { "type": "string", "enum": [ "stress_label" ] }, { "type": "string", "enum": [ "growth_mode" ] }, { "type": "string", "enum": [ "distress_mode" ] }, { "type": "string", "enum": [ "restructuring_mode" ] }, { "type": "string", "enum": [ "capital_raise_pressure" ] }, { "type": "string", "enum": [ "consolidation_likelihood" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Lifecycle state" ] }, "summary": { "type": "string", "enum": [ "Lifecycle scores classify each business into a stage and trajectory using growth, stability, stress, governance, market, expansion, and failure components." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle score inputs" ] }, "formula": { "type": "string", "enum": [ "Growth, stability, stress, governance, market, expansion, and failure scores are combined, then classified into state + trajectory with confidence." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "growth_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stability_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stress_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "governance_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "market_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "expansion_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "failure_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "confidence_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "lifecycle_state" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trajectory_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 10, "maxItems": 10, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle scores fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "growth_score" ] }, { "type": "string", "enum": [ "stability_score" ] }, { "type": "string", "enum": [ "stress_score" ] }, { "type": "string", "enum": [ "governance_score" ] }, { "type": "string", "enum": [ "market_score" ] }, { "type": "string", "enum": [ "expansion_score" ] }, { "type": "string", "enum": [ "failure_score" ] }, { "type": "string", "enum": [ "confidence_score" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle states fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "lifecycle_state" ] }, { "type": "string", "enum": [ "trajectory_label" ] }, { "type": "string", "enum": [ "overheated_flag" ] }, { "type": "string", "enum": [ "market_event_flag" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Trading regimes" ] }, "formula": { "type": "string", "enum": [ "trend_regime, volatility_regime, and dividend_regime are read directly from the business market context row and used to label posture." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trend_regime" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "volatility_regime" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "dividend_regime" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "return_1m" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "return_12m" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "price_vs_sma_200" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "volatility_20d" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "dividend_trailing_12m" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_scope_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_value" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 10, "maxItems": 10, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "trend_regime" ] }, { "type": "string", "enum": [ "volatility_regime" ] }, { "type": "string", "enum": [ "dividend_regime" ] }, { "type": "string", "enum": [ "return_1m" ] }, { "type": "string", "enum": [ "return_12m" ] }, { "type": "string", "enum": [ "price_vs_sma_200" ] }, { "type": "string", "enum": [ "volatility_20d" ] }, { "type": "string", "enum": [ "dividend_trailing_12m" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] }, { "type": "string", "enum": [ "inflation_fallback_applied" ] } ], "minItems": 11, "maxItems": 11, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Sector matching and local pulse" ] }, "summary": { "type": "string", "enum": [ "When no direct listed match exists, Seer falls back to weighted sector matches and local pulse overlays." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Matched sectors" ] }, "formula": { "type": "string", "enum": [ "Weighted sector metrics are aggregated from the matched sector list for this business." ] }, "inputs": { "type": "array", "items": [] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Sector market health fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "sector_name" ] }, { "type": "string", "enum": [ "avg_return_20d" ] }, { "type": "string", "enum": [ "avg_return_90d" ] }, { "type": "string", "enum": [ "sector_stress_score" ] }, { "type": "string", "enum": [ "sector_opportunity_score" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business/sector match fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "business_id" ] }, { "type": "string", "enum": [ "symbol" ] }, { "type": "string", "enum": [ "sector_name" ] }, { "type": "string", "enum": [ "match_type" ] }, { "type": "string", "enum": [ "match_confidence" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Economic pulse" ] }, "formula": { "type": "string", "enum": [ "Pulse blends sector momentum, stress, macro pressure, lifecycle pressure, and market breadth." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "pulse_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "momentum_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stress_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "macro_pressure_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "lifecycle_pressure_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "breadth_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 6, "maxItems": 6, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Economic pulse fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "pulse_score" ] }, { "type": "string", "enum": [ "momentum_score" ] }, { "type": "string", "enum": [ "stress_score" ] }, { "type": "string", "enum": [ "macro_pressure_score" ] }, { "type": "string", "enum": [ "lifecycle_pressure_score" ] }, { "type": "string", "enum": [ "breadth_score" ] } ], "minItems": 6, "maxItems": 6, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Macro daily fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "series_key" ] }, { "type": "string", "enum": [ "value" ] }, { "type": "string", "enum": [ "trade_date" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Explainers and local weather" ] }, "formula": { "type": "string", "enum": [ "The dashboard explainers and postcode commercial weather label are attached from the latest business market context and commercial weather rows." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "postcode_commercial_weather_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "explainers" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "postcode_commercial_weather_label" ] }, { "type": "string", "enum": [ "explainers_json" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Commercial weather fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "scope_type" ] }, { "type": "string", "enum": [ "scope_key" ] }, { "type": "string", "enum": [ "weather_label" ] }, { "type": "string", "enum": [ "composite_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "sections" ] } }, "required": [ "available", "reason", "latest_trade_date", "matched_sector_count", "weighted_return_20d", "weighted_return_90d", "weighted_volatility_20d", "weighted_drawdown_252d", "weighted_price_vs_sma_200", "market_regime", "is_listed", "symbol", "sector_name", "industry_group", "configured_focus_sectors", "resolved_focus_sectors", "focus_sector_source", "trend_regime", "volatility_regime", "dividend_regime", "match_confidence", "market_risk_score", "market_opportunity_score", "stress_label", "growth_mode", "distress_mode", "restructuring_mode", "capital_raise_pressure", "consolidation_likelihood", "lifecycle_state", "trajectory_label", "lifecycle_confidence_score", "overheated_flag", "market_event_flag", "economic_pulse_label", "economic_pulse_score", "return_1m", "return_3m", "return_12m", "return_5y", "volatility_20d", "drawdown_252d", "price_vs_sma_200", "dividend_trailing_12m", "inflation_signal", "national_inflation_signal", "postcode_commercial_weather_label", "explainers", "matched_sectors", "business_market_context", "business_market_risk", "business_lifecycle_score", "business_lifecycle_state", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "no_market_context" ] }, "latest_trade_date": { "type": "null" }, "matched_sector_count": { "type": "integer", "enum": [ 0 ] }, "weighted_return_20d": { "type": "null" }, "weighted_return_90d": { "type": "null" }, "weighted_volatility_20d": { "type": "null" }, "weighted_drawdown_252d": { "type": "null" }, "weighted_price_vs_sma_200": { "type": "null" }, "market_regime": { "type": "string", "enum": [ "unavailable" ] }, "is_listed": { "type": "boolean" }, "symbol": { "type": "null" }, "sector_name": { "type": "null" }, "industry_group": { "type": "null" }, "configured_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "resolved_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "focus_sector_source": { "type": "string", "enum": [ "unavailable" ] }, "trend_regime": { "type": "null" }, "volatility_regime": { "type": "null" }, "dividend_regime": { "type": "null" }, "match_confidence": { "type": "null" }, "market_risk_score": { "type": "null" }, "market_opportunity_score": { "type": "null" }, "stress_label": { "type": "string", "enum": [ "unavailable" ] }, "growth_mode": { "type": "integer", "enum": [ 0 ] }, "distress_mode": { "type": "integer", "enum": [ 0 ] }, "restructuring_mode": { "type": "integer", "enum": [ 0 ] }, "capital_raise_pressure": { "type": "integer", "enum": [ 0 ] }, "consolidation_likelihood": { "type": "integer", "enum": [ 0 ] }, "lifecycle_state": { "type": "null" }, "trajectory_label": { "type": "null" }, "lifecycle_confidence_score": { "type": "null" }, "overheated_flag": { "type": "integer", "enum": [ 0 ] }, "market_event_flag": { "type": "integer", "enum": [ 0 ] }, "economic_pulse_label": { "type": "null" }, "economic_pulse_score": { "type": "null" }, "return_1m": { "type": "null" }, "return_3m": { "type": "null" }, "return_12m": { "type": "null" }, "return_5y": { "type": "null" }, "volatility_20d": { "type": "null" }, "drawdown_252d": { "type": "null" }, "price_vs_sma_200": { "type": "null" }, "dividend_trailing_12m": { "type": "null" }, "inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "null" }, "scope_key": { "type": "null" }, "scope_label": { "type": "null" }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "national_inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "string", "enum": [ "national" ] }, "scope_key": { "type": "string", "enum": [ "AU" ] }, "scope_label": { "type": "string", "enum": [ "Australia" ] }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "postcode_commercial_weather_label": { "type": "string", "enum": [ "unavailable" ] }, "explainers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "matched_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "business_market_context": { "type": "null" }, "business_market_risk": { "type": "null" }, "business_lifecycle_score": { "type": "null" }, "business_lifecycle_state": { "type": "null" } }, "required": [ "available", "reason", "latest_trade_date", "matched_sector_count", "weighted_return_20d", "weighted_return_90d", "weighted_volatility_20d", "weighted_drawdown_252d", "weighted_price_vs_sma_200", "market_regime", "is_listed", "symbol", "sector_name", "industry_group", "configured_focus_sectors", "resolved_focus_sectors", "focus_sector_source", "trend_regime", "volatility_regime", "dividend_regime", "match_confidence", "market_risk_score", "market_opportunity_score", "stress_label", "growth_mode", "distress_mode", "restructuring_mode", "capital_raise_pressure", "consolidation_likelihood", "lifecycle_state", "trajectory_label", "lifecycle_confidence_score", "overheated_flag", "market_event_flag", "economic_pulse_label", "economic_pulse_score", "return_1m", "return_3m", "return_12m", "return_5y", "volatility_20d", "drawdown_252d", "price_vs_sma_200", "dividend_trailing_12m", "inflation_signal", "national_inflation_signal", "postcode_commercial_weather_label", "explainers", "matched_sectors", "business_market_context", "business_market_risk", "business_lifecycle_score", "business_lifecycle_state" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "clickhouse_disabled" ] }, "latest_trade_date": { "type": "null" }, "matched_sector_count": { "type": "integer", "enum": [ 0 ] }, "weighted_return_20d": { "type": "null" }, "weighted_return_90d": { "type": "null" }, "weighted_volatility_20d": { "type": "null" }, "weighted_drawdown_252d": { "type": "null" }, "weighted_price_vs_sma_200": { "type": "null" }, "market_regime": { "type": "string", "enum": [ "unavailable" ] }, "is_listed": { "type": "boolean" }, "symbol": { "type": "null" }, "sector_name": { "type": "null" }, "industry_group": { "type": "null" }, "configured_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "resolved_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "focus_sector_source": { "type": "string", "enum": [ "unavailable" ] }, "trend_regime": { "type": "null" }, "volatility_regime": { "type": "null" }, "dividend_regime": { "type": "null" }, "match_confidence": { "type": "null" }, "market_risk_score": { "type": "null" }, "market_opportunity_score": { "type": "null" }, "stress_label": { "type": "string", "enum": [ "unavailable" ] }, "growth_mode": { "type": "integer", "enum": [ 0 ] }, "distress_mode": { "type": "integer", "enum": [ 0 ] }, "restructuring_mode": { "type": "integer", "enum": [ 0 ] }, "capital_raise_pressure": { "type": "integer", "enum": [ 0 ] }, "consolidation_likelihood": { "type": "integer", "enum": [ 0 ] }, "lifecycle_state": { "type": "null" }, "trajectory_label": { "type": "null" }, "lifecycle_confidence_score": { "type": "null" }, "overheated_flag": { "type": "integer", "enum": [ 0 ] }, "market_event_flag": { "type": "integer", "enum": [ 0 ] }, "economic_pulse_label": { "type": "null" }, "economic_pulse_score": { "type": "null" }, "return_1m": { "type": "null" }, "return_3m": { "type": "null" }, "return_12m": { "type": "null" }, "return_5y": { "type": "null" }, "volatility_20d": { "type": "null" }, "drawdown_252d": { "type": "null" }, "price_vs_sma_200": { "type": "null" }, "dividend_trailing_12m": { "type": "null" }, "inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "null" }, "scope_key": { "type": "null" }, "scope_label": { "type": "null" }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "national_inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "string", "enum": [ "national" ] }, "scope_key": { "type": "string", "enum": [ "AU" ] }, "scope_label": { "type": "string", "enum": [ "Australia" ] }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "postcode_commercial_weather_label": { "type": "string", "enum": [ "unavailable" ] }, "explainers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "matched_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "business_market_context": { "type": "null" }, "business_market_risk": { "type": "null" }, "business_lifecycle_score": { "type": "null" }, "business_lifecycle_state": { "type": "null" } }, "required": [ "available", "reason", "latest_trade_date", "matched_sector_count", "weighted_return_20d", "weighted_return_90d", "weighted_volatility_20d", "weighted_drawdown_252d", "weighted_price_vs_sma_200", "market_regime", "is_listed", "symbol", "sector_name", "industry_group", "configured_focus_sectors", "resolved_focus_sectors", "focus_sector_source", "trend_regime", "volatility_regime", "dividend_regime", "match_confidence", "market_risk_score", "market_opportunity_score", "stress_label", "growth_mode", "distress_mode", "restructuring_mode", "capital_raise_pressure", "consolidation_likelihood", "lifecycle_state", "trajectory_label", "lifecycle_confidence_score", "overheated_flag", "market_event_flag", "economic_pulse_label", "economic_pulse_score", "return_1m", "return_3m", "return_12m", "return_5y", "volatility_20d", "drawdown_252d", "price_vs_sma_200", "dividend_trailing_12m", "inflation_signal", "national_inflation_signal", "postcode_commercial_weather_label", "explainers", "matched_sectors", "business_market_context", "business_market_risk", "business_lifecycle_score", "business_lifecycle_state" ] } ] }, "market_context": { "type": [ "string", "null" ] }, "market_risk": { "type": [ "string", "null" ] }, "inflation_signal": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "null" }, "scope_key": { "type": "null" }, "scope_label": { "type": "null" }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] } ] }, "national_inflation_signal": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "string", "enum": [ "national" ] }, "scope_key": { "type": "string", "enum": [ "AU" ] }, "scope_label": { "type": "string", "enum": [ "Australia" ] }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] } ] }, "postcode_sector_exposure": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "commercial_weather": { "type": [ "object", "null" ], "additionalProperties": [] }, "ownership_proxy": { "type": [ "object", "null" ], "additionalProperties": [] }, "economic_pulse": { "type": [ "object", "null" ], "additionalProperties": [] }, "lifecycle_score": { "type": [ "object", "null" ], "additionalProperties": [] }, "lifecycle_state": { "type": [ "object", "null" ], "additionalProperties": [] }, "lifecycle_transitions": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "company_event_signals": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "business_id", "summary", "market_context", "market_risk", "inflation_signal", "national_inflation_signal", "postcode_sector_exposure", "commercial_weather", "ownership_proxy", "economic_pulse", "lifecycle_score", "lifecycle_state", "lifecycle_transitions", "company_event_signals" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/postcodes/{postcode}": { "get": { "operationId": "seer.v1.market.postcode", "tags": [ "SeerMarket" ], "parameters": [ { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": { "type": "string" }, "postcode_sector_exposure": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "commercial_weather": { "type": [ "object", "null" ], "additionalProperties": [] }, "ownership_proxy": { "type": [ "object", "null" ], "additionalProperties": [] }, "economic_pulse": { "type": [ "object", "null" ], "additionalProperties": [] }, "lifecycle_distribution": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "brief": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "postcode" ] }, "scope_key": { "type": "string" }, "headline": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "Postcode market brief" ] } ] }, "summary": { "type": "string" }, "bullets": { "type": "array", "items": [] } }, "required": [ "scope", "scope_key", "headline", "summary", "bullets" ] } }, "required": [ "postcode", "postcode_sector_exposure", "commercial_weather", "ownership_proxy", "economic_pulse", "lifecycle_distribution", "brief" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/sectors/health": { "get": { "operationId": "seer.v1.market.sectors.health", "tags": [ "SeerMarket" ], "parameters": [ { "name": "date", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "window", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2520 } }, { "name": "state", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 40 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "filters": { "anyOf": [ { "type": "object", "properties": { "sector": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] }, "window": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] } }, "required": [ "sector", "date", "window", "state" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "count", "filters", "rows" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/sectors/correlations": { "get": { "operationId": "seer.v1.market.sectors.correlations", "tags": [ "SeerMarket" ], "parameters": [ { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "window", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2520 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "filters": { "anyOf": [ { "type": "object", "properties": { "sector": { "type": [ "string", "null" ] }, "window": { "type": [ "string", "null" ] } }, "required": [ "sector", "window" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "count", "filters", "rows" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/listed-companies": { "get": { "operationId": "seer.v1.market.listed_companies", "tags": [ "SeerMarket" ], "parameters": [ { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "regime", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 40 } }, { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 400 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "filters": { "anyOf": [ { "type": "object", "properties": { "sector": { "type": [ "string", "null" ] }, "regime": { "type": [ "string", "null" ] }, "q": { "type": [ "string", "null" ] } }, "required": [ "sector", "regime", "q" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "count", "filters", "rows" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/company-explorer": { "get": { "operationId": "seer.v1.market.company_explorer", "tags": [ "SeerMarket" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 160 } }, { "name": "abn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 32 } }, { "name": "acn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 32 } }, { "name": "state", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 10 } }, { "name": "suburb", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "postcode", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 10 } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "listed", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "listed", "private" ] } }, { "name": "lifecycle_states[]", "in": "query", "schema": { "type": "array", "items": { "type": "string", "maxLength": 60 } } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "search_active": { "type": "boolean" }, "result_count": { "type": "integer" }, "listed_result_count": { "type": "integer" }, "private_result_count": { "type": "integer" }, "beta_capm_enabled": { "type": "boolean" }, "default_trade_date": { "type": [ "string", "null" ] } }, "required": [ "search_active", "result_count", "listed_result_count", "private_result_count", "beta_capm_enabled", "default_trade_date" ] }, "filters": { "type": "object", "properties": { "current": { "type": "object", "properties": { "q": { "type": "string" }, "abn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "state": { "type": "string" }, "suburb": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "lifecycle_states": { "type": "array", "items": [] }, "listed": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "all" ] } ] }, "is_listed": { "type": "boolean" }, "beta_min": { "type": [ "number", "null" ] }, "beta_max": { "type": [ "number", "null" ] }, "capm_expected_return_min": { "type": [ "number", "null" ] }, "capm_expected_return_max": { "type": [ "number", "null" ] }, "downside_beta_max": { "type": [ "number", "null" ] }, "sort": { "type": "string" }, "direction": { "type": "string", "enum": [ "asc", "desc" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "q", "abn", "acn", "state", "suburb", "postcode", "sector", "lifecycle_states", "listed", "is_listed", "beta_min", "beta_max", "capm_expected_return_min", "capm_expected_return_max", "downside_beta_max", "sort", "direction", "limit" ] }, "options": { "type": "object", "properties": { "states": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "ACT" ] }, { "type": "string", "enum": [ "NSW" ] }, { "type": "string", "enum": [ "NT" ] }, { "type": "string", "enum": [ "QLD" ] }, { "type": "string", "enum": [ "SA" ] }, { "type": "string", "enum": [ "TAS" ] }, { "type": "string", "enum": [ "VIC" ] }, { "type": "string", "enum": [ "WA" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false }, "lifecycle_states": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "Emerging" ] }, { "type": "string", "enum": [ "Early Growth" ] }, { "type": "string", "enum": [ "Expansion" ] }, { "type": "string", "enum": [ "Mature / Stable" ] }, { "type": "string", "enum": [ "Slowing / Plateauing" ] }, { "type": "string", "enum": [ "Decline" ] }, { "type": "string", "enum": [ "Distress" ] }, { "type": "string", "enum": [ "Failed" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false }, "listed_options": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "value": { "type": "string", "enum": [ "all" ] }, "label": { "type": "string", "enum": [ "All companies" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "listed" ] }, "label": { "type": "string", "enum": [ "Listed only" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "private" ] }, "label": { "type": "string", "enum": [ "Private only" ] } }, "required": [ "value", "label" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false }, "list_types": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "value": { "type": "string", "enum": [ "winner" ] }, "label": { "type": "string", "enum": [ "Top winners" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "loser" ] }, "label": { "type": "string", "enum": [ "Top losers" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "momentum_leader" ] }, "label": { "type": "string", "enum": [ "Momentum leaders" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "reversal_candidate" ] }, "label": { "type": "string", "enum": [ "Reversal candidates" ] } }, "required": [ "value", "label" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "sorts": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "value": { "type": "string", "enum": [ "market_score" ] }, "label": { "type": "string", "enum": [ "Market score" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "beta_250d" ] }, "label": { "type": "string", "enum": [ "Beta (250D)" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "dynamic_beta" ] }, "label": { "type": "string", "enum": [ "Dynamic beta" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "downside_beta_250d" ] }, "label": { "type": "string", "enum": [ "Downside beta" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "capm_expected_return_250d" ] }, "label": { "type": "string", "enum": [ "CAPM expected return" ] } }, "required": [ "value", "label" ] }, { "type": "object", "properties": { "value": { "type": "string", "enum": [ "alpha_vs_capm_250d" ] }, "label": { "type": "string", "enum": [ "Alpha vs CAPM" ] } }, "required": [ "value", "label" ] } ], "minItems": 6, "maxItems": 6, "additionalItems": false } }, "required": [ "states", "lifecycle_states", "listed_options", "list_types", "sorts" ] } }, "required": [ "current", "options" ] }, "market_movers": { "type": "object", "properties": { "winners": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "losers": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "momentum_leaders": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "reversal_candidates": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "anomalies": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "winners", "losers", "momentum_leaders", "reversal_candidates", "anomalies" ] }, "results": { "type": "array", "items": [] }, "source_note": { "type": "string", "enum": [ "Public market data is blended with Seer business intelligence to surface winners, losers, challengers, and at-risk operators in one explorer." ] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "enum": [ "Company explorer scoring" ] }, "summary": { "type": "string", "enum": [ "The explorer defaults to market movers, then switches to filtered company profiles scored from Seer lifecycle, market-risk, and competitive-intelligence models." ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Market movers lists" ] }, "summary": { "type": "string", "enum": [ "Winners and losers are ranked directly from the latest public trading session. Momentum leaders use 90-day return. Reversal candidates surface securities with recent downside that are starting to recover." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Winner / loser rank" ] }, "formula": { "type": "string", "enum": [ "Rank by latest return_1d descending for winners and ascending for losers." ] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "ASX rankings fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "trade_date" ] }, { "type": "string", "enum": [ "list_type" ] }, { "type": "string", "enum": [ "rank" ] }, { "type": "string", "enum": [ "symbol" ] }, { "type": "string", "enum": [ "return_1d" ] }, { "type": "string", "enum": [ "return_90d" ] }, { "type": "string", "enum": [ "abnormal_volume_ratio" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Underlying price features" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "return_1d" ] }, { "type": "string", "enum": [ "return_20d" ] }, { "type": "string", "enum": [ "return_90d" ] }, { "type": "string", "enum": [ "volatility_20d" ] }, { "type": "string", "enum": [ "drawdown_252d" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Momentum leaders" ] }, "formula": { "type": "string", "enum": [ "Rank by latest return_90d descending." ] } }, "required": [ "label", "formula" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Anomalies" ] }, "formula": { "type": "string", "enum": [ "Surface rows with z-score, abnormal volume, acceleration, or bubble-behaviour signals from the anomaly mart." ] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Company anomalies fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "anomaly_type" ] }, { "type": "string", "enum": [ "severity_score" ] }, { "type": "string", "enum": [ "z_score_90d" ] }, { "type": "string", "enum": [ "abnormal_volume_ratio" ] }, { "type": "string", "enum": [ "price_acceleration_score" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "sources" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Company profile search" ] }, "summary": { "type": "string", "enum": [ "Search hits come from the latest Seer competitor profile rows. They blend business identity with lifecycle, market, digital visibility, and regional footprint scores." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Current filters" ] }, "formula": { "type": "string", "enum": [ "q / ABN / ACN / state / suburb / postcode / sector / lifecycle state / listed filter" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "q" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "abn" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "acn" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "state" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "postcode" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "sector" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "listed filter" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "all" ] } ] } }, "required": [ "label", "value" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Competitor profile fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "business_name" ] }, { "type": "string", "enum": [ "abn" ] }, { "type": "string", "enum": [ "acn" ] }, { "type": "string", "enum": [ "sector_name" ] }, { "type": "string", "enum": [ "lifecycle_state" ] }, { "type": "string", "enum": [ "market_score" ] }, { "type": "string", "enum": [ "market_risk_score" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle score family" ] }, "summary": { "type": "string", "enum": [ "Growth, stability, stress, governance, market, expansion, and failure scores drive lifecycle state and trajectory." ] }, "formula": { "type": "string", "enum": [ "lifecycle_state = classify(growth_score, stability_score, stress_score, governance_score, market_score, expansion_score, failure_score, confidence_score)" ] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle scores fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "growth_score" ] }, { "type": "string", "enum": [ "stability_score" ] }, { "type": "string", "enum": [ "stress_score" ] }, { "type": "string", "enum": [ "governance_score" ] }, { "type": "string", "enum": [ "market_score" ] }, { "type": "string", "enum": [ "expansion_score" ] }, { "type": "string", "enum": [ "failure_score" ] }, { "type": "string", "enum": [ "confidence_score" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle states fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "lifecycle_state" ] }, { "type": "string", "enum": [ "trajectory_label" ] }, { "type": "string", "enum": [ "overheated_flag" ] }, { "type": "string", "enum": [ "distress_flag" ] }, { "type": "string", "enum": [ "market_event_flag" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "summary", "formula", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Market posture" ] }, "summary": { "type": "string", "enum": [ "Market risk and opportunity combine listed-market stress, sector pressure, postcode commercial weather, and macro pressure, with inflation resolved to a capital-city proxy when Seer can localise the business." ] }, "formula": { "type": "string", "enum": [ "market_risk_score and market_opportunity_score are read from the latest Seer market-risk output for this business and used directly in explorer ranking." ] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market risk fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "market_risk_score" ] }, { "type": "string", "enum": [ "market_opportunity_score" ] }, { "type": "string", "enum": [ "security_stress_component" ] }, { "type": "string", "enum": [ "sector_stress_component" ] }, { "type": "string", "enum": [ "postcode_weather_component" ] }, { "type": "string", "enum": [ "inflation_pressure_component" ] }, { "type": "string", "enum": [ "macro_pressure_component" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] } ], "minItems": 9, "maxItems": 9, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "symbol" ] }, { "type": "string", "enum": [ "sector_name" ] }, { "type": "string", "enum": [ "industry_group" ] }, { "type": "string", "enum": [ "trend_regime" ] }, { "type": "string", "enum": [ "volatility_regime" ] }, { "type": "string", "enum": [ "return_1m" ] }, { "type": "string", "enum": [ "return_12m" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] } ], "minItems": 9, "maxItems": 9, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "summary", "formula", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Visibility and footprint proxies" ] }, "summary": { "type": "string", "enum": [ "Digital visibility, regional footprint, and signal quality help separate visible operators from low-signal records." ] }, "formula": { "type": "string", "enum": [ "digital_visibility_score, regional_footprint_score, and signal_quality_score are read from the latest competitor profile row." ] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Competitor profile fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "digital_visibility_score" ] }, { "type": "string", "enum": [ "regional_footprint_score" ] }, { "type": "string", "enum": [ "signal_quality_score" ] }, { "type": "string", "enum": [ "top_flags_json" ] }, { "type": "string", "enum": [ "opportunity_flags_json" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "summary", "formula", "sources" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "title", "summary", "sections" ] } }, "required": [ "summary", "filters", "market_movers", "results", "source_note", "debug" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/briefs/{geo}": { "get": { "operationId": "seer.v1.market.briefs", "tags": [ "SeerMarket" ], "parameters": [ { "name": "geo", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "sector" ] }, "scope_key": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string" } ] }, "headline": { "type": "string" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "No sector market brief is available yet." ] } ] }, "bullets": { "type": "array", "items": [] } }, "required": [ "scope", "scope_key", "headline", "summary", "bullets" ] }, { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "postcode" ] }, "scope_key": { "type": "string" }, "headline": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "Postcode market brief" ] } ] }, "summary": { "type": "string" }, "bullets": { "type": "array", "items": [] } }, "required": [ "scope", "scope_key", "headline", "summary", "bullets" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/winners-losers": { "get": { "operationId": "seer.v1.market.winners_losers", "tags": [ "SeerMarket" ], "parameters": [ { "name": "list_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 60 } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "filters": { "anyOf": [ { "type": "object", "properties": { "list_type": { "type": [ "string", "null" ] }, "sector": { "type": [ "string", "null" ] } }, "required": [ "list_type", "sector" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "count", "filters", "rows" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/anomalies": { "get": { "operationId": "seer.v1.market.anomalies", "tags": [ "SeerMarket" ], "parameters": [ { "name": "anomaly_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "symbol", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 24 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "filters": { "anyOf": [ { "type": "object", "properties": { "anomaly_type": { "type": [ "string", "null" ] }, "sector": { "type": [ "string", "null" ] }, "symbol": { "type": [ "string", "null" ] } }, "required": [ "anomaly_type", "sector", "symbol" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "count", "filters", "rows" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/events": { "get": { "operationId": "seer.v1.market.events", "tags": [ "SeerMarket" ], "parameters": [ { "name": "scope_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 40 } }, { "name": "event_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer" }, "filters": { "anyOf": [ { "type": "object", "properties": { "scope_type": { "type": [ "string", "null" ] }, "event_type": { "type": [ "string", "null" ] }, "sector": { "type": [ "string", "null" ] } }, "required": [ "scope_type", "event_type", "sector" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "rows": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "market_breadth": { "type": [ "object", "null" ], "additionalProperties": [] } }, "required": [ "count", "filters", "rows", "market_breadth" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/economic-pulse": { "get": { "operationId": "seer.v1.market.economic_pulse", "tags": [ "SeerMarket" ], "parameters": [ { "name": "scope_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 40 } }, { "name": "scope_key", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "scope_type": { "type": "string" }, "scope_key": { "type": [ "string", "null" ] } }, "required": [ "scope_type", "scope_key" ] }, "row": { "type": [ "object", "null" ], "additionalProperties": [] }, "rows": { "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "filters", "row", "rows" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/lifecycle/business/{business}": { "get": { "operationId": "seer.v1.market.lifecycle.business", "tags": [ "SeerMarket" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_id": { "type": "integer" }, "summary": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "null" }, "latest_trade_date": { "type": [ "string", "null" ] }, "matched_sector_count": { "type": "integer" }, "weighted_return_20d": { "type": [ "number", "null" ] }, "weighted_return_90d": { "type": [ "number", "null" ] }, "weighted_volatility_20d": { "type": [ "number", "null" ] }, "weighted_drawdown_252d": { "type": [ "number", "null" ] }, "weighted_price_vs_sma_200": { "type": [ "number", "null" ] }, "market_regime": { "type": "string" }, "is_listed": { "type": "boolean" }, "symbol": { "type": "string" }, "sector_name": { "type": "string" }, "industry_group": { "type": "string" }, "configured_focus_sectors": { "type": "array", "items": { "type": "string" } }, "resolved_focus_sectors": { "type": "array", "items": { "type": "array", "items": [] } }, "focus_sector_source": { "type": "string", "enum": [ "context", "unavailable", "matched", "explicit" ] }, "trend_regime": { "type": "string" }, "volatility_regime": { "type": "string" }, "dividend_regime": { "type": "string" }, "match_confidence": { "type": [ "number", "null" ] }, "market_risk_score": { "type": [ "number", "null" ] }, "market_opportunity_score": { "type": [ "number", "null" ] }, "stress_label": { "type": "string" }, "growth_mode": { "type": "integer" }, "distress_mode": { "type": "integer" }, "restructuring_mode": { "type": "integer" }, "capital_raise_pressure": { "type": "integer" }, "consolidation_likelihood": { "type": "integer" }, "lifecycle_state": { "type": "string" }, "trajectory_label": { "type": "string" }, "lifecycle_confidence_score": { "type": [ "number", "null" ] }, "overheated_flag": { "type": "integer" }, "market_event_flag": { "type": "integer" }, "economic_pulse_label": { "type": "string" }, "economic_pulse_score": { "type": [ "number", "null" ] }, "return_1m": { "type": [ "number", "null" ] }, "return_3m": { "type": [ "number", "null" ] }, "return_12m": { "type": [ "number", "null" ] }, "return_5y": { "type": [ "number", "null" ] }, "volatility_20d": { "type": [ "number", "null" ] }, "drawdown_252d": { "type": [ "number", "null" ] }, "price_vs_sma_200": { "type": [ "number", "null" ] }, "dividend_trailing_12m": { "type": [ "number", "null" ] }, "inflation_signal": { "type": "object", "additionalProperties": [] }, "national_inflation_signal": { "type": "object", "additionalProperties": [] }, "postcode_commercial_weather_label": { "type": "string" }, "explainers": { "type": "array", "items": [] }, "matched_sectors": { "type": "array", "items": { "type": "array", "items": [] } }, "business_market_context": { "type": [ "object", "null" ], "additionalProperties": [] }, "business_market_risk": { "type": [ "object", "null" ], "additionalProperties": [] }, "business_lifecycle_score": { "type": [ "object", "null" ], "additionalProperties": [] }, "business_lifecycle_state": { "type": [ "object", "null" ], "additionalProperties": [] }, "debug": { "type": [ "object", "null" ], "properties": { "title": { "type": "string", "enum": [ "Market context models" ] }, "sections": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Business market risk score" ] }, "summary": { "type": "string", "enum": [ "This score blends security stress, sector stress, postcode pressure, and macro pressure into a 0-100 commercial risk read, with inflation resolved to a capital-city proxy when Seer can localise the business." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Listed-business formula" ] }, "formula": { "type": "string", "enum": [ "market_risk_score = security_stress * listed.security_stress + sector_stress * listed.sector_stress + postcode_weather * listed.postcode_weather + macro_pressure * listed.macro_pressure" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "security_stress_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "sector_stress_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "postcode_weather_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_pressure_component" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "macro_pressure_component" ] }, "value": { "type": [ "string", "null" ] }, "weight": { "type": [ "string", "null" ] } }, "required": [ "label", "value", "weight" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_scope_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_value" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "national_inflation_value" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market risk fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "market_risk_score" ] }, { "type": "string", "enum": [ "security_stress_component" ] }, { "type": "string", "enum": [ "sector_stress_component" ] }, { "type": "string", "enum": [ "postcode_weather_component" ] }, { "type": "string", "enum": [ "inflation_pressure_component" ] }, { "type": "string", "enum": [ "macro_pressure_component" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "return_1m" ] }, { "type": "string", "enum": [ "return_12m" ] }, { "type": "string", "enum": [ "volatility_20d" ] }, { "type": "string", "enum": [ "drawdown_252d" ] }, { "type": "string", "enum": [ "price_vs_sma_200" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] }, { "type": "string", "enum": [ "national_inflation_value" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Private-business fallback" ] }, "formula": { "type": "string", "enum": [ "market_risk_score = sector_stress * private.sector_stress + postcode_exposure_stress * private.postcode_exposure_stress + local_seer_commercial_stress * private.local_seer_commercial_stress + macro_pressure * private.macro_pressure" ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private sector_stress weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private postcode_exposure_stress weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private local_seer_commercial_stress weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "private macro_pressure weight" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "formula", "inputs" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Opportunity and posture" ] }, "formula": { "type": "string", "enum": [ "market_opportunity_score, stress_label, and posture flags are read from the latest Seer market-risk row for this business." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "market_opportunity_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stress_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "growth_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "distress_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "restructuring_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "capital_raise_pressure" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "consolidation_likelihood" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market risk fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "market_opportunity_score" ] }, { "type": "string", "enum": [ "stress_label" ] }, { "type": "string", "enum": [ "growth_mode" ] }, { "type": "string", "enum": [ "distress_mode" ] }, { "type": "string", "enum": [ "restructuring_mode" ] }, { "type": "string", "enum": [ "capital_raise_pressure" ] }, { "type": "string", "enum": [ "consolidation_likelihood" ] } ], "minItems": 7, "maxItems": 7, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Lifecycle state" ] }, "summary": { "type": "string", "enum": [ "Lifecycle scores classify each business into a stage and trajectory using growth, stability, stress, governance, market, expansion, and failure components." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle score inputs" ] }, "formula": { "type": "string", "enum": [ "Growth, stability, stress, governance, market, expansion, and failure scores are combined, then classified into state + trajectory with confidence." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "growth_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stability_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stress_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "governance_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "market_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "expansion_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "failure_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "confidence_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "lifecycle_state" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trajectory_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 10, "maxItems": 10, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle scores fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "growth_score" ] }, { "type": "string", "enum": [ "stability_score" ] }, { "type": "string", "enum": [ "stress_score" ] }, { "type": "string", "enum": [ "governance_score" ] }, { "type": "string", "enum": [ "market_score" ] }, { "type": "string", "enum": [ "expansion_score" ] }, { "type": "string", "enum": [ "failure_score" ] }, { "type": "string", "enum": [ "confidence_score" ] } ], "minItems": 8, "maxItems": 8, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Lifecycle states fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "lifecycle_state" ] }, { "type": "string", "enum": [ "trajectory_label" ] }, { "type": "string", "enum": [ "overheated_flag" ] }, { "type": "string", "enum": [ "market_event_flag" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Trading regimes" ] }, "formula": { "type": "string", "enum": [ "trend_regime, volatility_regime, and dividend_regime are read directly from the business market context row and used to label posture." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "trend_regime" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "volatility_regime" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "dividend_regime" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "return_1m" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "return_12m" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "price_vs_sma_200" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "volatility_20d" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "dividend_trailing_12m" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_scope_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "inflation_value" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 10, "maxItems": 10, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "trend_regime" ] }, { "type": "string", "enum": [ "volatility_regime" ] }, { "type": "string", "enum": [ "dividend_regime" ] }, { "type": "string", "enum": [ "return_1m" ] }, { "type": "string", "enum": [ "return_12m" ] }, { "type": "string", "enum": [ "price_vs_sma_200" ] }, { "type": "string", "enum": [ "volatility_20d" ] }, { "type": "string", "enum": [ "dividend_trailing_12m" ] }, { "type": "string", "enum": [ "inflation_value" ] }, { "type": "string", "enum": [ "inflation_scope_label" ] }, { "type": "string", "enum": [ "inflation_fallback_applied" ] } ], "minItems": 11, "maxItems": 11, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] }, { "type": "object", "properties": { "title": { "type": "string", "enum": [ "Sector matching and local pulse" ] }, "summary": { "type": "string", "enum": [ "When no direct listed match exists, Seer falls back to weighted sector matches and local pulse overlays." ] }, "metrics": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Matched sectors" ] }, "formula": { "type": "string", "enum": [ "Weighted sector metrics are aggregated from the matched sector list for this business." ] }, "inputs": { "type": "array", "items": [] }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Sector market health fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "sector_name" ] }, { "type": "string", "enum": [ "avg_return_20d" ] }, { "type": "string", "enum": [ "avg_return_90d" ] }, { "type": "string", "enum": [ "sector_stress_score" ] }, { "type": "string", "enum": [ "sector_opportunity_score" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business/sector match fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "business_id" ] }, { "type": "string", "enum": [ "symbol" ] }, { "type": "string", "enum": [ "sector_name" ] }, { "type": "string", "enum": [ "match_type" ] }, { "type": "string", "enum": [ "match_confidence" ] } ], "minItems": 5, "maxItems": 5, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Economic pulse" ] }, "formula": { "type": "string", "enum": [ "Pulse blends sector momentum, stress, macro pressure, lifecycle pressure, and market breadth." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "pulse_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "momentum_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "stress_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "macro_pressure_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "lifecycle_pressure_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "breadth_score" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] } ], "minItems": 6, "maxItems": 6, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Economic pulse fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "pulse_score" ] }, { "type": "string", "enum": [ "momentum_score" ] }, { "type": "string", "enum": [ "stress_score" ] }, { "type": "string", "enum": [ "macro_pressure_score" ] }, { "type": "string", "enum": [ "lifecycle_pressure_score" ] }, { "type": "string", "enum": [ "breadth_score" ] } ], "minItems": 6, "maxItems": 6, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Macro daily fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "series_key" ] }, { "type": "string", "enum": [ "value" ] }, { "type": "string", "enum": [ "trade_date" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Explainers and local weather" ] }, "formula": { "type": "string", "enum": [ "The dashboard explainers and postcode commercial weather label are attached from the latest business market context and commercial weather rows." ] }, "inputs": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "postcode_commercial_weather_label" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "label", "value" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "explainers" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "—" ] } ] } }, "required": [ "label", "value" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false }, "sources": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Business market context fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "postcode_commercial_weather_label" ] }, { "type": "string", "enum": [ "explainers_json" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "table", "fields" ] }, { "type": "object", "properties": { "label": { "type": "string", "enum": [ "Commercial weather fact" ] }, "table": { "type": "string" }, "fields": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "scope_type" ] }, { "type": "string", "enum": [ "scope_key" ] }, { "type": "string", "enum": [ "weather_label" ] }, { "type": "string", "enum": [ "composite_score" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false } }, "required": [ "label", "table", "fields" ] } ], "minItems": 2, "maxItems": 2, "additionalItems": false } }, "required": [ "label", "formula", "inputs", "sources" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "summary", "metrics" ] } ], "minItems": 3, "maxItems": 3, "additionalItems": false } }, "required": [ "title", "sections" ] } }, "required": [ "available", "reason", "latest_trade_date", "matched_sector_count", "weighted_return_20d", "weighted_return_90d", "weighted_volatility_20d", "weighted_drawdown_252d", "weighted_price_vs_sma_200", "market_regime", "is_listed", "symbol", "sector_name", "industry_group", "configured_focus_sectors", "resolved_focus_sectors", "focus_sector_source", "trend_regime", "volatility_regime", "dividend_regime", "match_confidence", "market_risk_score", "market_opportunity_score", "stress_label", "growth_mode", "distress_mode", "restructuring_mode", "capital_raise_pressure", "consolidation_likelihood", "lifecycle_state", "trajectory_label", "lifecycle_confidence_score", "overheated_flag", "market_event_flag", "economic_pulse_label", "economic_pulse_score", "return_1m", "return_3m", "return_12m", "return_5y", "volatility_20d", "drawdown_252d", "price_vs_sma_200", "dividend_trailing_12m", "inflation_signal", "national_inflation_signal", "postcode_commercial_weather_label", "explainers", "matched_sectors", "business_market_context", "business_market_risk", "business_lifecycle_score", "business_lifecycle_state", "debug" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "no_market_context" ] }, "latest_trade_date": { "type": "null" }, "matched_sector_count": { "type": "integer", "enum": [ 0 ] }, "weighted_return_20d": { "type": "null" }, "weighted_return_90d": { "type": "null" }, "weighted_volatility_20d": { "type": "null" }, "weighted_drawdown_252d": { "type": "null" }, "weighted_price_vs_sma_200": { "type": "null" }, "market_regime": { "type": "string", "enum": [ "unavailable" ] }, "is_listed": { "type": "boolean" }, "symbol": { "type": "null" }, "sector_name": { "type": "null" }, "industry_group": { "type": "null" }, "configured_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "resolved_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "focus_sector_source": { "type": "string", "enum": [ "unavailable" ] }, "trend_regime": { "type": "null" }, "volatility_regime": { "type": "null" }, "dividend_regime": { "type": "null" }, "match_confidence": { "type": "null" }, "market_risk_score": { "type": "null" }, "market_opportunity_score": { "type": "null" }, "stress_label": { "type": "string", "enum": [ "unavailable" ] }, "growth_mode": { "type": "integer", "enum": [ 0 ] }, "distress_mode": { "type": "integer", "enum": [ 0 ] }, "restructuring_mode": { "type": "integer", "enum": [ 0 ] }, "capital_raise_pressure": { "type": "integer", "enum": [ 0 ] }, "consolidation_likelihood": { "type": "integer", "enum": [ 0 ] }, "lifecycle_state": { "type": "null" }, "trajectory_label": { "type": "null" }, "lifecycle_confidence_score": { "type": "null" }, "overheated_flag": { "type": "integer", "enum": [ 0 ] }, "market_event_flag": { "type": "integer", "enum": [ 0 ] }, "economic_pulse_label": { "type": "null" }, "economic_pulse_score": { "type": "null" }, "return_1m": { "type": "null" }, "return_3m": { "type": "null" }, "return_12m": { "type": "null" }, "return_5y": { "type": "null" }, "volatility_20d": { "type": "null" }, "drawdown_252d": { "type": "null" }, "price_vs_sma_200": { "type": "null" }, "dividend_trailing_12m": { "type": "null" }, "inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "null" }, "scope_key": { "type": "null" }, "scope_label": { "type": "null" }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "national_inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "string", "enum": [ "national" ] }, "scope_key": { "type": "string", "enum": [ "AU" ] }, "scope_label": { "type": "string", "enum": [ "Australia" ] }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "postcode_commercial_weather_label": { "type": "string", "enum": [ "unavailable" ] }, "explainers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "matched_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "business_market_context": { "type": "null" }, "business_market_risk": { "type": "null" }, "business_lifecycle_score": { "type": "null" }, "business_lifecycle_state": { "type": "null" } }, "required": [ "available", "reason", "latest_trade_date", "matched_sector_count", "weighted_return_20d", "weighted_return_90d", "weighted_volatility_20d", "weighted_drawdown_252d", "weighted_price_vs_sma_200", "market_regime", "is_listed", "symbol", "sector_name", "industry_group", "configured_focus_sectors", "resolved_focus_sectors", "focus_sector_source", "trend_regime", "volatility_regime", "dividend_regime", "match_confidence", "market_risk_score", "market_opportunity_score", "stress_label", "growth_mode", "distress_mode", "restructuring_mode", "capital_raise_pressure", "consolidation_likelihood", "lifecycle_state", "trajectory_label", "lifecycle_confidence_score", "overheated_flag", "market_event_flag", "economic_pulse_label", "economic_pulse_score", "return_1m", "return_3m", "return_12m", "return_5y", "volatility_20d", "drawdown_252d", "price_vs_sma_200", "dividend_trailing_12m", "inflation_signal", "national_inflation_signal", "postcode_commercial_weather_label", "explainers", "matched_sectors", "business_market_context", "business_market_risk", "business_lifecycle_score", "business_lifecycle_state" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "clickhouse_disabled" ] }, "latest_trade_date": { "type": "null" }, "matched_sector_count": { "type": "integer", "enum": [ 0 ] }, "weighted_return_20d": { "type": "null" }, "weighted_return_90d": { "type": "null" }, "weighted_volatility_20d": { "type": "null" }, "weighted_drawdown_252d": { "type": "null" }, "weighted_price_vs_sma_200": { "type": "null" }, "market_regime": { "type": "string", "enum": [ "unavailable" ] }, "is_listed": { "type": "boolean" }, "symbol": { "type": "null" }, "sector_name": { "type": "null" }, "industry_group": { "type": "null" }, "configured_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "resolved_focus_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "focus_sector_source": { "type": "string", "enum": [ "unavailable" ] }, "trend_regime": { "type": "null" }, "volatility_regime": { "type": "null" }, "dividend_regime": { "type": "null" }, "match_confidence": { "type": "null" }, "market_risk_score": { "type": "null" }, "market_opportunity_score": { "type": "null" }, "stress_label": { "type": "string", "enum": [ "unavailable" ] }, "growth_mode": { "type": "integer", "enum": [ 0 ] }, "distress_mode": { "type": "integer", "enum": [ 0 ] }, "restructuring_mode": { "type": "integer", "enum": [ 0 ] }, "capital_raise_pressure": { "type": "integer", "enum": [ 0 ] }, "consolidation_likelihood": { "type": "integer", "enum": [ 0 ] }, "lifecycle_state": { "type": "null" }, "trajectory_label": { "type": "null" }, "lifecycle_confidence_score": { "type": "null" }, "overheated_flag": { "type": "integer", "enum": [ 0 ] }, "market_event_flag": { "type": "integer", "enum": [ 0 ] }, "economic_pulse_label": { "type": "null" }, "economic_pulse_score": { "type": "null" }, "return_1m": { "type": "null" }, "return_3m": { "type": "null" }, "return_12m": { "type": "null" }, "return_5y": { "type": "null" }, "volatility_20d": { "type": "null" }, "drawdown_252d": { "type": "null" }, "price_vs_sma_200": { "type": "null" }, "dividend_trailing_12m": { "type": "null" }, "inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "null" }, "scope_key": { "type": "null" }, "scope_label": { "type": "null" }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "national_inflation_signal": { "type": "object", "properties": { "available": { "type": "boolean" }, "series_key": { "type": "string", "enum": [ "cpi_annual_change_pct" ] }, "value": { "type": "null" }, "unit": { "type": "string", "enum": [ "%" ] }, "trade_date": { "type": "null" }, "scope_type": { "type": "string", "enum": [ "national" ] }, "scope_key": { "type": "string", "enum": [ "AU" ] }, "scope_label": { "type": "string", "enum": [ "Australia" ] }, "fallback_applied": { "type": "boolean" } }, "required": [ "available", "series_key", "value", "unit", "trade_date", "scope_type", "scope_key", "scope_label", "fallback_applied" ] }, "postcode_commercial_weather_label": { "type": "string", "enum": [ "unavailable" ] }, "explainers": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "matched_sectors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "business_market_context": { "type": "null" }, "business_market_risk": { "type": "null" }, "business_lifecycle_score": { "type": "null" }, "business_lifecycle_state": { "type": "null" } }, "required": [ "available", "reason", "latest_trade_date", "matched_sector_count", "weighted_return_20d", "weighted_return_90d", "weighted_volatility_20d", "weighted_drawdown_252d", "weighted_price_vs_sma_200", "market_regime", "is_listed", "symbol", "sector_name", "industry_group", "configured_focus_sectors", "resolved_focus_sectors", "focus_sector_source", "trend_regime", "volatility_regime", "dividend_regime", "match_confidence", "market_risk_score", "market_opportunity_score", "stress_label", "growth_mode", "distress_mode", "restructuring_mode", "capital_raise_pressure", "consolidation_likelihood", "lifecycle_state", "trajectory_label", "lifecycle_confidence_score", "overheated_flag", "market_event_flag", "economic_pulse_label", "economic_pulse_score", "return_1m", "return_3m", "return_12m", "return_5y", "volatility_20d", "drawdown_252d", "price_vs_sma_200", "dividend_trailing_12m", "inflation_signal", "national_inflation_signal", "postcode_commercial_weather_label", "explainers", "matched_sectors", "business_market_context", "business_market_risk", "business_lifecycle_score", "business_lifecycle_state" ] } ] }, "lifecycle_score": { "type": [ "object", "null" ], "additionalProperties": [] }, "lifecycle_state": { "type": [ "object", "null" ], "additionalProperties": [] }, "transitions": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "company_event_signals": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "business_id", "summary", "lifecycle_score", "lifecycle_state", "transitions", "company_event_signals" ] } }, "text/csv; charset=UTF-8": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/lifecycle/sectors": { "get": { "operationId": "seer.v1.market.lifecycle.sectors", "tags": [ "SeerMarket" ], "parameters": [ { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "sector": { "type": [ "string", "null" ] } }, "required": [ "sector" ] }, "distribution": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "filters", "distribution" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/lifecycle/transitions": { "get": { "operationId": "seer.v1.market.lifecycle.transitions", "tags": [ "SeerMarket" ], "parameters": [ { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "business_id", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "object", "properties": { "sector": { "type": [ "string", "null" ] }, "business_id": { "type": [ "string", "null" ] } }, "required": [ "sector", "business_id" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "filters", "rows" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/competitors/business/{business}": { "get": { "operationId": "seer.v1.market.competitors.business", "tags": [ "SeerMarket" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": [] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/market/competitors/postcodes/{postcode}": { "get": { "operationId": "seer.v1.market.competitors.postcode", "tags": [ "SeerMarket" ], "parameters": [ { "name": "postcode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sector", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "postcode": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "landscape": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": [ "string", "null" ], "enum": [ "no_landscape" ] }, "top_pressure_sector": [], "top_pressure_score": [], "top_opportunity_sector": { "type": [ "string", "null" ] }, "top_opportunity_score": { "type": [ "string", "null" ] } }, "required": [ "available", "reason", "top_pressure_sector", "top_pressure_score", "top_opportunity_sector", "top_opportunity_score" ] } }, "required": [ "postcode", "landscape", "summary" ] }, { "type": "object", "properties": { "postcode": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" } ] }, { "type": "string", "enum": [ "" ] } ] }, "landscape": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "reason": { "type": "string", "enum": [ "missing_postcode" ] } }, "required": [ "available", "reason" ] } }, "required": [ "postcode", "landscape", "summary" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/businesses/{business}/key-people": { "get": { "operationId": "seer.v1.businesses.key_people", "tags": [ "SeerPeople" ], "parameters": [ { "name": "business", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "metrics": { "anyOf": [ { "type": "object", "properties": { "current_key_people_count": { "type": "integer" }, "leadership_overlap_count": { "type": "integer" }, "charity_company_cross_links": { "type": "integer" }, "repeated_leadership_cluster_score": { "type": "number" }, "key_people_density": { "type": "number" }, "governance_churn": { "type": "integer" } }, "required": [ "current_key_people_count", "leadership_overlap_count", "charity_company_cross_links", "repeated_leadership_cluster_score", "key_people_density", "governance_churn" ] }, { "type": "object", "properties": { "current_key_people_count": { "type": "integer", "enum": [ 0 ] }, "leadership_overlap_count": { "type": "integer", "enum": [ 0 ] }, "charity_company_cross_links": { "type": "integer", "enum": [ 0 ] }, "repeated_leadership_cluster_score": { "type": "number", "enum": [ 0 ] }, "key_people_density": { "type": "number", "enum": [ 0 ] }, "governance_churn": { "type": "integer", "enum": [ 0 ] } }, "required": [ "current_key_people_count", "leadership_overlap_count", "charity_company_cross_links", "repeated_leadership_cluster_score", "key_people_density", "governance_churn" ] } ] } }, "required": [ "rows", "metrics" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/people": { "get": { "operationId": "seer.v1.people.index", "tags": [ "SeerPeople" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 160 } }, { "name": "role", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "source_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 60 } }, { "name": "jurisdiction", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 20 } }, { "name": "entity_name", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 180 } }, { "name": "discover_business_id", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "current_only", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 120 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 120 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "count": { "type": "integer" }, "pagination": { "type": "object", "properties": { "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "count": { "type": "integer" } }, "required": [ "page", "per_page", "count" ] } }, "required": [ "results", "count", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/people/{person}": { "get": { "operationId": "seer.v1.people.show", "tags": [ "SeerPeople" ], "parameters": [ { "name": "person", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "person": { "type": [ "object", "null" ], "additionalProperties": [] }, "aliases": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "indicators": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "person", "aliases", "indicators" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "person": { "type": "null" } }, "required": [ "person" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/people/{person}/appointments": { "get": { "operationId": "seer.v1.people.appointments", "tags": [ "SeerPeople" ], "parameters": [ { "name": "person", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "current_only", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "source_type", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 60 } }, { "name": "role", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "appointments": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "appointments" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/people/{person}/network": { "get": { "operationId": "seer.v1.people.network", "tags": [ "SeerPeople" ], "parameters": [ { "name": "person", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "collaborators": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "current_entities": { "type": "array", "items": [] }, "historic_entities": { "type": "array", "items": [] } }, "required": [ "collaborators", "current_entities", "historic_entities" ] }, { "type": "object", "properties": { "collaborators": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "current_entities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "historic_entities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "collaborators", "current_entities", "historic_entities" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/personas/metrics": { "get": { "operationId": "seer.v1.personas.metrics", "tags": [ "SeerPersona" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 160 } }, { "name": "profile", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 8 } }, { "name": "table_code", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 32 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2000 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2000 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "dataset_year": { "type": "integer", "enum": [ 2021 ] }, "count": { "type": "integer", "minimum": 0 }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "profile": { "type": [ "string", "null" ] }, "basis_of_count": { "type": [ "string", "null" ] }, "table_code": { "type": [ "string", "null" ] }, "table_name": { "type": [ "string", "null" ] }, "universe": { "type": "null" }, "column_code": { "type": [ "string", "null" ] }, "cell_code": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "unit": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "required": [ "profile", "basis_of_count", "table_code", "table_name", "universe", "column_code", "cell_code", "label", "unit", "notes" ] } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more" ] } }, "required": [ "dataset_year", "count", "metrics", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/personas": { "get": { "operationId": "seer.v1.personas.index", "tags": [ "SeerPersona" ], "parameters": [ { "name": "business_id", "in": "query", "schema": { "type": [ "integer", "null" ] } }, { "name": "status", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 24 } }, { "name": "is_active", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 200 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 }, "results": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "string" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more" ] } }, "required": [ "count", "results", "pagination" ] }, { "type": "object", "properties": { "count": { "type": "integer", "enum": [ 0 ] }, "results": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "pagination": { "type": "object", "properties": { "page": { "type": "integer", "enum": [ 1 ] }, "per_page": { "type": "integer", "enum": [ 50 ] }, "count": { "type": "integer", "enum": [ 0 ] }, "total": { "type": "integer", "enum": [ 0 ] }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more" ] } }, "required": [ "count", "results", "pagination" ] } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Business not found or not accessible." ] } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "post": { "operationId": "seer.v1.personas.store", "tags": [ "SeerPersona" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "business_id": { "type": "integer" }, "name": { "type": "string", "maxLength": 140 }, "description": { "type": [ "string", "null" ], "maxLength": 6000 }, "color": { "type": [ "string", "null" ], "pattern": "^#(?:[0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "status": { "type": [ "string", "null" ], "enum": [ "draft", "active", "archived" ] }, "is_active": { "type": [ "boolean", "null" ] }, "priority": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 9999 }, "notes": { "type": [ "string", "null" ], "maxLength": 20000 }, "target_postcodes": { "type": [ "array", "null" ], "items": { "type": "string" } }, "criteria": { "type": "array", "items": { "type": "string" } }, "scoring_weights": { "type": [ "array", "null" ], "items": { "type": "string" } }, "compute": { "type": [ "boolean", "null" ] }, "sync": { "type": [ "boolean", "null" ] } }, "required": [ "business_id", "name", "criteria" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "id": { "type": "integer" }, "discover_business_id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "is_active": { "type": "boolean" }, "priority": { "type": "integer" }, "last_computed_at": { "type": "string" }, "last_computed_rows": { "type": [ "integer", "null" ] }, "last_dataset_version": { "type": [ "string", "null" ] }, "targets_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "scores_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "top_postcode": { "type": "object", "properties": { "postcode": { "type": "string" }, "geo_name": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "score": { "type": "number" } }, "required": [ "postcode", "geo_name", "state", "score" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "target_postcodes": { "anyOf": [ { "type": "array", "items": [] }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "criteria": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "scoring_weights": { "anyOf": [ { "type": "array", "items": [] }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "notes": { "type": [ "string", "null" ] }, "targets": { "type": "string" }, "recent_scores": { "type": "string" } }, "required": [ "id", "discover_business_id", "name", "color", "description", "status", "is_active", "priority", "last_computed_at", "last_computed_rows", "last_dataset_version", "targets_count", "scores_count", "top_postcode", "created_at", "updated_at", "target_postcodes", "criteria", "scoring_weights", "notes", "targets", "recent_scores" ] }, "compute": { "type": "object", "properties": { "queued": { "type": "boolean" } }, "required": [ "queued" ] } }, "required": [ "persona", "compute" ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Business not found or not accessible." ] } }, "required": [ "message" ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Persona tables are not available." ] } }, "required": [ "message" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/personas/{persona}": { "get": { "operationId": "seer.v1.personas.show", "tags": [ "SeerPersona" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "The persona ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "id": { "type": "integer" }, "discover_business_id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "is_active": { "type": "boolean" }, "priority": { "type": "integer" }, "last_computed_at": { "type": "string" }, "last_computed_rows": { "type": [ "integer", "null" ] }, "last_dataset_version": { "type": [ "string", "null" ] }, "targets_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "scores_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "top_postcode": { "type": "object", "properties": { "postcode": { "type": "string" }, "geo_name": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "score": { "type": "number" } }, "required": [ "postcode", "geo_name", "state", "score" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "target_postcodes": { "anyOf": [ { "type": "array", "items": [] }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "criteria": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "scoring_weights": { "anyOf": [ { "type": "array", "items": [] }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "notes": { "type": [ "string", "null" ] }, "targets": { "type": "string" }, "recent_scores": { "type": "string" } }, "required": [ "id", "discover_business_id", "name", "color", "description", "status", "is_active", "priority", "last_computed_at", "last_computed_rows", "last_dataset_version", "targets_count", "scores_count", "top_postcode", "created_at", "updated_at", "target_postcodes", "criteria", "scoring_weights", "notes", "targets", "recent_scores" ] } }, "required": [ "persona" ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } }, "put": { "operationId": "seer.v1.personas.update", "tags": [ "SeerPersona" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "The persona ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 140 }, "description": { "type": [ "string", "null" ], "maxLength": 6000 }, "color": { "type": [ "string", "null" ], "pattern": "^#(?:[0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$" }, "status": { "type": [ "string", "null" ], "enum": [ "draft", "active", "archived" ] }, "is_active": { "type": [ "boolean", "null" ] }, "priority": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 9999 }, "notes": { "type": [ "string", "null" ], "maxLength": 20000 }, "target_postcodes": { "type": [ "array", "null" ], "items": { "type": "string" } }, "criteria": { "type": "array", "items": { "type": "string" } }, "scoring_weights": { "type": [ "array", "null" ], "items": { "type": "string" } }, "compute": { "type": [ "boolean", "null" ] }, "sync": { "type": [ "boolean", "null" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "id": { "type": "integer" }, "discover_business_id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "is_active": { "type": "boolean" }, "priority": { "type": "integer" }, "last_computed_at": { "type": "string" }, "last_computed_rows": { "type": [ "integer", "null" ] }, "last_dataset_version": { "type": [ "string", "null" ] }, "targets_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "scores_count": { "anyOf": [ { "type": "integer" }, { "type": "integer", "enum": [ 0 ] } ] }, "top_postcode": { "type": "object", "properties": { "postcode": { "type": "string" }, "geo_name": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "score": { "type": "number" } }, "required": [ "postcode", "geo_name", "state", "score" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "target_postcodes": { "anyOf": [ { "type": "array", "items": [] }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "criteria": { "anyOf": [ { "type": "array", "items": [] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "scoring_weights": { "anyOf": [ { "type": "array", "items": [] }, { "type": "null" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "notes": { "type": [ "string", "null" ] }, "targets": { "type": "string" }, "recent_scores": { "type": "string" } }, "required": [ "id", "discover_business_id", "name", "color", "description", "status", "is_active", "priority", "last_computed_at", "last_computed_rows", "last_dataset_version", "targets_count", "scores_count", "top_postcode", "created_at", "updated_at", "target_postcodes", "criteria", "scoring_weights", "notes", "targets", "recent_scores" ] }, "compute": { "type": "object", "properties": { "queued": { "type": "boolean" } }, "required": [ "queued" ] } }, "required": [ "persona", "compute" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/personas/{persona}/scores": { "get": { "operationId": "seer.v1.personas.scores", "tags": [ "SeerPersona" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "The persona ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2000 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2000 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "profile", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 16 } }, { "name": "dataset_year", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 2000, "maximum": 2100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 }, "rows": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "string" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more" ] } }, "required": [ "count", "rows", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/personas/{persona}/map": { "get": { "operationId": "seer.v1.personas.map", "tags": [ "SeerPersona" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "The persona ID", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2000 } }, { "name": "per_page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 2000 } }, { "name": "page", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 500 } }, { "name": "profile", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 16 } }, { "name": "dataset_year", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 2000, "maximum": 2100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0 }, "features": { "type": "array", "items": { "type": "string" } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "string" }, "last_page": { "type": [ "object", "null" ] }, "has_more": { "type": "boolean" } }, "required": [ "page", "per_page", "count", "total", "last_page", "has_more" ] } }, "required": [ "count", "features", "pagination" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/personas/{persona}/compute": { "post": { "operationId": "seer.v1.personas.compute", "tags": [ "SeerPersona" ], "parameters": [ { "name": "persona", "in": "path", "required": true, "description": "The persona ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sync": { "type": [ "boolean", "null" ] } } } } } }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "queued" ] }, "persona_id": { "type": "integer" } }, "required": [ "status", "persona_id" ] } } } }, "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "completed" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "rows_upserted": { "type": "integer" }, "dataset_year": { "type": "integer", "enum": [ 2021 ] }, "profile": { "type": "string" } }, "required": [ "status", "rows_upserted", "dataset_year", "profile" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "reason": { "type": "string", "enum": [ "no_scores_generated" ] }, "rows_upserted": { "type": "integer", "enum": [ 0 ] } }, "required": [ "status", "reason", "rows_upserted" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "reason": { "type": "string", "enum": [ "no_matching_metric_values" ] }, "rows_upserted": { "type": "integer", "enum": [ 0 ] } }, "required": [ "status", "reason", "rows_upserted" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "reason": { "type": "string", "enum": [ "no_candidate_postcodes" ] }, "rows_upserted": { "type": "integer", "enum": [ 0 ] } }, "required": [ "status", "reason", "rows_upserted" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "reason": { "type": "string", "enum": [ "no_metric_rules" ] }, "rows_upserted": { "type": "integer", "enum": [ 0 ] } }, "required": [ "status", "reason", "rows_upserted" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "skipped" ] }, "reason": { "type": "string", "enum": [ "clickhouse_abs_unavailable" ] }, "rows_upserted": { "type": "integer", "enum": [ 0 ] } }, "required": [ "status", "reason", "rows_upserted" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "skipped" ] }, "reason": { "type": "string", "enum": [ "required_tables_missing" ] }, "rows_upserted": { "type": "integer", "enum": [ 0 ] } }, "required": [ "status", "reason", "rows_upserted" ] } ] } }, "required": [ "status", "result" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/summary": { "get": { "operationId": "seer.v1.political.summary", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "data": { "type": "array", "items": [] } }, "required": [ "generated_at", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/dashboard": { "get": { "operationId": "seer.v1.political.dashboard", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "requested_year": { "type": "string" }, "event_scope": { "type": "string" }, "industry": { "type": "string" }, "political": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "requested_year", "event_scope", "industry", "political" ] }, "data": { "anyOf": [ { "type": "array", "items": [] }, { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "available_years": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_year": { "type": "string" }, "event_scope": { "type": "string" }, "event_scope_options": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "all" ] }, "label": { "type": "string", "enum": [ "All records" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "election" ] }, "label": { "type": "string", "enum": [ "Election only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "annual" ] }, "label": { "type": "string", "enum": [ "Annual only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "referendum" ] }, "label": { "type": "string", "enum": [ "Referendum only" ] } }, "required": [ "key", "label" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "industries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_industry": { "type": [ "string", "null" ] } }, "required": [ "available_years", "selected_year", "event_scope", "event_scope_options", "industries", "selected_industry" ] }, "totals": { "type": "object", "properties": { "donation_count": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "integer", "enum": [ 0 ] }, "unique_donors": { "type": "integer", "enum": [ 0 ] }, "unique_recipients": { "type": "integer", "enum": [ 0 ] }, "first_donation_date": { "type": "null" }, "last_donation_date": { "type": "null" }, "average_donation": { "type": "integer", "enum": [ 0 ] } }, "required": [ "donation_count", "total_amount", "unique_donors", "unique_recipients", "first_donation_date", "last_donation_date", "average_donation" ] }, "money_map": { "type": "object", "properties": { "selected_year": { "type": "string" }, "total_received": { "type": "integer", "enum": [ 0 ] }, "donation_count": { "type": "integer", "enum": [ 0 ] }, "average_donation": { "type": "integer", "enum": [ 0 ] }, "corporate_pct": { "type": "integer", "enum": [ 0 ] }, "individual_pct": { "type": "integer", "enum": [ 0 ] }, "party_totals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "source_split": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "party_source_split": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "party_trends": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_donors": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "selected_year", "total_received", "donation_count", "average_donation", "corporate_pct", "individual_pct", "party_totals", "source_split", "party_source_split", "party_trends", "top_donors" ] }, "donors": { "type": "object", "properties": { "donor_count": { "type": "integer", "enum": [ 0 ] }, "discover_linked_donor_count": { "type": "integer", "enum": [ 0 ] }, "top": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "cross_party": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "donor_types": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_corporate_groups": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "largest_transactions": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "recent_transactions": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "donor_count", "discover_linked_donor_count", "top", "cross_party", "donor_types", "top_corporate_groups", "largest_transactions", "recent_transactions" ] }, "recipients": { "type": "object", "properties": { "all": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "parties": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "departments": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "others": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "all", "parties", "departments", "others" ] }, "risk_scores": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "industry": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "heatmap": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "bubbles": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "cross_party_industries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "rows", "heatmap", "bubbles", "cross_party_industries" ] }, "geography": { "type": "object", "properties": { "postcode_rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "state_rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "electorate_rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "electorate_message": { "type": "null" } }, "required": [ "postcode_rows", "state_rows", "electorate_rows", "electorate_message" ] }, "elections": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "election" ] }, "totals": { "type": "object", "properties": { "donation_count": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "integer", "enum": [ 0 ] }, "unique_donors": { "type": "integer", "enum": [ 0 ] }, "unique_recipients": { "type": "integer", "enum": [ 0 ] }, "first_donation_date": { "type": "null" }, "last_donation_date": { "type": "null" }, "average_donation": { "type": "integer", "enum": [ 0 ] } }, "required": [ "donation_count", "total_amount", "unique_donors", "unique_recipients", "first_donation_date", "last_donation_date", "average_donation" ] }, "party_totals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "timeline": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "media": { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "message": { "type": "string", "enum": [ "Dedicated media-spend ingestion table not connected yet. This panel shows any media-tagged donation rows currently available." ] } }, "required": [ "available", "rows", "message" ] }, "top_entities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "scope", "totals", "party_totals", "timeline", "media", "top_entities" ] }, "referendum": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "referendum" ] }, "totals": { "type": "object", "properties": { "donation_count": { "type": "integer", "enum": [ 0 ] }, "total_amount": { "type": "integer", "enum": [ 0 ] }, "unique_donors": { "type": "integer", "enum": [ 0 ] }, "unique_recipients": { "type": "integer", "enum": [ 0 ] }, "first_donation_date": { "type": "null" }, "last_donation_date": { "type": "null" }, "average_donation": { "type": "integer", "enum": [ 0 ] } }, "required": [ "donation_count", "total_amount", "unique_donors", "unique_recipients", "first_donation_date", "last_donation_date", "average_donation" ] }, "party_totals": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "timeline": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "media": { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "message": { "type": "string", "enum": [ "Dedicated media-spend ingestion table not connected yet. This panel shows any media-tagged donation rows currently available." ] } }, "required": [ "available", "rows", "message" ] }, "top_entities": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "scope", "totals", "party_totals", "timeline", "media", "top_entities" ] }, "office_graph": { "type": "object", "properties": { "available": { "type": "string" }, "nodes": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "jurisdiction" ] }, "value": { "type": "number" }, "meta": { "type": "object", "properties": { "level": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "level", "state_code", "website_url", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "party" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "jurisdiction_key": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "logo_source_url": { "type": [ "string", "null" ] }, "colour_hex": { "type": [ "string", "null" ] }, "fallback_initials": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "jurisdiction_key", "website_url", "logo_url", "logo_source_url", "colour_hex", "fallback_initials", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "seat" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "jurisdiction_key": { "type": [ "string", "null" ] }, "chamber": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "jurisdiction_key", "chamber", "status", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "officeholder" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "party_key": { "type": [ "string", "null" ] }, "party_name": { "type": [ "string", "null" ] }, "jurisdiction_key": { "type": [ "string", "null" ] }, "chamber": { "type": [ "string", "null" ] }, "seat_key": { "type": [ "string", "null" ] }, "role_title": { "type": [ "string", "null" ] }, "ministry_role": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "party_key", "party_name", "jurisdiction_key", "chamber", "seat_key", "role_title", "ministry_role", "website_url", "source_url", "image_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "promise" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "status": { "type": [ "string", "null" ] }, "reviewer_status": { "type": [ "string", "null" ] }, "policy_area": { "type": [ "string", "null" ] }, "jurisdiction_key": { "type": [ "string", "null" ] }, "evidence_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "status", "reviewer_status", "policy_area", "jurisdiction_key", "evidence_url", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "policy" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "jurisdiction_key": { "type": [ "string", "null" ] } }, "required": [ "jurisdiction_key" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "release", "article" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "source_type": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "article" ] } ] }, "source_name": { "type": [ "string", "null" ] }, "published_at": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "policy_area": { "type": [ "string", "null" ] } }, "required": [ "source_type", "source_name", "published_at", "url", "policy_area" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "string" }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "Linked business" ] } ] }, "type": { "type": "string", "enum": [ "business" ] }, "value": { "type": "number" }, "meta": { "type": "object", "properties": { "slug": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "slug", "url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "industry" ] }, "value": { "type": "number" }, "meta": { "type": "object", "properties": { "industry_slug": { "type": "string" } }, "required": [ "industry_slug" ] } }, "required": [ "id", "label", "type", "value", "meta" ] } ] } }, "edges": { "type": "array", "items": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "within_jurisdiction" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "filled_by_party" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] } ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "holds_seat" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] } ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "within_jurisdiction" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "member_of_party" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "promise_about" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "responsible_for" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "mentioned_in" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "mentioned_in" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": "string" }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": [ "string", "null" ] }, "target": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "value": { "type": "number" }, "count": { "type": "integer" }, "source_urls": { "type": "array", "items": [] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "": { "type": "string" }, "source_urls": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "confidence": { "type": "number", "enum": [ 0.7 ] }, "observed_at": { "type": "null" }, "freshness_at": { "type": "null" } }, "required": [ null, "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "linked_business" ] }, "value": { "type": "number" }, "count": { "type": "string" }, "source_urls": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "confidence": { "type": "number", "enum": [ 0.75 ] }, "observed_at": { "type": "null" }, "freshness_at": { "type": "null" } }, "required": [ "source", "target", "type", "value", "count", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "linked_industry" ] }, "value": { "type": "number" }, "count": { "type": "string" }, "source_urls": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "confidence": { "type": "number", "enum": [ 0.65 ] }, "observed_at": { "type": "null" }, "freshness_at": { "type": "null" } }, "required": [ "source", "target", "type", "value", "count", "source_urls", "confidence", "observed_at", "freshness_at" ] } ] } }, "stats": { "type": "object", "properties": { "node_count": { "type": "integer" }, "edge_count": { "type": "integer" }, "max_node_value": { "type": "number" }, "supports_officeholder_edges": { "type": "boolean" }, "supports_promise_edges": { "type": "boolean" }, "supports_news_edges": { "type": "boolean" }, "supports_money_edges": { "type": "boolean" } }, "required": [ "node_count", "edge_count", "max_node_value", "supports_officeholder_edges", "supports_promise_edges", "supports_news_edges", "supports_money_edges" ] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Office graph facts are not available yet. Money-only graph data appears once AEC donation rows are ingested." ] } }, "required": [ "status", "message" ] } }, "required": [ "available", "nodes", "edges", "stats", "diagnostics" ] }, "parliaments": { "type": "object", "properties": { "available": { "type": "string" }, "jurisdictions": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] }, "chambers": { "type": "array", "items": { "type": "object", "properties": { "jurisdiction_key": { "type": "string" }, "chamber": { "type": "string" }, "seat_count": { "type": "integer", "minimum": 0 }, "filled_seat_count": { "type": "integer", "minimum": 0 }, "vacant_seat_count": { "type": "integer", "minimum": 0 }, "party_breakdown": { "type": "array", "items": { "type": "object", "properties": { "party_key": { "type": "string" }, "party_name": { "type": [ "string", "null" ] }, "seats": { "type": "integer", "minimum": 0 }, "filled_seats": { "type": "integer", "minimum": 0 }, "logo_url": { "type": [ "string", "null" ] }, "colour_hex": { "type": [ "string", "null" ] }, "fallback_initials": { "type": [ "string", "null" ] } }, "required": [ "party_key", "party_name", "seats", "filled_seats", "logo_url", "colour_hex", "fallback_initials" ] } } }, "required": [ "jurisdiction_key", "chamber", "seat_count", "filled_seat_count", "vacant_seat_count", "party_breakdown" ] } }, "officeholders": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] }, "party_assets": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_parties" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_parties" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_parties" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_parties" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Parliament, seat, and officeholder facts are not available in the analytics layer yet." ] } }, "required": [ "status", "message" ] } }, "required": [ "available", "jurisdictions", "chambers", "officeholders", "party_assets", "diagnostics" ] }, "promise_tracker": { "type": "object", "properties": { "composition": { "type": "object", "properties": { "available": { "type": "boolean" }, "majority_threshold": { "type": "integer" }, "seats": { "type": "array", "items": { "type": "object", "properties": { "party": { "type": "string" }, "seats": { "type": "integer", "minimum": 0 } }, "required": [ "party", "seats" ] } }, "message": { "type": [ "string", "null" ], "enum": [ "Parliament seat composition facts are not available for the selected filters yet." ] } }, "required": [ "available", "majority_threshold", "seats", "message" ] }, "promises": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "promise_key": { "type": [ "string", "null" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "Untitled promise" ] } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "Not Started" ] } ] }, "reviewer_status": { "type": [ "string", "null" ] }, "policy_area": { "type": [ "string", "null" ] }, "jurisdiction_key": { "type": [ "string", "null" ] }, "party_key": { "type": [ "string", "null" ] }, "party_name": { "type": [ "string", "null" ] }, "officeholder_key": { "type": [ "string", "null" ] }, "officeholder_name": { "type": [ "string", "null" ] }, "date_promised": { "type": [ "string", "null" ] }, "related_bill": { "type": [ "string", "null" ] }, "evidence_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] }, "last_checked_at": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "required": [ "promise_key", "title", "status", "reviewer_status", "policy_area", "jurisdiction_key", "party_key", "party_name", "officeholder_key", "officeholder_name", "date_promised", "related_bill", "evidence_url", "source_url", "last_checked_at", "notes" ] }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "status_breakdown": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "count": { "type": "integer", "minimum": 0 } }, "required": [ "status", "count" ] } }, "available": { "type": "boolean" }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "missing_data" ] }, "message": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "Promise facts are connected but no reviewed promises matched the selected filters." ] } ] } }, "required": [ "status", "message" ] } }, "required": [ "composition", "promises", "status_breakdown", "available", "diagnostics" ] }, "news": { "anyOf": [ { "type": "object", "properties": { "articles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "event_key": { "type": [ "string", "null" ] }, "source_type": { "type": [ "string", "null" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "Untitled source event" ] } ] }, "url": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "published_at": { "type": [ "string", "null" ] }, "sentiment_score": { "type": [ "number", "null" ] }, "source_name": { "type": [ "string", "null" ] }, "jurisdiction_key": { "type": [ "string", "null" ] }, "party_key": { "type": [ "string", "null" ] }, "officeholder_key": { "type": [ "string", "null" ] }, "policy_area": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "color": { "type": "null" } }, "required": [ "name", "slug", "color" ] } } }, "required": [ "id", "event_key", "source_type", "title", "url", "summary", "published_at", "sentiment_score", "source_name", "jurisdiction_key", "party_key", "officeholder_key", "policy_area", "tags" ] } }, "top_tags": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "count": { "type": "integer", "minimum": 0 } }, "required": [ "slug", "name", "count" ] } }, "message": { "type": [ "string", "null" ], "enum": [ "Political news and release facts are connected but no rows matched the selected filters." ] }, "available": { "type": "boolean" } }, "required": [ "articles", "top_tags", "message", "available" ] }, { "type": "object", "properties": { "articles": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "top_tags": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "message": { "type": "string" }, "available": { "type": "boolean" } }, "required": [ "articles", "top_tags", "message", "available" ] } ] }, "source_status": { "type": "array", "items": [] }, "influence_graph": { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "edges": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "stats": { "type": "object", "properties": { "node_count": { "type": "integer", "enum": [ 0 ] }, "edge_count": { "type": "integer", "enum": [ 0 ] }, "supports_directorship_edges": { "type": "boolean" }, "supports_ownership_edges": { "type": "boolean" } }, "required": [ "node_count", "edge_count", "supports_directorship_edges", "supports_ownership_edges" ] } }, "required": [ "nodes", "edges", "stats" ] }, "paid": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "locked_reason": { "type": [ "string", "null" ], "enum": [ "Upgrade to paid intelligence to unlock influence graph internals, donor intelligence, and advanced election/referendum breakdowns." ] } }, "required": [ "enabled", "locked_reason" ] }, "meta": { "type": "object", "properties": { "source_table": { "type": "string", "enum": [ "none" ] }, "row_count": { "type": "integer", "enum": [ 0 ] }, "has_data": { "type": "boolean" }, "supports_directorship_edges": { "type": "boolean" }, "supports_ownership_edges": { "type": "boolean" }, "supports_media_spend_ingestion": { "type": "boolean" } }, "required": [ "source_table", "row_count", "has_data", "supports_directorship_edges", "supports_ownership_edges", "supports_media_spend_ingestion" ] } }, "required": [ "generated_at", "filters", "totals", "money_map", "donors", "recipients", "risk_scores", "industry", "geography", "elections", "referendum", "office_graph", "parliaments", "promise_tracker", "news", "source_status", "influence_graph", "paid", "meta" ] } ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/parties/{partyKey}": { "get": { "operationId": "seer.v1.political.parties.show", "tags": [ "SeerPoliticalMachineApi" ], "parameters": [ { "name": "partyKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "party_key": { "type": "string" }, "data": { "anyOf": [ { "type": "array", "items": [] }, { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "available_years": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_year": { "type": "string" }, "event_scope": { "type": "string" }, "event_scope_options": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "all" ] }, "label": { "type": "string", "enum": [ "All records" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "election" ] }, "label": { "type": "string", "enum": [ "Election only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "annual" ] }, "label": { "type": "string", "enum": [ "Annual only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "referendum" ] }, "label": { "type": "string", "enum": [ "Referendum only" ] } }, "required": [ "key", "label" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "industries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_industry": { "type": [ "string", "null" ] } }, "required": [ "available_years", "selected_year", "event_scope", "event_scope_options", "industries", "selected_industry" ] }, "party": { "type": "object", "properties": { "route_key": { "type": "string" }, "name": { "type": "null" }, "found": { "type": "boolean" }, "profile": { "type": "null" } }, "required": [ "route_key", "name", "found", "profile" ] }, "meta": { "type": "object", "properties": { "source_table": { "type": "string", "enum": [ "none" ] }, "row_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "source_table", "row_count" ] } }, "required": [ "generated_at", "filters", "party", "meta" ] } ] } }, "required": [ "generated_at", "party_key", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/departments/{departmentKey}": { "get": { "operationId": "seer.v1.political.departments.show", "tags": [ "SeerPoliticalMachineApi" ], "parameters": [ { "name": "departmentKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "department_key": { "type": "string" }, "data": { "anyOf": [ { "type": "array", "items": [] }, { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "available_years": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_year": { "type": "string" }, "event_scope": { "type": "string" }, "event_scope_options": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "all" ] }, "label": { "type": "string", "enum": [ "All records" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "election" ] }, "label": { "type": "string", "enum": [ "Election only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "annual" ] }, "label": { "type": "string", "enum": [ "Annual only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "referendum" ] }, "label": { "type": "string", "enum": [ "Referendum only" ] } }, "required": [ "key", "label" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "industries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_industry": { "type": [ "string", "null" ] } }, "required": [ "available_years", "selected_year", "event_scope", "event_scope_options", "industries", "selected_industry" ] }, "department": { "type": "object", "properties": { "route_key": { "type": "string" }, "name": { "type": "null" }, "found": { "type": "boolean" }, "profile": { "type": "null" } }, "required": [ "route_key", "name", "found", "profile" ] }, "meta": { "type": "object", "properties": { "source_table": { "type": "string", "enum": [ "none" ] }, "row_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "source_table", "row_count" ] } }, "required": [ "generated_at", "filters", "department", "meta" ] } ] } }, "required": [ "generated_at", "department_key", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/donors/{donorKey}": { "get": { "operationId": "seer.v1.political.donors.show", "tags": [ "SeerPoliticalMachineApi" ], "parameters": [ { "name": "donorKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "donor_key": { "type": "string" }, "data": { "anyOf": [ { "type": "array", "items": [] }, { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "properties": { "available_years": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_year": { "type": "string" }, "event_scope": { "type": "string" }, "event_scope_options": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "key": { "type": "string", "enum": [ "all" ] }, "label": { "type": "string", "enum": [ "All records" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "election" ] }, "label": { "type": "string", "enum": [ "Election only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "annual" ] }, "label": { "type": "string", "enum": [ "Annual only" ] } }, "required": [ "key", "label" ] }, { "type": "object", "properties": { "key": { "type": "string", "enum": [ "referendum" ] }, "label": { "type": "string", "enum": [ "Referendum only" ] } }, "required": [ "key", "label" ] } ], "minItems": 4, "maxItems": 4, "additionalItems": false }, "industries": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "selected_industry": { "type": [ "string", "null" ] } }, "required": [ "available_years", "selected_year", "event_scope", "event_scope_options", "industries", "selected_industry" ] }, "donor": { "type": "object", "properties": { "route_key": { "type": "string" }, "key": { "type": "null" }, "found": { "type": "boolean" }, "profile": { "type": "null" } }, "required": [ "route_key", "key", "found", "profile" ] }, "meta": { "type": "object", "properties": { "source_table": { "type": "string", "enum": [ "none" ] }, "row_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "source_table", "row_count" ] } }, "required": [ "generated_at", "filters", "donor", "meta" ] } ] } }, "required": [ "generated_at", "donor_key", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/officeholders": { "get": { "operationId": "seer.v1.political.officeholders.index", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_officeholders" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/seats": { "get": { "operationId": "seer.v1.political.seats.index", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_seats" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_seats" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_seats" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_seats" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/jurisdictions": { "get": { "operationId": "seer.v1.political.jurisdictions.index", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_jurisdictions" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/promises": { "get": { "operationId": "seer.v1.political.promises.index", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_promises" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_promises" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_promises" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_promises" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/news": { "get": { "operationId": "seer.v1.political.news.index", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "source_table": { "type": "string" }, "rows": { "type": "array", "items": [] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "empty", "ok" ] }, "fact_key": { "type": "string", "enum": [ "political_source_events" ] }, "message": { "type": [ "string", "null" ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "source_table", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "query_failed" ] }, "fact_key": { "type": "string", "enum": [ "political_source_events" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_source_events" ] }, "message": { "type": "string" } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "missing_data" ] }, "fact_key": { "type": "string", "enum": [ "political_source_events" ] }, "message": { "type": "string", "enum": [ "Political intelligence facts are unavailable because the analytics store is not enabled." ] } }, "required": [ "status", "fact_key", "message" ] } }, "required": [ "available", "rows", "diagnostics" ] } ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/graph": { "get": { "operationId": "seer.v1.political.graph", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "type": "object", "properties": { "available": { "type": "string" }, "nodes": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "jurisdiction" ] }, "value": { "type": "number" }, "meta": { "type": "object", "properties": { "level": { "type": [ "string", "null" ] }, "state_code": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "level", "state_code", "website_url", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "party" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "jurisdiction_key": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "logo_source_url": { "type": [ "string", "null" ] }, "colour_hex": { "type": [ "string", "null" ] }, "fallback_initials": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "jurisdiction_key", "website_url", "logo_url", "logo_source_url", "colour_hex", "fallback_initials", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "seat" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "jurisdiction_key": { "type": [ "string", "null" ] }, "chamber": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "jurisdiction_key", "chamber", "status", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "officeholder" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "party_key": { "type": [ "string", "null" ] }, "party_name": { "type": [ "string", "null" ] }, "jurisdiction_key": { "type": [ "string", "null" ] }, "chamber": { "type": [ "string", "null" ] }, "seat_key": { "type": [ "string", "null" ] }, "role_title": { "type": [ "string", "null" ] }, "ministry_role": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "required": [ "party_key", "party_name", "jurisdiction_key", "chamber", "seat_key", "role_title", "ministry_role", "website_url", "source_url", "image_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "promise" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "status": { "type": [ "string", "null" ] }, "reviewer_status": { "type": [ "string", "null" ] }, "policy_area": { "type": [ "string", "null" ] }, "jurisdiction_key": { "type": [ "string", "null" ] }, "evidence_url": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] } }, "required": [ "status", "reviewer_status", "policy_area", "jurisdiction_key", "evidence_url", "source_url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "policy" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "jurisdiction_key": { "type": [ "string", "null" ] } }, "required": [ "jurisdiction_key" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "release", "article" ] }, "value": { "type": "integer", "enum": [ 1 ] }, "meta": { "type": "object", "properties": { "source_type": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "article" ] } ] }, "source_name": { "type": [ "string", "null" ] }, "published_at": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "policy_area": { "type": [ "string", "null" ] } }, "required": [ "source_type", "source_name", "published_at", "url", "policy_area" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "string" }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "Linked business" ] } ] }, "type": { "type": "string", "enum": [ "business" ] }, "value": { "type": "number" }, "meta": { "type": "object", "properties": { "slug": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] } }, "required": [ "slug", "url" ] } }, "required": [ "id", "label", "type", "value", "meta" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "industry" ] }, "value": { "type": "number" }, "meta": { "type": "object", "properties": { "industry_slug": { "type": "string" } }, "required": [ "industry_slug" ] } }, "required": [ "id", "label", "type", "value", "meta" ] } ] } }, "edges": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "within_jurisdiction" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "filled_by_party" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "holds_seat" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "member_of_party" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "promise_about" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "responsible_for" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "mentioned_in" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": [ "string", "null" ] }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "mentioned_in" ] }, "value": { "type": "number", "enum": [ 1 ] }, "count": { "type": "integer", "enum": [ 1 ] }, "source_label": { "type": [ "string", "null" ] }, "target_label": { "type": "string" }, "source_urls": { "anyOf": [ { "type": "array", "prefixItems": [ { "type": [ "string", "null" ] } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_label", "target_label", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": [ "string", "null" ] }, "target": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "value": { "type": "number" }, "count": { "type": "integer" }, "source_urls": { "type": "array", "items": [] }, "confidence": { "type": "number" }, "observed_at": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] } }, "required": [ "source", "target", "type", "value", "count", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "": { "type": "string" }, "source_urls": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "confidence": { "type": "number", "enum": [ 0.7 ] }, "observed_at": { "type": "null" }, "freshness_at": { "type": "null" } }, "required": [ null, "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "linked_business" ] }, "value": { "type": "number" }, "count": { "type": "string" }, "source_urls": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "confidence": { "type": "number", "enum": [ 0.75 ] }, "observed_at": { "type": "null" }, "freshness_at": { "type": "null" } }, "required": [ "source", "target", "type", "value", "count", "source_urls", "confidence", "observed_at", "freshness_at" ] }, { "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "type": { "type": "string", "enum": [ "linked_industry" ] }, "value": { "type": "number" }, "count": { "type": "string" }, "source_urls": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "confidence": { "type": "number", "enum": [ 0.65 ] }, "observed_at": { "type": "null" }, "freshness_at": { "type": "null" } }, "required": [ "source", "target", "type", "value", "count", "source_urls", "confidence", "observed_at", "freshness_at" ] } ] } }, "stats": { "type": "object", "properties": { "node_count": { "type": "integer" }, "edge_count": { "type": "integer" }, "max_node_value": { "type": "number" }, "supports_officeholder_edges": { "type": "boolean" }, "supports_promise_edges": { "type": "boolean" }, "supports_news_edges": { "type": "boolean" }, "supports_money_edges": { "type": "boolean" } }, "required": [ "node_count", "edge_count", "max_node_value", "supports_officeholder_edges", "supports_promise_edges", "supports_news_edges", "supports_money_edges" ] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok", "missing_data" ] }, "message": { "type": [ "string", "null" ], "enum": [ "Office graph facts are not available yet. Money-only graph data appears once AEC donation rows are ingested." ] } }, "required": [ "status", "message" ] } }, "required": [ "available", "nodes", "edges", "stats", "diagnostics" ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/sources/status": { "get": { "operationId": "seer.v1.political.sources.status", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "type": "array", "items": [] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/political-machine/alerts": { "get": { "operationId": "seer.v1.political.alerts", "tags": [ "SeerPoliticalMachineApi" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "generated_at": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "data": { "type": "object", "properties": { "available": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "alert_key": { "type": "string" }, "severity": { "type": "string", "enum": [ "high", "medium" ] }, "title": { "type": "string" }, "message": { "type": "string" }, "source_type": { "type": "string" }, "jurisdiction_key": { "type": "string" }, "freshness_at": { "type": [ "string", "null" ] }, "source_url": { "type": "string" } }, "required": [ "alert_key", "severity", "title", "message", "source_type", "jurisdiction_key", "freshness_at", "source_url" ] } }, "diagnostics": [] }, "required": [ "available", "rows", "diagnostics" ] } }, "required": [ "generated_at", "filters", "data" ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/rba/status": { "get": { "operationId": "seer.v1.rba.status", "tags": [ "SeerRba" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/rba/tables": { "get": { "operationId": "seer.v1.rba.tables", "tags": [ "SeerRba" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 160 } }, { "name": "source", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 1000000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "tables": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "count", "total", "tables", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "tables": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "count", "total", "tables", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/rba/tables/{tableCode}": { "get": { "operationId": "seer.v1.rba.tables.show", "tags": [ "SeerRba" ], "parameters": [ { "name": "tableCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "table": { "type": "object", "properties": { "table_code": { "type": "string" }, "table_name": { "type": "string" }, "title": { "type": "string" }, "source_url": { "type": "string" }, "csv_url": { "type": "string" }, "xls_url": { "type": "string" }, "source_names": { "type": "array", "items": [] }, "source_warning": { "type": "string" }, "has_third_party_sources": { "type": "boolean" }, "series_count": { "type": "integer" }, "observation_count": { "type": "integer" }, "publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "terms_url": { "type": "string" }, "copyright_url": { "type": "string" }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "table_code", "table_name", "title", "source_url", "csv_url", "xls_url", "source_names", "source_warning", "has_third_party_sources", "series_count", "observation_count", "publication_date", "latest_observation_date", "freshness_at", "terms_url", "copyright_url", "updated_at" ] }, "series": { "type": "array", "items": [] }, "warnings": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "table", "series", "warnings", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "warnings": { "type": "array", "items": [] } }, "required": [ "warnings" ] }, { "type": "null" }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "table_code": { "type": "string" }, "table": { "type": "null" } }, "required": [ "data_status", "table_code", "table" ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "table": { "type": "object", "properties": { "table_code": { "type": "string" }, "table_name": { "type": "string" }, "title": { "type": "string" }, "source_url": { "type": "string" }, "csv_url": { "type": "string" }, "xls_url": { "type": "string" }, "source_names": { "type": "array", "items": [] }, "source_warning": { "type": "string" }, "has_third_party_sources": { "type": "boolean" }, "series_count": { "type": "integer" }, "observation_count": { "type": "integer" }, "publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "terms_url": { "type": "string" }, "copyright_url": { "type": "string" }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "table_code", "table_name", "title", "source_url", "csv_url", "xls_url", "source_names", "source_warning", "has_third_party_sources", "series_count", "observation_count", "publication_date", "latest_observation_date", "freshness_at", "terms_url", "copyright_url", "updated_at" ] }, "series": { "type": "array", "items": [] }, "warnings": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "table", "series", "warnings", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "warnings": { "type": "array", "items": [] } }, "required": [ "warnings" ] }, { "type": "null" }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/rba/series": { "get": { "operationId": "seer.v1.rba.series", "tags": [ "SeerRba" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 160 } }, { "name": "table_code", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "source", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "frequency", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 80 } }, { "name": "third_party", "in": "query", "schema": { "type": [ "boolean", "null" ] } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 1000 } }, { "name": "offset", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 1000000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "series": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "count", "total", "series", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "series": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "count", "total", "series", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/rba/series/{seriesId}/observations": { "get": { "operationId": "seer.v1.rba.series.observations", "tags": [ "SeerRba" ], "parameters": [ { "name": "seriesId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date" } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 10000 } }, { "name": "offset", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 1000000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "series": { "type": "object", "properties": { "series_id": { "type": "string" }, "table_code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "frequency": { "type": "string" }, "type": { "type": "string" }, "units": { "type": "string" }, "source": { "type": "string" }, "publication_date": { "type": [ "string", "null" ] }, "is_third_party_source": { "type": "boolean" }, "source_warning": { "type": "string" }, "terms_url": { "type": "string" }, "source_url": { "type": "string" }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "series_id", "table_code", "title", "description", "frequency", "type", "units", "source", "publication_date", "is_third_party_source", "source_warning", "terms_url", "source_url", "updated_at" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "observations": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "series", "count", "total", "observations", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "series": { "type": "null" }, "count": { "type": "integer", "enum": [ 0 ] }, "total": { "type": "integer", "enum": [ 0 ] }, "observations": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "enum": [ 0 ] }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "series", "count", "total", "observations", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "series": { "type": "object", "properties": { "series_id": { "type": "string" }, "table_code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "frequency": { "type": "string" }, "type": { "type": "string" }, "units": { "type": "string" }, "source": { "type": "string" }, "publication_date": { "type": [ "string", "null" ] }, "is_third_party_source": { "type": "boolean" }, "source_warning": { "type": "string" }, "terms_url": { "type": "string" }, "source_url": { "type": "string" }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "series_id", "table_code", "title", "description", "frequency", "type", "units", "source", "publication_date", "is_third_party_source", "source_warning", "terms_url", "source_url", "updated_at" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "observations": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "series", "count", "total", "observations", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "series": { "type": "null" }, "count": { "type": "integer", "enum": [ 0 ] }, "total": { "type": "integer", "enum": [ 0 ] }, "observations": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "enum": [ 0 ] }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "series", "count", "total", "observations", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "series": { "type": "object", "properties": { "series_id": { "type": "string" }, "table_code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "frequency": { "type": "string" }, "type": { "type": "string" }, "units": { "type": "string" }, "source": { "type": "string" }, "publication_date": { "type": [ "string", "null" ] }, "is_third_party_source": { "type": "boolean" }, "source_warning": { "type": "string" }, "terms_url": { "type": "string" }, "source_url": { "type": "string" }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "series_id", "table_code", "title", "description", "frequency", "type", "units", "source", "publication_date", "is_third_party_source", "source_warning", "terms_url", "source_url", "updated_at" ] }, "count": { "type": "integer" }, "total": { "type": "integer" }, "observations": { "type": "array", "items": [] }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": [ "object", "null" ] }, "total": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "series", "count", "total", "observations", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_read_failed" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "series": { "type": "null" }, "count": { "type": "integer", "enum": [ 0 ] }, "total": { "type": "integer", "enum": [ 0 ] }, "observations": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer", "enum": [ 0 ] }, "has_more": { "type": "boolean" } }, "required": [ "limit", "offset", "total", "has_more" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "series", "count", "total", "observations", "pagination", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": [ "string", "null" ] }, "latest_observation_date": { "type": [ "string", "null" ] }, "freshness_at": { "type": [ "string", "null" ] }, "latest_ingested_at": { "type": [ "string", "null" ] } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "counts": { "type": "object", "properties": { "tables": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "tables_with_source_warnings": { "type": "integer" } }, "required": [ "tables", "series", "observations", "tables_with_source_warnings" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] }, "latest_run": { "type": [ "object", "null" ], "properties": { "run_id": { "type": "string" }, "status": { "type": "string" }, "tables_discovered": { "type": "integer" }, "tables_processed": { "type": "integer" }, "tables_failed": { "type": "integer" }, "series_written": { "type": "integer" }, "observations_written": { "type": "integer" }, "warnings_written": { "type": "integer" }, "started_at": { "type": [ "string", "null" ] }, "finished_at": { "type": [ "string", "null" ] }, "error_state": { "type": [ "string", "null" ], "enum": [ "failed" ] } }, "required": [ "run_id", "status", "tables_discovered", "tables_processed", "tables_failed", "series_written", "observations_written", "warnings_written", "started_at", "finished_at", "error_state" ] } }, "required": [ "data_status", "generated_at", "freshness", "counts", "source_attribution", "latest_run" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_facts_unavailable" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] }, { "type": "object", "properties": { "data_status": { "type": "string", "enum": [ "unavailable" ] }, "generated_at": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_publication_date": { "type": "null" }, "latest_observation_date": { "type": "null" }, "freshness_at": { "type": "null" }, "latest_ingested_at": { "type": "null" } }, "required": [ "latest_publication_date", "latest_observation_date", "freshness_at", "latest_ingested_at" ] }, "diagnostic": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "rba_ingest_disabled" ] }, "message": { "type": "string", "enum": [ "RBA statistical facts are not available in the analytics data layer." ] }, "missing_datasets": { "type": "array", "items": [] } }, "required": [ "reason", "message", "missing_datasets" ] }, "source_attribution": { "type": "object", "properties": { "publisher": { "type": "string", "enum": [ "Reserve Bank of Australia" ] }, "catalogue_url": { "type": "string" }, "terms_url": { "type": "string" } }, "required": [ "publisher", "catalogue_url", "terms_url" ] } }, "required": [ "data_status", "generated_at", "freshness", "diagnostic", "source_attribution" ] } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/risk-compliance": { "get": { "operationId": "seer.v1.risk_compliance.index", "tags": [ "SeerRiskCompliance" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "risk_label": { "type": "string" }, "status": { "type": "string" }, "supplier_tier": { "type": "string" }, "relationship_type": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "region": { "type": "string" }, "source": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "risk_min": { "type": [ "object", "null" ] }, "criticality_min": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "risk_label", "status", "supplier_tier", "relationship_type", "sector", "state", "postcode", "region", "source", "abn", "acn", "asx_symbol", "domain", "risk_min", "criticality_min", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "total_suppliers": { "type": "integer" }, "high_risk_suppliers": { "type": "integer" }, "critical_supplier_count": { "type": "integer" }, "single_point_failure_count": { "type": "integer" }, "average_risk_score": { "type": [ "number", "null" ] }, "risk_label": { "type": "string" }, "latest_assessment_date": { "type": [ "string", "null" ] }, "region_count": { "type": "integer" } }, "required": [ "available", "status", "total_suppliers", "high_risk_suppliers", "critical_supplier_count", "single_point_failure_count", "average_risk_score", "risk_label", "latest_assessment_date", "region_count" ] }, "scorecards": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "dimensions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "total_count": { "type": "integer" } }, "required": [ "available", "status", "rows", "total_count" ] }, "dependencies": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, "cascade": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, "regional": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "scores": { "type": "string" }, "dependencies": { "type": "string" }, "status": { "type": "string" } }, "required": [ "scores", "dependencies", "status" ] }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "score_rows": { "type": "integer" }, "status_rows": { "type": "integer" }, "available_source_status_rows": { "type": "integer" } }, "required": [ "score_rows", "status_rows", "available_source_status_rows" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Risk intelligence is unavailable because no score or source-status rows have been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Risk intelligence is unavailable because required fact tables are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Risk intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "filters", "summary", "scorecards", "dimensions", "dependencies", "cascade", "regional", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "risk_label": { "type": "string" }, "status": { "type": "string" }, "supplier_tier": { "type": "string" }, "relationship_type": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "region": { "type": "string" }, "source": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "risk_min": { "type": [ "object", "null" ] }, "criticality_min": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "risk_label", "status", "supplier_tier", "relationship_type", "sector", "state", "postcode", "region", "source", "abn", "acn", "asx_symbol", "domain", "risk_min", "criticality_min", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "total_suppliers": { "type": "integer", "enum": [ 0 ] }, "high_risk_suppliers": { "type": "integer", "enum": [ 0 ] }, "critical_supplier_count": { "type": "integer", "enum": [ 0 ] }, "single_point_failure_count": { "type": "integer", "enum": [ 0 ] }, "average_risk_score": { "type": "null" }, "risk_label": { "type": "string", "enum": [ "unavailable" ] }, "latest_assessment_date": { "type": "null" }, "region_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "total_suppliers", "high_risk_suppliers", "critical_supplier_count", "single_point_failure_count", "average_risk_score", "risk_label", "latest_assessment_date", "region_count" ] }, "scorecards": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "dimensions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "dependencies": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "cascade": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "regional": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "scorecards", "dimensions", "dependencies", "cascade", "regional", "source_status", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/risk-compliance/business/{business}": { "get": { "operationId": "seer.v1.risk_compliance.business", "tags": [ "SeerRiskCompliance" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "risk_label": { "type": "string" }, "status": { "type": "string" }, "supplier_tier": { "type": "string" }, "relationship_type": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "region": { "type": "string" }, "source": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "risk_min": { "type": [ "object", "null" ] }, "criticality_min": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "risk_label", "status", "supplier_tier", "relationship_type", "sector", "state", "postcode", "region", "source", "abn", "acn", "asx_symbol", "domain", "risk_min", "criticality_min", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "total_suppliers": { "type": "integer" }, "high_risk_suppliers": { "type": "integer" }, "critical_supplier_count": { "type": "integer" }, "single_point_failure_count": { "type": "integer" }, "average_risk_score": { "type": [ "number", "null" ] }, "risk_label": { "type": "string" }, "latest_assessment_date": { "type": [ "string", "null" ] }, "region_count": { "type": "integer" } }, "required": [ "available", "status", "total_suppliers", "high_risk_suppliers", "critical_supplier_count", "single_point_failure_count", "average_risk_score", "risk_label", "latest_assessment_date", "region_count" ] }, "scorecards": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "dimensions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "total_count": { "type": "integer" } }, "required": [ "available", "status", "rows", "total_count" ] }, "dependencies": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, "cascade": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, "regional": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "scores": { "type": "string" }, "dependencies": { "type": "string" }, "status": { "type": "string" } }, "required": [ "scores", "dependencies", "status" ] }, "business_match_where": { "type": "string" }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "score_rows": { "type": "integer" }, "status_rows": { "type": "integer" }, "available_source_status_rows": { "type": "integer" } }, "required": [ "score_rows", "status_rows", "available_source_status_rows" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Risk intelligence is unavailable because no score or source-status rows have been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Risk intelligence is unavailable because required fact tables are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Risk intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "business_match_where", "readiness" ] } }, "required": [ "filters", "summary", "scorecards", "dimensions", "dependencies", "cascade", "regional", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "risk_label": { "type": "string" }, "status": { "type": "string" }, "supplier_tier": { "type": "string" }, "relationship_type": { "type": "string" }, "sector": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "region": { "type": "string" }, "source": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "risk_min": { "type": [ "object", "null" ] }, "criticality_min": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "null" }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "risk_label", "status", "supplier_tier", "relationship_type", "sector", "state", "postcode", "region", "source", "abn", "acn", "asx_symbol", "domain", "risk_min", "criticality_min", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "total_suppliers": { "type": "integer", "enum": [ 0 ] }, "high_risk_suppliers": { "type": "integer", "enum": [ 0 ] }, "critical_supplier_count": { "type": "integer", "enum": [ 0 ] }, "single_point_failure_count": { "type": "integer", "enum": [ 0 ] }, "average_risk_score": { "type": "null" }, "risk_label": { "type": "string", "enum": [ "unavailable" ] }, "latest_assessment_date": { "type": "null" }, "region_count": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "total_suppliers", "high_risk_suppliers", "critical_supplier_count", "single_point_failure_count", "average_risk_score", "risk_label", "latest_assessment_date", "region_count" ] }, "scorecards": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "dimensions": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "dependencies": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "cascade": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "regional": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "scorecards", "dimensions", "dependencies", "cascade", "regional", "source_status", "diagnostics" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/risk-compliance/sources/status": { "get": { "operationId": "seer.v1.risk_compliance.sources.status", "tags": [ "SeerRiskCompliance" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Risk intelligence data unavailable.", "Risk intelligence data stale." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/signals": { "get": { "operationId": "seer.v1.signals.index", "tags": [ "SeerSignal" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string" }, "severity": { "type": "string" }, "direction": { "type": "string" }, "entity_type": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "min_escalation_score": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "type", "category", "severity", "direction", "entity_type", "abn", "acn", "asx_symbol", "domain", "state", "postcode", "sector", "min_escalation_score", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "total_count": { "type": "integer" }, "escalation_count": { "type": "integer" }, "risk_count": { "type": "integer" }, "opportunity_count": { "type": "integer" }, "latest_detected_at": { "type": [ "string", "null" ] }, "average_escalation_score": { "type": "number" } }, "required": [ "available", "status", "total_count", "escalation_count", "risk_count", "opportunity_count", "latest_detected_at", "average_escalation_score" ] }, "feed": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "brief": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "headline": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "No new signals detected in the last 24 hours" ] } ] }, "total_count": { "type": "integer" }, "escalation_count": { "type": "integer" }, "opportunity_count": { "type": "integer" }, "latest_detected_at": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": [] } }, "required": [ "available", "status", "headline", "total_count", "escalation_count", "opportunity_count", "latest_detected_at", "items" ] }, "categories": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "entities": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "events": { "type": "string" }, "status": { "type": "string" } }, "required": [ "events", "status" ] }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "event_rows": { "type": "integer" }, "source_status_rows": { "type": "integer" }, "available_source_status_rows": { "type": "integer" } }, "required": [ "event_rows", "source_status_rows", "available_source_status_rows" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Signal intelligence is unavailable because no signal or source-status rows have been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Signal intelligence is unavailable because signal fact tables are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Signal intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "readiness" ] } }, "required": [ "filters", "summary", "feed", "brief", "categories", "entities", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string" }, "severity": { "type": "string" }, "direction": { "type": "string" }, "entity_type": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "min_escalation_score": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "type", "category", "severity", "direction", "entity_type", "abn", "acn", "asx_symbol", "domain", "state", "postcode", "sector", "min_escalation_score", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "total_count": { "type": "integer", "enum": [ 0 ] }, "escalation_count": { "type": "integer", "enum": [ 0 ] }, "risk_count": { "type": "integer", "enum": [ 0 ] }, "opportunity_count": { "type": "integer", "enum": [ 0 ] }, "latest_detected_at": { "type": "null" }, "average_escalation_score": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "total_count", "escalation_count", "risk_count", "opportunity_count", "latest_detected_at", "average_escalation_score" ] }, "feed": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "brief": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "items" ] }, "categories": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "entities": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "feed", "brief", "categories", "entities", "source_status", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/signals/business/{business}": { "get": { "operationId": "seer.v1.signals.business", "tags": [ "SeerSignal" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string" }, "severity": { "type": "string" }, "direction": { "type": "string" }, "entity_type": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "min_escalation_score": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "type", "category", "severity", "direction", "entity_type", "abn", "acn", "asx_symbol", "domain", "state", "postcode", "sector", "min_escalation_score", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "total_count": { "type": "integer" }, "escalation_count": { "type": "integer" }, "risk_count": { "type": "integer" }, "opportunity_count": { "type": "integer" }, "latest_detected_at": { "type": [ "string", "null" ] }, "average_escalation_score": { "type": "number" } }, "required": [ "available", "status", "total_count", "escalation_count", "risk_count", "opportunity_count", "latest_detected_at", "average_escalation_score" ] }, "feed": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "has_more": { "type": "boolean" } }, "required": [ "available", "status", "rows", "page", "per_page", "has_more" ] }, "brief": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "headline": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "No new signals detected in the last 24 hours" ] } ] }, "total_count": { "type": "integer" }, "escalation_count": { "type": "integer" }, "opportunity_count": { "type": "integer" }, "latest_detected_at": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": [] } }, "required": [ "available", "status", "headline", "total_count", "escalation_count", "opportunity_count", "latest_detected_at", "items" ] }, "categories": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "entities": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": [] } } }, "required": [ "available", "status", "rows" ] }, "source_status": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] }, "debug": { "type": "object", "properties": { "tables": { "type": "object", "properties": { "events": { "type": "string" }, "status": { "type": "string" } }, "required": [ "events", "status" ] }, "business_match_where": { "type": "string" }, "readiness": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "diagnostics": { "type": "object", "properties": { "event_rows": { "type": "integer" }, "source_status_rows": { "type": "integer" }, "available_source_status_rows": { "type": "integer" } }, "required": [ "event_rows", "source_status_rows", "available_source_status_rows" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_data" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Signal intelligence is unavailable because no signal or source-status rows have been materialized yet." ] }, "empty_tables": { "type": "array", "items": [] } }, "required": [ "message", "empty_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "missing_schema" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Signal intelligence is unavailable because signal fact tables are missing." ] }, "missing_tables": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "disabled" ] }, "diagnostics": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Signal intelligence is unavailable because the analytics pipeline is disabled." ] }, "missing_tables": { "type": "array", "items": [] } }, "required": [ "message", "missing_tables" ] } }, "required": [ "available", "status", "diagnostics" ] } ] } }, "required": [ "tables", "business_match_where", "readiness" ] } }, "required": [ "filters", "summary", "feed", "brief", "categories", "entities", "source_status", "debug" ] }, { "type": "object", "properties": { "filters": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "category": { "type": "string" }, "severity": { "type": "string" }, "direction": { "type": "string" }, "entity_type": { "type": "string" }, "abn": { "type": "string" }, "acn": { "type": "string" }, "asx_symbol": { "type": "string" }, "domain": { "type": "string" }, "state": { "type": "string" }, "postcode": { "anyOf": [ { "type": "null" }, { "type": "array", "items": [] }, { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "sector": { "type": "string" }, "min_escalation_score": { "type": [ "object", "null" ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" }, { "type": "string", "enum": [ "" ] } ] }, "q": { "type": "string" }, "page": { "type": [ "object", "null" ] }, "per_page": { "type": [ "object", "null" ] }, "limit": { "type": [ "object", "null" ] } }, "required": [ "source", "type", "category", "severity", "direction", "entity_type", "abn", "acn", "asx_symbol", "domain", "state", "postcode", "sector", "min_escalation_score", "from", "to", "q", "page", "per_page", "limit" ] }, "summary": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "total_count": { "type": "integer", "enum": [ 0 ] }, "escalation_count": { "type": "integer", "enum": [ 0 ] }, "risk_count": { "type": "integer", "enum": [ 0 ] }, "opportunity_count": { "type": "integer", "enum": [ 0 ] }, "latest_detected_at": { "type": "null" }, "average_escalation_score": { "type": "integer", "enum": [ 0 ] } }, "required": [ "available", "status", "message", "total_count", "escalation_count", "risk_count", "opportunity_count", "latest_detected_at", "average_escalation_score" ] }, "feed": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "brief": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "items": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "items" ] }, "categories": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "entities": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "source_status": { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal intelligence unavailable.", "Signal intelligence has not been materialized yet." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "available", "status", "message", "rows" ] }, "diagnostics": { "type": "string" } }, "required": [ "filters", "summary", "feed", "brief", "categories", "entities", "source_status", "diagnostics" ] } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/signals/sources/status": { "get": { "operationId": "seer.v1.signals.sources.status", "tags": [ "SeerSignal" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "rows": { "type": "array", "items": [] } }, "required": [ "available", "status", "rows" ] }, { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string" }, "message": { "type": "string", "enum": [ "Signal source status unavailable." ] }, "rows": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false }, "diagnostics": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "available", "status", "message", "rows", "diagnostics" ] } ] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/trust/business/{business}": { "get": { "operationId": "seer.v1.trust.business", "tags": [ "SeerTrust" ], "parameters": [ { "name": "business", "in": "path", "required": true, "description": "The business ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "identity": { "type": "object", "properties": { "target_type": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "target_key": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "discover_business_id": { "anyOf": [ { "type": [ "object", "null" ] }, { "type": "integer", "enum": [ 0 ] } ] }, "abn": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "label": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "score_key": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] } }, "required": [ "target_type", "target_key", "discover_business_id", "abn", "acn", "domain", "label", "score_key" ] }, "summary": { "type": "object", "properties": { "score_count": { "type": "integer" }, "evidence_count": { "type": "integer" }, "contradiction_count": { "type": "integer" }, "temporal_snapshot_count": { "type": "integer" }, "source_diversity_count": { "type": "integer" }, "average_confidence": { "type": [ "number", "null" ] }, "lowest_confidence_score": { "type": [ "number", "null" ] }, "latest_evidence_at": { "type": "string" }, "status_label": { "type": "string", "enum": [ "Evidence aligned", "Contradictions surfaced" ] } }, "required": [ "score_count", "evidence_count", "contradiction_count", "temporal_snapshot_count", "source_diversity_count", "average_confidence", "lowest_confidence_score", "latest_evidence_at", "status_label" ] }, "scores": { "type": "array", "items": [] }, "evidence_chain": { "type": "array", "items": [] }, "contradictory_evidence": { "type": "array", "items": [] }, "temporal_tracking": { "type": "object", "properties": { "snapshots": { "type": "array", "items": [] } }, "required": [ "snapshots" ] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available" ] }, "sources": { "anyOf": [ [], { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "status", "sources" ] }, "debug": { "type": "object", "properties": { "storage": { "type": "string", "enum": [ "clickhouse" ] }, "tables": { "type": "object", "properties": { "scores": { "type": "string" }, "evidence": { "type": "string" }, "contradictions": { "type": "string" }, "temporal_snapshots": { "type": "string" } }, "required": [ "scores", "evidence", "contradictions", "temporal_snapshots" ] }, "readiness": { "type": "object", "additionalProperties": [] } }, "required": [ "storage", "tables", "readiness" ] } }, "required": [ "available", "status", "generated_at", "identity", "summary", "scores", "evidence_chain", "contradictory_evidence", "temporal_tracking", "diagnostics", "debug" ] }, { "type": "array", "items": { "anyOf": [ [], { "type": "array", "items": [] } ] } } ] } } } }, "404": { "$ref": "#/components/responses/ModelNotFoundException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/trust/explain": { "get": { "operationId": "seer.v1.trust.explain", "tags": [ "SeerTrust" ], "parameters": [ { "name": "target_type", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 40 } }, { "name": "target_key", "in": "query", "required": true, "schema": { "type": "string", "maxLength": 180 } }, { "name": "score_key", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 120 } }, { "name": "discover_business_id", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1 } }, { "name": "abn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "acn", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 30 } }, { "name": "domain", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 180 } }, { "name": "label", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 180 } }, { "name": "limit", "in": "query", "schema": { "type": [ "integer", "null" ], "minimum": 1, "maximum": 25 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "enum": [ "available" ] }, "generated_at": { "type": "string" }, "identity": { "type": "object", "properties": { "target_type": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "target_key": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "discover_business_id": { "anyOf": [ { "type": [ "object", "null" ] }, { "type": "integer", "enum": [ 0 ] } ] }, "abn": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "acn": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "label": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] }, "score_key": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "" ] } ] } }, "required": [ "target_type", "target_key", "discover_business_id", "abn", "acn", "domain", "label", "score_key" ] }, "summary": { "type": "object", "properties": { "score_count": { "type": "integer" }, "evidence_count": { "type": "integer" }, "contradiction_count": { "type": "integer" }, "temporal_snapshot_count": { "type": "integer" }, "source_diversity_count": { "type": "integer" }, "average_confidence": { "type": [ "number", "null" ] }, "lowest_confidence_score": { "type": [ "number", "null" ] }, "latest_evidence_at": { "type": "string" }, "status_label": { "type": "string", "enum": [ "Evidence aligned", "Contradictions surfaced" ] } }, "required": [ "score_count", "evidence_count", "contradiction_count", "temporal_snapshot_count", "source_diversity_count", "average_confidence", "lowest_confidence_score", "latest_evidence_at", "status_label" ] }, "scores": { "type": "array", "items": [] }, "evidence_chain": { "type": "array", "items": [] }, "contradictory_evidence": { "type": "array", "items": [] }, "temporal_tracking": { "type": "object", "properties": { "snapshots": { "type": "array", "items": [] } }, "required": [ "snapshots" ] }, "diagnostics": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "available" ] }, "sources": { "anyOf": [ [], { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "status", "sources" ] }, "debug": { "type": "object", "properties": { "storage": { "type": "string", "enum": [ "clickhouse" ] }, "tables": { "type": "object", "properties": { "scores": { "type": "string" }, "evidence": { "type": "string" }, "contradictions": { "type": "string" }, "temporal_snapshots": { "type": "string" } }, "required": [ "scores", "evidence", "contradictions", "temporal_snapshots" ] }, "readiness": { "type": "object", "additionalProperties": [] } }, "required": [ "storage", "tables", "readiness" ] } }, "required": [ "available", "status", "generated_at", "identity", "summary", "scores", "evidence_chain", "contradictory_evidence", "temporal_tracking", "diagnostics", "debug" ] }, { "type": "array", "items": { "anyOf": [ [], { "type": "array", "items": [] } ] } } ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } }, "/seer/v1/trust/sources/status": { "get": { "operationId": "seer.v1.trust.sources.status", "tags": [ "SeerTrust" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": [] } } } }, "401": { "$ref": "#/components/responses/AuthenticationException" } } } } }, "components": { "responses": { "AuthenticationException": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }