Skip to content
em sa em sa

Compare deal metrics only

GET
/api/compare/deals/metrics
 
curl --request GET \
  --url 'https://example.com/api/compare/deals/metrics?deal_a_id=example&deal_b_id=example' \
  --header 'Authorization: Bearer <token>'

Lightweight metrics-only comparison for search result previews.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
deal_a_id
required
Deal A Id
string
<= 200 characters
deal_b_id
required
Deal B Id
string
<= 200 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
MetricsOnlyResponseModel

Lightweight metrics-only comparison for search previews.

object
deal_a_id
required
Deal A Id
string
deal_b_id
required
Deal B Id
string
deal_a_name
required
Deal A Name
string
deal_b_name
required
Deal B Name
string
metrics
required
Metrics
Array<object>
MetricComparisonResponse

One row of the metrics comparison table.

object
metric_name
required
Metric Name
string
label
required
Label
string
deal_a_value
Any of:
number
deal_b_value
Any of:
number
delta
Any of:
number
delta_pct
Any of:
number
unit
required
Unit
string
compared_at
required
Compared At
string
Example generated
{
  "deal_a_id": "example",
  "deal_b_id": "example",
  "deal_a_name": "example",
  "deal_b_name": "example",
  "metrics": [
    {
      "metric_name": "example",
      "label": "example",
      "deal_a_value": 1,
      "deal_b_value": 1,
      "delta": 1,
      "delta_pct": 1,
      "unit": "example"
    }
  ],
  "compared_at": "example"
}

422

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