---
title: "Get data for visualizations for a comp review"
method: POST
path: "/v1/org/{orgId}/comp-review/{compReviewId}/visualizations"
tags: ["comp-review"]
---

# Get data for visualizations for a comp review

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

## Path parameters

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

## Query parameters

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

## Request body

- GetVisualizationsOptions
  - `changeIds` string[] — A set of Change ObjectIds used to filter the results of budget and raise calculations
  - `viewInCurrency` string — Currency to view budget visualizations
  - `includeCollaborators` boolean — Whether or not to include approval requests on which a user is collaborating when calculating budget amounts for that user
  - `isCollabicientView` boolean, required — Are the visualizations for a collaborating participant
  - `scenarioIds` string[] — A set of Scenario ObjectIds used to filter budget calculations to a specific reviewer's scenarios

## Response `200`

successful operation

- CompReviewVisualizations
  - `jobToBaseSpendMap` object, required
  - `budgetPoolCalculation` BudgetCalculation
    - `allocated` object — the total budget amount (null if user doesn't have permission to view)
    - `used` object — the amount of the budget that has been used (null if user doesn't have permission to view)
    - `pools` PoolCalculation[], required — a list of budget pools that make up the total amount
      - `budgetPoolId` string, required — budget pool id
      - `label` string, required — budget pool label
      - `allocated` object, required — budget pool total amount
      - `used` object — the amount of the budget pool that has been used
      - `scenarios` ScenarioCalculation[], required — a list of reviewer/scenario specific calculations that create the total
        - `scenarioId` string, required — scenario id
        - `allocated` object, required — budget pool total allocation for scenario
        - `used` object — budget pool total use for scenario
    - `jobBudgetMap` object — the amount allotted and allocated for the comp review broken down by job

## Other responses

- `400` — bad request
- `401` — not authorized
- `404` — not found

---

[API](https://skmtc.dev/charthop/apis/charthop-api.md) · [All operations](https://skmtc.dev/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/charthop/charthop-api/revisions/4685d95a20b1/schema)