---
canonical_url: "https://docs.composio.dev/toolkits/bsc_designer"
markdown_url: "https://docs.composio.dev/toolkits/bsc_designer.md"
product: "platform"
version: null
last_updated: null
---

# BSC Designer

BSC Designer helps organizations create balanced scorecards, manage KPIs, visualize strategy maps, and track strategic performance.

- **Category:** business intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `BSC_DESIGNER`
- **Version:** 00000000_00

## Tools

### Balance Scorecard Weights

**Slug:** `BSC_DESIGNER_BALANCE_SCORECARD_WEIGHTS`

Recalculate and persist balanced indicator weights across a scorecard, returning every changed old and new weight. Use only on an owner-approved scorecard because this documented mutation has not yet been live-verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id_or_alias` | string | Yes | Document numeric ID or alias whose indicator weights will be recalculated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Excel Report

**Slug:** `BSC_DESIGNER_DOWNLOAD_EXCEL_REPORT`

Generate and download a scorecard's Excel report, optionally evaluated at a specified date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Optional report date in yyyy-MM-dd format. Omit it to use BSC Designer's default report date. |
| `document_id` | integer | Yes | Numeric document ID returned by List Documents; aliases are not documented for this report route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document

**Slug:** `BSC_DESIGNER_GET_DOCUMENT`

Get metadata and sharing settings for one scorecard document by numeric ID or alias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id_or_alias` | string | Yes | Numeric document ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Grouped Indicator Values

**Slug:** `BSC_DESIGNER_GET_GROUPED_INDICATOR_VALUES`

Get one indicator's values grouped by day, week, month, quarter, half-year, or year over an explicit date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string ("DAY" | "WEEK" | "MONTH" | "QUARTER" | "HALF_YEAR" | "YEAR") | Yes | Time bucket used to group indicator values. |
| `end_date` | string | Yes | Inclusive range end in yyyy-MM-dd format. Must not precede start_date. |
| `start_date` | string | Yes | Inclusive range start in yyyy-MM-dd format. |
| `indicator_id` | string | Yes | Exact identifier of a value-bearing indicator returned by List Scorecard Items. Preserve braces, capitalization, and spelling. |
| `document_id_or_alias` | string | Yes | Document numeric ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Indicator Value

**Slug:** `BSC_DESIGNER_GET_INDICATOR_VALUE`

Get one indicator's value, baseline, target, minimum, and maximum for the requested as-of date under its update-interval and value-inheritance settings, including each metric's effective date. Future scheduled values are not returned before their effective date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | As-of lookup date in yyyy-MM-dd format. BSC Designer applies the indicator's update interval and value-inheritance settings, so metrics may resolve from an earlier effective date. A write normalized to a later scheduled date is not visible before that date. |
| `indicator_id` | string | Yes | Exact identifier of a value-bearing indicator returned by List Scorecard Items. Preserve braces, capitalization, and spelling. |
| `document_id_or_alias` | string | Yes | Document numeric ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scorecard Item

**Slug:** `BSC_DESIGNER_GET_SCORECARD_ITEM`

Get detailed metadata for one scorecard item, such as an indicator, goal, or initiative, using its exact item identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | string | Yes | Exact guid or symbolic item identifier returned by List Scorecard Items; preserve braces and spelling. |
| `document_id_or_alias` | string | Yes | Document numeric ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents

**Slug:** `BSC_DESIGNER_LIST_DOCUMENTS`

List scorecard documents owned by or shared with the connected user, returning IDs and aliases for subsequent scorecard operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Scorecard Items

**Slug:** `BSC_DESIGNER_LIST_SCORECARD_ITEMS`

List the goals, perspectives, indicators, initiatives, risks, rationales, and expected outcomes in a scorecard, with optional local filtering for value-bearing indicators.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_type` | string ("AUTOMATIC" | "INITIATIVE" | "SUCCESS_FACTOR" | "EXPECTED_OUTCOME" | "RATIONALE" | "HYPOTHESIS" | "RISK" | "PERSPECTIVE" | "GOAL" | "INDICATOR") | No | Optional scorecard item category to retain from the complete response. Filtering occurs locally and is not sent upstream. |
| `value_data_only` | boolean | No | When true, return only items whose acceptValueData field is true. Filtering occurs locally and is not sent upstream. |
| `document_id_or_alias` | string | Yes | Document numeric ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Indicator Values

**Slug:** `BSC_DESIGNER_SET_INDICATOR_VALUES`

Set one or more indicators' value, baseline, target, minimum, or maximum in one batch request. BSC Designer maps the requested date to each indicator's configured update schedule; use the returned date and metric-specific effective dates for read-back or restoration because they may be later than the requested date. Omitted metrics are left unspecified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Requested write date in yyyy-MM-dd format. BSC Designer maps this date to each indicator's configured update schedule, so the response's date and metric-specific *Date fields are authoritative and may be later. |
| `values` | array | Yes | One or more indicator updates. Every entry requires indicator_id and at least one metric. |
| `document_id_or_alias` | string | Yes | Document numeric ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Indicator

**Slug:** `BSC_DESIGNER_UPDATE_INDICATOR`

Update an indicator's name, description, or leading/lagging business type without changing its measured values. The tool reads and preserves unspecified metadata, then verifies the update; avoid concurrent edits to the same indicator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New indicator name; omit to leave it unspecified. |
| `description` | string | No | New indicator description; omit to leave it unspecified. |
| `indicator_id` | string | Yes | Exact indicator identifier returned by List Scorecard Items. Preserve braces, capitalization, and spelling. |
| `indicator_type` | string ("LEADING" | "LAGGING") | No | New business type, LEADING or LAGGING; omit to leave it unspecified. |
| `document_id_or_alias` | string | Yes | Document numeric ID or alias returned by List Documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |