---
title: "Preview a materialized roster view"
method: POST
path: "/v2/roster/views/preview"
tags: ["Roster Builder"]
---

# Preview a materialized roster view

`POST /v2/roster/views/preview`

## Request

- Base URL: `https://api.clashk.ing`
- URL: `https://api.clashk.ing/v2/roster/views/preview`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Query parameters

- `server_id` string, required

## Request body

- object
  - `serverId` string, required
  - `rosterIds` string[], required
  - `viewId` string
  - `name` string, required
  - `sourceCode` string, required
  - `sourceVersion` 1, required
  - `columns` object[], required
    - `id` string, required
    - `label` string, required
    - `metricId` string, required
    - `description` string
    - `parameters` object
    - `format` string
  - `filters` object[], required
    - `columnId` string, required
    - `operator` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'contains', required
    - `value` unknown, required
  - `sort` object[], required
    - `columnId` string, required
    - `direction` 'asc' | 'desc', required
  - `highlights` object[], required
    - `id` string, required
    - `target` 'row' | 'column' | 'cell', required
    - `columnId` string
    - `when` object
      - `columnId` string
      - `operator` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'contains', required
      - `value` unknown, required
    - `tone` 'red' | 'amber' | 'green' | 'blue' | 'purple' | 'gray', required
  - `limit` union, required
    - number
    - 'NaN'
    - 'Infinity'
    - '-Infinity'
  - `rows` object[]
    - `rosterId` string, required
    - `playerTag` string, required
    - `values` object, required
    - `highlight` string, nullable

## Response `200`

Success

- object
  - `view` object, required
    - `id` string, required
    - `shareId` string, required
    - `serverId` string, required
    - `name` string, required
    - `sourceCode` string, required
    - `sourceVersion` 1, required
    - `createdBy` string, required
    - `spec` object
      - `schemaVersion` 1, required
      - `columns` object[], required
        - `id` string, required
        - `label` string, required
        - `metricId` string, required
        - `description` string
        - `parameters` object
        - `format` string
      - `sort` object[]
        - `columnId` string, required
        - `direction` 'asc' | 'desc', required
      - `filters` object[]
        - `columnId` string, required
        - `operator` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'contains', required
        - `value` unknown, required
      - `highlights` object[]
        - `id` string, required
        - `target` 'row' | 'column' | 'cell', required
        - `columnId` string
        - `when` object
          - `columnId` string
          - `operator` 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'contains', required
          - `value` unknown, required
        - `tone` 'red' | 'amber' | 'green' | 'blue' | 'purple' | 'gray', required
      - `limit` union
        - number
        - 'NaN'
        - 'Infinity'
        - '-Infinity'
    - `createdAt` string, required
    - `updatedAt` string, required
  - `result` object, required
    - `viewId` string, required
    - `rosterIds` string[], required
    - `schemaVersion` 1, required
    - `rows` object[], required
      - `rosterId` string, required
      - `playerTag` string, required
      - `values` object, required
      - `highlight` string, nullable
    - `cachedMetricIds` string[], required
    - `evaluatedAt` string, required

## Changes

- **2026-09-09** `9ec0debedfc6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clashk/apis/clashking-api/changes/v2/roster/views/preview/post.md)

---

[API](https://skmtc.dev/clashk/apis/clashking-api.md) - [All operations](https://skmtc.dev/clashk/apis/clashking-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clashk/apis/clashking-api/revisions/8411b4ef8009?raw)