Get feature usage by company

GET

https://api.schematichq.com/usage-by-company

GET

/usage-by-company

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.getFeatureUsageByCompany({
5     keys: {
6         "keys": "keys"
7     }
8 });

Try it

1 {
2   "data": {
3     "features": [
4       {
5         "access": true,
6         "allocation_type": "boolean",
7         "entitlement_id": "foo",
8         "entitlement_type": "foo",
9         "allocation": 42,
10         "entitlement_expiration_date": "foo",
11         "feature": {
12           "created_at": "foo",
13           "description": "foo",
14           "feature_type": "foo",
15           "flags": [
16             {
17               "created_at": "foo",
18               "default_value": true,
19               "description": "foo",
20               "flag_type": "foo",
21               "id": "foo",
22               "key": "foo",
23               "name": "foo",
24               "rules": [
25                 {
26                   "condition_groups": [
27                     {
28                       "conditions": [
29                         {
30                           "condition_type": "foo",
31                           "created_at": "foo",
32                           "environment_id": "foo",
33                           "id": "foo",
34                           "operator": "foo",
35                           "resource_ids": [
36                             "foo"
37                           ],
38                           "resources": [
39                             {
40                               "id": "foo",
41                               "name": "foo",
42                               "description": "foo",
43                               "image_url": "foo"
44                             }
45                           ],
46                           "rule_id": "foo",
47                           "trait_value": "foo",
48                           "updated_at": "foo",
49                           "comparison_trait": {
50                             "created_at": "foo",
51                             "display_name": "foo",
52                             "entity_type": "foo",
53                             "hierarchy": [
54                               "foo"
55                             ],
56                             "id": "foo",
57                             "trait_type": "foo",
58                             "updated_at": "foo"
59                           },
60                           "comparison_trait_id": "foo",
61                           "condition_group_id": "foo",
62                           "event_subtype": "foo",
63                           "flag_id": "foo",
64                           "metric_period": "foo",
65                           "metric_period_month_reset": "foo",
66                           "metric_value": 42,
67                           "plan_id": "foo",
68                           "trait": {
69                             "created_at": "foo",
70                             "display_name": "foo",
71                             "entity_type": "foo",
72                             "hierarchy": [
73                               "foo"
74                             ],
75                             "id": "foo",
76                             "trait_type": "foo",
77                             "updated_at": "foo"
78                           },
79                           "trait_entity_type": "foo",
80                           "trait_id": "foo"
81                         }
82                       ],
83                       "created_at": "foo",
84                       "environment_id": "foo",
85                       "id": "foo",
86                       "rule_id": "foo",
87                       "updated_at": "foo",
88                       "flag_id": "foo",
89                       "plan_id": "foo"
90                     }
91                   ],
92                   "conditions": [
93                     {
94                       "condition_type": "foo",
95                       "created_at": "foo",
96                       "environment_id": "foo",
97                       "id": "foo",
98                       "operator": "foo",
99                       "resource_ids": [
100                         "foo"
101                       ],
102                       "resources": [
103                         {
104                           "id": "foo",
105                           "name": "foo",
106                           "description": "foo",
107                           "image_url": "foo"
108                         }
109                       ],
110                       "rule_id": "foo",
111                       "trait_value": "foo",
112                       "updated_at": "foo",
113                       "comparison_trait": {
114                         "created_at": "foo",
115                         "display_name": "foo",
116                         "entity_type": "foo",
117                         "hierarchy": [
118                           "foo"
119                         ],
120                         "id": "foo",
121                         "trait_type": "foo",
122                         "updated_at": "foo"
123                       },
124                       "comparison_trait_id": "foo",
125                       "condition_group_id": "foo",
126                       "event_subtype": "foo",
127                       "flag_id": "foo",
128                       "metric_period": "foo",
129                       "metric_period_month_reset": "foo",
130                       "metric_value": 42,
131                       "plan_id": "foo",
132                       "trait": {
133                         "created_at": "foo",
134                         "display_name": "foo",
135                         "entity_type": "foo",
136                         "hierarchy": [
137                           "foo"
138                         ],
139                         "id": "foo",
140                         "trait_type": "foo",
141                         "updated_at": "foo"
142                       },
143                       "trait_entity_type": "foo",
144                       "trait_id": "foo"
145                     }
146                   ],
147                   "created_at": "foo",
148                   "environment_id": "foo",
149                   "id": "foo",
150                   "name": "foo",
151                   "priority": 42,
152                   "rule_type": "foo",
153                   "updated_at": "foo",
154                   "value": true,
155                   "flag_id": "foo",
156                   "plan_id": "foo"
157                 }
158               ],
159               "updated_at": "foo",
160               "feature": {
161                 "created_at": "foo",
162                 "description": "foo",
163                 "feature_type": "foo",
164                 "icon": "foo",
165                 "id": "foo",
166                 "name": "foo",
167                 "updated_at": "foo",
168                 "event_subtype": "foo",
169                 "lifecycle_phase": "foo",
170                 "maintainer_id": "foo",
171                 "plural_name": "foo",
172                 "singular_name": "foo",
173                 "trait_id": "foo"
174               },
175               "feature_id": "foo",
176               "last_checked_at": "foo",
177               "maintainer_id": "foo"
178             }
179           ],
180           "icon": "foo",
181           "id": "foo",
182           "name": "foo",
183           "plans": [
184             {
185               "id": "foo",
186               "name": "foo",
187               "description": "foo",
188               "image_url": "foo"
189             }
190           ],
191           "updated_at": "foo",
192           "event_subtype": "foo",
193           "event_summary": {
194             "environment_id": "foo",
195             "event_count": 42,
196             "event_subtype": "foo",
197             "company_count": 42,
198             "last_seen_at": "foo",
199             "user_count": 42
200           },
201           "lifecycle_phase": "foo",
202           "maintainer_id": "foo",
203           "plural_name": "foo",
204           "singular_name": "foo",
205           "trait": {
206             "created_at": "foo",
207             "display_name": "foo",
208             "entity_type": "foo",
209             "hierarchy": [
210               "foo"
211             ],
212             "id": "foo",
213             "trait_type": "foo",
214             "updated_at": "foo"
215           },
216           "trait_id": "foo"
217         },
218         "metric_reset_at": "foo",
219         "month_reset": "foo",
220         "monthly_usage_based_price": {
221           "billing_scheme": "foo",
222           "created_at": "foo",
223           "currency": "foo",
224           "id": "foo",
225           "interval": "foo",
226           "is_active": true,
227           "package_size": 42,
228           "price": 42,
229           "price_external_id": "foo",
230           "price_id": "foo",
231           "price_tier": [
232             {
233               "flat_amount": 42,
234               "per_unit_price": 42,
235               "per_unit_price_decimal": "foo",
236               "up_to": 42
237             }
238           ],
239           "product_external_id": "foo",
240           "product_id": "foo",
241           "product_name": "foo",
242           "updated_at": "foo",
243           "usage_type": "foo",
244           "meter_event_name": "foo",
245           "meter_event_payload_key": "foo",
246           "meter_id": "foo",
247           "price_decimal": "foo",
248           "tiers_mode": "foo"
249         },
250         "period": "foo",
251         "plan": {
252           "created_at": "foo",
253           "description": "foo",
254           "icon": "foo",
255           "id": "foo",
256           "name": "foo",
257           "plan_type": "foo",
258           "updated_at": "foo",
259           "audience_type": "foo"
260         },
261         "price_behavior": "foo",
262         "soft_limit": 42,
263         "usage": 42,
264         "yearly_usage_based_price": {
265           "billing_scheme": "foo",
266           "created_at": "foo",
267           "currency": "foo",
268           "id": "foo",
269           "interval": "foo",
270           "is_active": true,
271           "package_size": 42,
272           "price": 42,
273           "price_external_id": "foo",
274           "price_id": "foo",
275           "price_tier": [
276             {
277               "flat_amount": 42,
278               "per_unit_price": 42,
279               "per_unit_price_decimal": "foo",
280               "up_to": 42
281             }
282           ],
283           "product_external_id": "foo",
284           "product_id": "foo",
285           "product_name": "foo",
286           "updated_at": "foo",
287           "usage_type": "foo",
288           "meter_event_name": "foo",
289           "meter_event_payload_key": "foo",
290           "meter_id": "foo",
291           "price_decimal": "foo",
292           "tiers_mode": "foo"
293         }
294       }
295     ]
296   },
297   "params": {
298     "keys": {}
299   }
300 }

Query parameters

keysmap from strings to stringsRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Get feature usage by company

Headers

Query parameters

Response

Errors