> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get brand quality scorecard

> Closed-loop quality rates (approval / escalation / automation) over a rolling window.

### Path parameters

<ParamField path="brand_id" type="string (uuid)" required />

### Response

`object`

<ResponseField name="brand_id" type="string (uuid)" required />

<ResponseField name="window_hours" type="integer" required />

<ResponseField name="total" type="integer" required />

<ResponseField name="confirmed" type="integer" required />

<ResponseField name="rejected" type="integer" required />

<ResponseField name="pending" type="integer" required />

<ResponseField name="escalations" type="integer" required />

<ResponseField name="automated" type="integer" required />

<ResponseField name="approval_rate" type="number" />

<ResponseField name="escalation_rate" type="number" />

<ResponseField name="automation_rate" type="number" />

<ResponseField name="by_type" type="object[]" required>
  <Expandable title="by_type">
    <ResponseField name="outcome_type" type="string" required />

    <ResponseField name="count" type="integer" required />
  </Expandable>
</ResponseField>

<ResponseField name="escalation_reasons" type="object[]" required>
  <Expandable title="escalation_reasons">
    <ResponseField name="category" type="string" required />

    <ResponseField name="count" type="integer" required />
  </Expandable>
</ResponseField>

### Status codes

| Code  | Meaning                                                                               |
| ----- | ------------------------------------------------------------------------------------- |
| `200` | Closed-loop quality rates (approval / escalation / automation) over a rolling window. |
| `400` | Validation error                                                                      |
| `401` | Unauthorized                                                                          |
| `404` | Not found                                                                             |
| `429` | Rate limited                                                                          |
| `500` | Internal error                                                                        |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/outcomes/scorecard' \
    --header "x-api-key: $STATESET_TEMPORAL_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "window_hours": 1,
    "total": 102,
    "confirmed": 1,
    "rejected": 1,
    "pending": 1,
    "escalations": 1,
    "automated": 1,
    "approval_rate": 7.5,
    "escalation_rate": 7.5,
    "automation_rate": 7.5,
    "by_type": [
      {
        "outcome_type": "string",
        "count": 2
      }
    ],
    "escalation_reasons": [
      {
        "category": "standard",
        "count": 2
      }
    ]
  }
  ```
</ResponseExample>
