Skip to main content
BSC Designer logo
  • Category: business intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: BSC_DESIGNER
  • Version: 20261101_00

Tools

Slug: BSC_DESIGNER_BALANCE_SCORECARD_WEIGHTSRecalculate and persist balanced indicator weights across a scorecard. Returns old and new weights when the provider supplies change details; the change list may be empty.

Input Parameters

string
required
Document numeric ID or alias whose indicator weights will be recalculated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_DOWNLOAD_EXCEL_REPORTGenerate and download a scorecard’s Excel report, optionally evaluated at a specified date.

Input Parameters

string
Optional report date in yyyy-MM-dd format. Omit it to use BSC Designer’s default report date.
integer
required
Numeric document ID returned by List Documents; aliases are not documented for this report route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_GET_DOCUMENTGet metadata and sharing settings for one scorecard document by numeric ID or alias.

Input Parameters

string
required
Numeric document ID or alias returned by List Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_GET_GROUPED_INDICATOR_VALUESGet one indicator’s values grouped by day, week, month, quarter, half-year, or year over an explicit date range.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_GET_INDICATOR_VALUEGet 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

string
required
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.
string
required
Exact identifier of a value-bearing indicator returned by List Scorecard Items. Preserve braces, capitalization, and spelling.
string
required
Document numeric ID or alias returned by List Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_GET_SCORECARD_ITEMGet detailed metadata for one scorecard item, such as an indicator, goal, or initiative, using its exact item identifier.

Input Parameters

string
required
Exact guid or symbolic item identifier returned by List Scorecard Items; preserve braces and spelling.
string
required
Document numeric ID or alias returned by List Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_LIST_DOCUMENTSList scorecard documents owned by or shared with the connected user, returning IDs and aliases for subsequent scorecard operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_LIST_SCORECARD_ITEMSList scorecard items, including goals, perspectives, indicators, initiatives, risks, rationales, and expected outcomes. Filter the item list locally by category or whether items accept value data; the separately returned root remains unfiltered.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_SET_INDICATOR_VALUESSet 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

string
required
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.
array
required
One or more indicator updates. Every entry requires indicator_id and at least one metric.
string
required
Document numeric ID or alias returned by List Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BSC_DESIGNER_UPDATE_INDICATORUpdate a scorecard indicator’s name, description, or leading/lagging business type without changing its measured values. Unspecified metadata is preserved, but concurrent edits to the same indicator may be overwritten.

Input Parameters

string
New indicator name; omit to leave it unspecified.
string
New indicator description; omit to leave it unspecified.
string
required
Exact indicator identifier returned by List Scorecard Items. Preserve braces, capitalization, and spelling.
string ("LEADING" | "LAGGING")
New business type, LEADING or LAGGING; omit to leave it unspecified.
string
required
Document numeric ID or alias returned by List Documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not