Concentration

GET

1 from termina import Termina
2 
3 client = Termina(
4     token="YOUR_TOKEN",
5 )
6 client.product.get_concentration(
7     group_id=1,
8     deal_id=1,
9     user_type="business",
10     metric="metric",
11 )

Play

1 {
2   "time_series_metrics": [
3     {
4       "date": "2025-01",
5       "top_5_count": 1.1,
6       "top_10_count": 1.1,
7       "top_20_count": 1.1,
8       "top_10_percent": 1.1,
9       "top_20_percent": 1.1,
10       "mean": 1.1,
11       "p25": 1.1,
12       "median": 1.1,
13       "p75": 1.1,
14       "p90": 1.1,
15       "average_to_median": 1.1,
16       "gini_coefficient": 1.1
17     }
18   ],
19   "endpoint_top_users": [
20     {
21       "user_id": "user_1",
22       "amount": 100,
23       "amount_percent": 0.1
24     }
25   ],
26   "endpoint_cdf": [
27     {
28       "method": "top_user",
29       "amount": 100,
30       "cdf_users": 0.7,
31       "cdf_amount": 0.88
32     }
33   ]
34 }

Get the product concentration for the company associated with the deal.

Path parameters

group_idintegerRequired

deal_idintegerRequired

Query parameters

user_typeenumRequired

metricstringRequired

freqenumOptional

Allowed values:

Response

Successful Response

time_series_metricslist of objectsOptional

The time series metrics for the concentration of the amount. The top 5, 10, and 20 users are shown, as well as the top 10% and 20% of users, and some other supporting aggregate concentration metrics.

endpoint_top_userslist of objectsOptional

Detail for the top users at the endpoint. Up to the top 100 users are show.

endpoint_cdflist of objectsOptional

The detailed cumulative distribution function (CDF). The CDF is presented at the top 100 users, and beyond that it is presented at approximately evenly spaced quantiles. This approach enables robustness to extremely large user bases. The CDF is presented for both users and amount.

Concentration

Path parameters

Headers

Query parameters

Response

Errors