---
title: "Get the aggregated Impact Dashboard payload for a comp review"
method: POST
path: "/v1/org/{orgId}/comp-review/{compReviewId}/impact-dashboard"
tags: ["comp-review"]
---

# Get the aggregated Impact Dashboard payload for a comp review

`POST /v1/org/{orgId}/comp-review/{compReviewId}/impact-dashboard`

## Request

- Base URL: `https://localhost`
- URL: `https://localhost/v1/org/{orgId}/comp-review/{compReviewId}/impact-dashboard`
- Auth: none declared

## Path parameters

- `orgId` string, required
- `compReviewId` string, required

## Query parameters

- `viewJobId` string
- `preview` boolean
- `includeAllRequests` boolean

## Request body

- GetImpactDashboardOptions
  - `changeIds` string[]: A set of Change ObjectIds used to scope the dashboard to specific changes
  - `viewInCurrency` string: Currency to view money-valued cards in
  - `includeCollaborators` boolean: Whether to include approval requests the user collaborates on
  - `isCollabicientView` boolean, required: Whether the dashboard is being viewed by a collaborator
  - `scenarioIds` string[]: A set of Scenario ObjectIds used to scope the dashboard to a reviewer's scenarios

## Response `200`

successful operation

- CompReviewImpactDashboardResponse
  - `kpi` ImpactDashboardKpiPayload, required
    - `costImpact` KpiCostImpact, required
      - `preCycle` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `postCycle` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `deltaValue` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `deltaPercentage` number, required
    - `employeesImpacted` KpiEmployeesImpacted, required
      - `impactedCount` integer, required
      - `eligibleCount` integer, required
      - `impactedPercentage` number, required
    - `budgetUtilization` KpiBudgetUtilization
      - `used` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `allocated` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `remaining` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `usedPercentage` number, required
    - `guidelineDeviations` KpiGuidelineDeviation
      - `deviationCount` integer, required
      - `potentialCount` integer, required
      - `deviationPercentage` number, required
  - `waterfall` ImpactDashboardWaterfallPayload, required
    - `byType` WaterfallBar[], required
      - `label` string, required
      - `value` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `kind` 'PRE_CYCLE_TOTAL' | 'POST_CYCLE_TOTAL' | 'DELTA', required
      - `breakdown` WaterfallBarBreakdown[]
        - `label` string, required
        - `value` Money, required
          - `amount` number, required
          - `currency` string, required
          - `places` integer
      - `preCycleDefinition` string
      - `postCycleDefinition` string
    - `byBudgetPool` WaterfallBar[], required
      - `label` string, required
      - `value` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `kind` 'PRE_CYCLE_TOTAL' | 'POST_CYCLE_TOTAL' | 'DELTA', required
      - `breakdown` WaterfallBarBreakdown[]
        - `label` string, required
        - `value` Money, required
          - `amount` number, required
          - `currency` string, required
          - `places` integer
      - `preCycleDefinition` string
      - `postCycleDefinition` string
  - `budgetPools` ImpactDashboardBudgetPoolsPayload, required
    - `pools` BudgetPoolSummaryRow[], required
      - `budgetPoolId` string, required
      - `label` string, required
      - `allocated` object, required
      - `used` object, required
      - `remaining` object, required
      - `utilizationPercentage` number, required
    - `currencyTotal` BudgetPoolTotalsRow
      - `allocated` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `used` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `remaining` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `utilizationPercentage` number, required
  - `pivot` ImpactDashboardPivotPayload
    - `groupByOptions` ImpactDashboardPivotDimension[], required
      - `key` string, required
      - `fieldCode` string
      - `syntheticKind` 'REVIEWER'
    - `showPromotionsColumn` boolean, required
    - `changes` ImpactDashboardPivotChangeRow[], required
      - `changeId` string, required
      - `jobId` string, required
      - `groupByValues` object, required
      - `preCycleSpend` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `postCycleSpend` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `delta` Money, required
        - `amount` number, required
        - `currency` string, required
        - `places` integer
      - `isPromotion` boolean, required

## Other responses

- `400`: bad request (e.g. impact dashboard config references unknown fields)
- `401`: not authorized
- `403`: user lacks visibility to the Impact Dashboard tab
- `404`: not found

## Changes

- **2026-08-26** `24918a59d542`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/charthop/apis/charthop-api/changes/v1/org/:orgId/comp-review/:compReviewId/impact-dashboard/post.md)

---

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