Backward dependency chain for a CRE metric

GET

/api/canvas/{deal_id}/ripple/provenance/{metric_key}

curl --request GET \
  --url 'https://example.com/api/canvas/example/ripple/provenance/example?max_depth=3' \
  --header 'Authorization: Bearer <token>'

Returns the primary cell + per-level dependency walk for a metric in the deal’s loaded formula graph. Useful for ‘what drives this number?’ affordances in the Ripple preview UI. Read-only; Viewer access suffices.

Authorizations

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

metric_key

required

Metric Key

string

Query Parameters

max_depth

Max Depth

integer

default: 3

Responses

200

Successful Response

Media type application/json

Example ^generated

example

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": {}
    }
  ]
}