v3

latestSwagger 2.02026-08-067506752.0 MB

comp-review

Get data for visualizations for a comp review

post/v1/org/{orgId}/comp-review/{compReviewId}/visualizations

Path parameters

orgIdstring required

Org identifier (either id or slug)

compReviewIdstring required

Comp review id

Query parameters

viewJobIdstring

The job you would like to view as

previewboolean

Are the visualizations for a preview

includeAllRequestsboolean

Allows users with multiple roles to request full access for owner or final approver roles

Request body

changeIdsstring[]

A set of Change ObjectIds used to filter the results of budget and raise calculations

viewInCurrencystring

Currency to view budget visualizations

includeCollaboratorsboolean

Whether or not to include approval requests on which a user is collaborating when calculating budget amounts for that user

isCollabicientViewboolean required

Are the visualizations for a collaborating participant

scenarioIdsstring[]

A set of Scenario ObjectIds used to filter budget calculations to a specific reviewer's scenarios

Example request

{
  "changeIds": [
    "588f7ee98f138b19220041a7"
  ],
  "scenarioIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

successful operation

jobToBaseSpendMapobject required

Example response

{
  "budgetPoolCalculation": {
    "pools": [
      {
        "budgetPoolId": "588f7ee98f138b19220041a7",
        "label": "Merit",
        "scenarios": [
          {
            "scenarioId": "588f7ee98f138b19220041a7"
          }
        ]
      }
    ]
  }
}