Get chart suggestions for a deal

GET

/api/canvas/{deal_id}/charts/suggestions

curl --request GET \
  --url https://example.com/api/canvas/example/charts/suggestions \
  --header 'Authorization: Bearer <token>'

Return chart suggestions derived from deal financial data.

Suggestions are generated from annual_cash_flows and opex_detail in deal_data. Returns an empty list if no financial data is available.

Authorizations

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

Responses

200

Successful Response

Media type application/json

ChartSuggestionsResponse

Response schema for chart suggestions.

object

suggestions

required

Suggestions

Array<object>

object

key

additional properties

any

count

required

Count

integer

Example ^generated

{
  "suggestions": [
    {}
  ],
  "count": 1
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}