Get Mi Effectiveness

GET

/api/canvas/learning/mi-effectiveness

curl --request GET \
  --url 'https://example.com/api/canvas/learning/mi-effectiveness?deal_type=cre&asset_type=multifamily&section_type=financial_analysis&months=6&deal_id=example' \
  --header 'Authorization: Bearer <token>'

MI warning effectiveness: resolved vs overridden vs corrected.

Returns both lifetime totals and monthly trend for the specified deal_type/asset_type/section_type combination. Answers the question: “Are our MI warnings useful, or do users just override them?”

Authorizations

• HTTPBearer

Parameters

Query Parameters

deal_type

Deal Type

Deal type

string

default: cre

Deal type

asset_type

Asset Type

Asset type

string

default: multifamily

Asset type

section_type

Section Type

Section type

string

default: financial_analysis

Section type

months

Months

Trend months

integer

default: 6 >= 1 <= 24

Trend months

deal_id

required

Deal Id

string

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