Deal Benchmark Tradeoff At Scale

Get the tradeoff models for a given category.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

group_idintegerRequired
deal_idintegerRequired
categorystringRequired

Query parameters

modellist of strings or nullOptional

Response

Successful Response
scaleobject
Describes the revenue range of the data whose points represent the trade off.
raw_datalist of maps from strings to doubles
Raw data points used to generate the tradeoff model. Each dictionary contains exactly two key-value pairs representing the x-metric and y-metric being compared. The keys are dynamic metric names that vary by model - for example, '12m_growth_vs_margin' uses 'quarterly_operating_margin' (x) and 'cmgr12' (y). Use the /data/benchmark/metadata/models endpoint to see which columns each model uses.
discarded_raw_datalist of maps from strings to doubles

Additional raw data points which were not used in the model fit due to outlier status. Contains the same metric keys as raw_data. These points were excluded to prevent skewing the tradeoff distribution.

areaslist of objects

Areas representing the confidence regions of the tradeoff model. The x-y coordinates describe an elliptical surface containing (1 - alpha) share of the data points, showing the typical tradeoff distribution at this revenue scale.

Errors