Build with Estii

Read a detailed comparison with another variant

GET
/v1/deal/{id}/compare/variant/{variantId}

Requires read scope.

Reads from the deal named, against the other variant. A pair with no comparison answers with comparison: null; a deal that is not a variant of the deal's opportunity is not found.

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token (estp_) or space API key (ests_).

In: header

Path Parameters

id*string
variantId*string

Query Parameters

space*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/deal/string/compare/variant/string?space=string"
{  "comparison": {    "variant_id": "string",    "ran_at": 0,    "by_email": "string",    "by_name": "string",    "figures": {      "price": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      },      "adjustments": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      },      "cost": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      },      "profit": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      },      "margin": {        "before": 0,        "after": 0,        "delta": 0,        "points": 0      },      "labor_margin": {        "before": 0,        "after": 0,        "delta": 0,        "points": 0      },      "effort": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      },      "start": {        "before": 0,        "after": 0,        "days": 0      },      "end": {        "before": 0,        "after": 0,        "days": 0      },      "duration": {        "before": 0,        "after": 0,        "delta": 0      },      "one_off": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      },      "recurring": {        "before": 0,        "after": 0,        "delta": 0,        "share": 0      }    },    "observations": [      {        "title": "string",        "consequence": "string",        "claim": [          {            "kind": "text",            "text": "string"          }        ],        "cites": [          "string"        ],        "descriptive": true      }    ],    "bridge": {      "before": 0,      "after": 0,      "steps": [        {          "key": "added",          "amount": 0,          "inferred": true        }      ],      "inferred": true    },    "computed": {      "before": 0,      "after": 0,      "steps": [        {          "key": "added",          "amount": 0,          "inferred": true        }      ],      "inferred": true    },    "scope": [      {        "id": "string",        "name": "string",        "phase_id": "string",        "phase_name": "string",        "only": "before",        "days": 0,        "price": 0,        "rows": [          {            "kind": "added",            "before": {              "id": "string",              "name": "string",              "days": 0,              "price": 0            },            "after": {              "id": "string",              "name": "string",              "days": 0,              "price": 0            },            "method": "id",            "overlap": {              "id": "string",              "name": "string"            },            "days": 0,            "price": 0          }        ],        "same": [          {            "kind": "added",            "before": {              "id": "string",              "name": "string",              "days": 0,              "price": 0            },            "after": {              "id": "string",              "name": "string",              "days": 0,              "price": 0            },            "method": "id",            "overlap": {              "id": "string",              "name": "string"            },            "days": 0,            "price": 0          }        ]      }    ],    "roles": [      {        "key": "string",        "name": "string",        "before": 0,        "after": 0      }    ],    "payments": {      "rows": [        {          "id": "string",          "name": "string",          "before": {            "when": {              "kind": "date",              "date": 0,              "period": "week"            },            "share": 0,            "amount": 0          },          "after": {            "when": {              "kind": "date",              "date": 0,              "period": "week"            },            "share": 0,            "amount": 0          }        }      ]    },    "matches": [      {        "before": "string",        "after": "string",        "method": "id"      }    ],    "findings": {      "items": [        {          "rule_id": "string",          "name": "string",          "family": "pricing",          "tier": "arithmetic",          "voice": "states",          "kind": "risk",          "claim": [            {              "kind": "text",              "text": "string"            }          ],          "consequence": "string",          "evidence": [            {              "label": "string",              "value": 0,              "format": "currency",              "node_id": "string"            }          ],          "target": {            "kind": "phase",            "id": "string",            "phase_id": "string",            "category_id": "string",            "feature_id": "string"          },          "exposure": 0,          "severity": 0,          "band": "expected"        }      ],      "checks": 0,      "outcomes": [        {          "rule_id": "string",          "name": "string",          "family": "pricing",          "check": "string",          "needs": "string",          "status": "found",          "measured": {            "label": "string",            "value": 0,            "format": "currency",            "node_id": "string"          }        }      ]    },    "basis": {      "before": {        "price": 0,        "cost": 0      },      "after": {        "price": 0,        "cost": 0      },      "items": {        "property1": {          "days": 0,          "price": 0        },        "property2": {          "days": 0,          "price": 0        }      },      "other": {        "property1": {          "days": 0,          "price": 0        },        "property2": {          "days": 0,          "price": 0        }      }    }  },  "running": {    "started_at": 0,    "step": "price",    "by_email": "string",    "by_name": "string"  }}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}