get_factory_scorecard

Get the factory scorecard

read entity tenant-private since 2026-10-01

Reads the Factory scorecard's live source off the broker's board snapshot: cost, touches and runner minutes per merged PR and Phase 2's targets over TRA-810's day records (by 7 and 28 days), the board's customer and open-bug counts, flow and stuck tickets, with when the snapshot was made and how old it is. The same figures the board report's Scorecard section prints. Staff only.

Contract

shape: entity
authority: read
evidence: none
subscription: false
permission: any one of: staff.read (the staff role staff_read held in the Internal org, tradehq_role.staff_role); a deactivated caller is refused first
idempotency: safe
emits: none
MCP tool: get_factory_scorecard
REST: POST https://api.containertradehq.com/v1/cap/get_factory_scorecard

Idempotency: a read: calling again changes nothing

Inputs

name	type	required	validation
org_id	org_id	required	tradehq-org-id; 1 to 20 characters The org the staff member's session acts in.

Response

source · object · The broker's factory_scorecard answer, contract factory-scorecard-source/1: generated_at, age_seconds, refreshing, last_build_failed, scorecard, factory, flow and stuck; while no snapshot is held, generated_at null and unavailable naming why.

Full JSON Schema

{
  "type": "object",
  "properties": {
    "source": {
      "type": "object",
      "description": "The broker's factory_scorecard answer, contract factory-scorecard-source/1: generated_at, age_seconds, refreshing, last_build_failed, scorecard, factory, flow and stuck; while no snapshot is held, generated_at null and unavailable naming why.",
      "x-data-class": "operational"
    }
  },
  "required": [
    "source"
  ],
  "additionalProperties": false
}

Refusals

scorecard_unavailable · 422 · the board snapshot could not be read just now: this deployment holds no broker credential, or the broker did not answer; nothing was changed

The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.

Surfaces

DesktopF

MobileF

APIF

MCPF

VoiceD4

PushN

OneBoxN

OutboundN

Voice: degraded: visualization
Push: emits nothing
OneBox: no document originates the factory's scorecard
Outbound: a read emits nothing

Events

None emitted.

None.

get a test key

curl https://api.containertradehq.com/v1/cap/get_factory_scorecard \
  -H "Authorization: Bearer $TRADEHQ_API_KEY" \
  -H "Trade-HQ-Version: 2026-10-01" \
  -H "Content-Type: application/json" \
  -d '{"org_id":"<org_id>"}'

import { TradeHQ } from '@containertradehq/sdk';

const tradehq = new TradeHQ({ apiKey: process.env.TRADEHQ_API_KEY! });
const result = await tradehq.getFactoryScorecard({
  "org_id": "<org_id>"
});

import os
from containertradehq import TradeHQ

tradehq = TradeHQ(os.environ["TRADEHQ_API_KEY"])
result = tradehq.get_factory_scorecard({
    "org_id": "<org_id>",
})

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_factory_scorecard",
    "arguments": {
      "org_id": "<org_id>"
    }
  }
}

MCP

get_factory_scorecard · readOnlyHint true

“Call get_factory_scorecard”