Observed attribution and cash collection by role

GET

/api/v1/attribution/roi-summary

const url = 'https://api.ultimateteam.ai/api/v1/attribution/roi-summary';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/attribution/roi-summary \
  --header 'X-API-Key: <X-API-Key>'

Return observed amounts; no causal business ROI is calculated.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

ROISummary

Observed USD amounts; attribution does not establish incrementality.

object

by_role

By Role

object

key

additional properties

object

key

additional properties

any

currency

Currency

string

default: USD

excluded_currency_record_count

Excluded Currency Record Count

integer

full_profit_cents

Full Profit Cents

null

generated_at

Generated At

string format: date-time

measurement_basis

Measurement Basis

string

default: observational

record_count

Record Count

integer

roi_ratio

Roi Ratio

null

tenant_id

required

Tenant Id

string format: uuid

total_attributed_cost_savings_cents

Any of:

integer
null

integer

total_attributed_revenue_cents

Any of:

integer
null

integer

total_cash_collected_cents

Any of:

integer
null

integer

unavailable_reason

Unavailable Reason

string

default: Incremental revenue and total business costs are not measured. Cash collection is not newly earned revenue; credits are billing units.

Example

{
  "currency": "USD",
  "excluded_currency_record_count": 0,
  "measurement_basis": "observational",
  "record_count": 0,
  "unavailable_reason": "Incremental revenue and total business costs are not measured. Cash collection is not newly earned revenue; credits are billing units."
}