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": {
7             "key": "value"
8         }
9     }
10 });

Try it

1 {
2   "data": {
3     "features": [
4       {
5         "access": true,
6         "allocation_type": "boolean",
7         "entitlement_id": "entitlement_id",
8         "entitlement_type": "entitlement_type",
9         "allocation": 1,
10         "entitlement_expiration_date": "2024-01-15T09:30:00Z",
11         "feature": {
12           "created_at": "2024-01-15T09:30:00Z",
13           "description": "description",
14           "feature_type": "feature_type",
15           "flags": [
16             {
17               "created_at": "2024-01-15T09:30:00Z",
18               "default_value": true,
19               "description": "description",
20               "flag_type": "flag_type",
21               "id": "id",
22               "key": "key",
23               "name": "name",
24               "rules": [
25                 {
26                   "condition_groups": [],
27                   "conditions": [],
28                   "created_at": "2024-01-15T09:30:00Z",
29                   "environment_id": "environment_id",
30                   "id": "id",
31                   "name": "name",
32                   "priority": 1,
33                   "rule_type": "rule_type",
34                   "updated_at": "2024-01-15T09:30:00Z",
35                   "value": true
36                 },
37                 {
38                   "condition_groups": [],
39                   "conditions": [],
40                   "created_at": "2024-01-15T09:30:00Z",
41                   "environment_id": "environment_id",
42                   "id": "id",
43                   "name": "name",
44                   "priority": 1,
45                   "rule_type": "rule_type",
46                   "updated_at": "2024-01-15T09:30:00Z",
47                   "value": true
48                 }
49               ],
50               "updated_at": "2024-01-15T09:30:00Z",
51               "feature": {
52                 "created_at": "2024-01-15T09:30:00Z",
53                 "description": "description",
54                 "feature_type": "feature_type",
55                 "icon": "icon",
56                 "id": "id",
57                 "name": "name",
58                 "updated_at": "2024-01-15T09:30:00Z"
59               },
60               "feature_id": "feature_id",
61               "last_checked_at": "2024-01-15T09:30:00Z",
62               "maintainer_id": "maintainer_id"
63             },
64             {
65               "created_at": "2024-01-15T09:30:00Z",
66               "default_value": true,
67               "description": "description",
68               "flag_type": "flag_type",
69               "id": "id",
70               "key": "key",
71               "name": "name",
72               "rules": [
73                 {
74                   "condition_groups": [],
75                   "conditions": [],
76                   "created_at": "2024-01-15T09:30:00Z",
77                   "environment_id": "environment_id",
78                   "id": "id",
79                   "name": "name",
80                   "priority": 1,
81                   "rule_type": "rule_type",
82                   "updated_at": "2024-01-15T09:30:00Z",
83                   "value": true
84                 },
85                 {
86                   "condition_groups": [],
87                   "conditions": [],
88                   "created_at": "2024-01-15T09:30:00Z",
89                   "environment_id": "environment_id",
90                   "id": "id",
91                   "name": "name",
92                   "priority": 1,
93                   "rule_type": "rule_type",
94                   "updated_at": "2024-01-15T09:30:00Z",
95                   "value": true
96                 }
97               ],
98               "updated_at": "2024-01-15T09:30:00Z",
99               "feature": {
100                 "created_at": "2024-01-15T09:30:00Z",
101                 "description": "description",
102                 "feature_type": "feature_type",
103                 "icon": "icon",
104                 "id": "id",
105                 "name": "name",
106                 "updated_at": "2024-01-15T09:30:00Z"
107               },
108               "feature_id": "feature_id",
109               "last_checked_at": "2024-01-15T09:30:00Z",
110               "maintainer_id": "maintainer_id"
111             }
112           ],
113           "icon": "icon",
114           "id": "id",
115           "name": "name",
116           "plans": [
117             {
118               "id": "id",
119               "name": "name",
120               "description": "description",
121               "image_url": "image_url"
122             },
123             {
124               "id": "id",
125               "name": "name",
126               "description": "description",
127               "image_url": "image_url"
128             }
129           ],
130           "updated_at": "2024-01-15T09:30:00Z",
131           "event_subtype": "event_subtype",
132           "event_summary": {
133             "company_count": 1,
134             "environment_id": "environment_id",
135             "event_count": 1,
136             "event_subtype": "event_subtype",
137             "user_count": 1,
138             "last_seen_at": "2024-01-15T09:30:00Z"
139           },
140           "lifecycle_phase": "lifecycle_phase",
141           "maintainer_id": "maintainer_id",
142           "plural_name": "plural_name",
143           "singular_name": "singular_name",
144           "trait": {
145             "created_at": "2024-01-15T09:30:00Z",
146             "display_name": "display_name",
147             "entity_type": "entity_type",
148             "hierarchy": [
149               "hierarchy",
150               "hierarchy"
151             ],
152             "id": "id",
153             "trait_type": "trait_type",
154             "updated_at": "2024-01-15T09:30:00Z"
155           },
156           "trait_id": "trait_id"
157         },
158         "metric_reset_at": "2024-01-15T09:30:00Z",
159         "month_reset": "month_reset",
160         "monthly_usage_based_price": {
161           "created_at": "2024-01-15T09:30:00Z",
162           "currency": "currency",
163           "id": "id",
164           "interval": "interval",
165           "is_active": true,
166           "price": 1,
167           "price_external_id": "price_external_id",
168           "price_id": "price_id",
169           "product_external_id": "product_external_id",
170           "product_id": "product_id",
171           "product_name": "product_name",
172           "updated_at": "2024-01-15T09:30:00Z",
173           "usage_type": "usage_type",
174           "meter_id": "meter_id"
175         },
176         "period": "period",
177         "plan": {
178           "created_at": "2024-01-15T09:30:00Z",
179           "description": "description",
180           "icon": "icon",
181           "id": "id",
182           "name": "name",
183           "plan_type": "plan_type",
184           "updated_at": "2024-01-15T09:30:00Z",
185           "audience_type": "audience_type"
186         },
187         "price_behavior": "price_behavior",
188         "soft_limit": 1,
189         "usage": 1,
190         "yearly_usage_based_price": {
191           "created_at": "2024-01-15T09:30:00Z",
192           "currency": "currency",
193           "id": "id",
194           "interval": "interval",
195           "is_active": true,
196           "price": 1,
197           "price_external_id": "price_external_id",
198           "price_id": "price_id",
199           "product_external_id": "product_external_id",
200           "product_id": "product_id",
201           "product_name": "product_name",
202           "updated_at": "2024-01-15T09:30:00Z",
203           "usage_type": "usage_type",
204           "meter_id": "meter_id"
205         }
206       },
207       {
208         "access": true,
209         "allocation_type": "boolean",
210         "entitlement_id": "entitlement_id",
211         "entitlement_type": "entitlement_type",
212         "allocation": 1,
213         "entitlement_expiration_date": "2024-01-15T09:30:00Z",
214         "feature": {
215           "created_at": "2024-01-15T09:30:00Z",
216           "description": "description",
217           "feature_type": "feature_type",
218           "flags": [
219             {
220               "created_at": "2024-01-15T09:30:00Z",
221               "default_value": true,
222               "description": "description",
223               "flag_type": "flag_type",
224               "id": "id",
225               "key": "key",
226               "name": "name",
227               "rules": [
228                 {
229                   "condition_groups": [],
230                   "conditions": [],
231                   "created_at": "2024-01-15T09:30:00Z",
232                   "environment_id": "environment_id",
233                   "id": "id",
234                   "name": "name",
235                   "priority": 1,
236                   "rule_type": "rule_type",
237                   "updated_at": "2024-01-15T09:30:00Z",
238                   "value": true
239                 },
240                 {
241                   "condition_groups": [],
242                   "conditions": [],
243                   "created_at": "2024-01-15T09:30:00Z",
244                   "environment_id": "environment_id",
245                   "id": "id",
246                   "name": "name",
247                   "priority": 1,
248                   "rule_type": "rule_type",
249                   "updated_at": "2024-01-15T09:30:00Z",
250                   "value": true
251                 }
252               ],
253               "updated_at": "2024-01-15T09:30:00Z",
254               "feature": {
255                 "created_at": "2024-01-15T09:30:00Z",
256                 "description": "description",
257                 "feature_type": "feature_type",
258                 "icon": "icon",
259                 "id": "id",
260                 "name": "name",
261                 "updated_at": "2024-01-15T09:30:00Z"
262               },
263               "feature_id": "feature_id",
264               "last_checked_at": "2024-01-15T09:30:00Z",
265               "maintainer_id": "maintainer_id"
266             },
267             {
268               "created_at": "2024-01-15T09:30:00Z",
269               "default_value": true,
270               "description": "description",
271               "flag_type": "flag_type",
272               "id": "id",
273               "key": "key",
274               "name": "name",
275               "rules": [
276                 {
277                   "condition_groups": [],
278                   "conditions": [],
279                   "created_at": "2024-01-15T09:30:00Z",
280                   "environment_id": "environment_id",
281                   "id": "id",
282                   "name": "name",
283                   "priority": 1,
284                   "rule_type": "rule_type",
285                   "updated_at": "2024-01-15T09:30:00Z",
286                   "value": true
287                 },
288                 {
289                   "condition_groups": [],
290                   "conditions": [],
291                   "created_at": "2024-01-15T09:30:00Z",
292                   "environment_id": "environment_id",
293                   "id": "id",
294                   "name": "name",
295                   "priority": 1,
296                   "rule_type": "rule_type",
297                   "updated_at": "2024-01-15T09:30:00Z",
298                   "value": true
299                 }
300               ],
301               "updated_at": "2024-01-15T09:30:00Z",
302               "feature": {
303                 "created_at": "2024-01-15T09:30:00Z",
304                 "description": "description",
305                 "feature_type": "feature_type",
306                 "icon": "icon",
307                 "id": "id",
308                 "name": "name",
309                 "updated_at": "2024-01-15T09:30:00Z"
310               },
311               "feature_id": "feature_id",
312               "last_checked_at": "2024-01-15T09:30:00Z",
313               "maintainer_id": "maintainer_id"
314             }
315           ],
316           "icon": "icon",
317           "id": "id",
318           "name": "name",
319           "plans": [
320             {
321               "id": "id",
322               "name": "name",
323               "description": "description",
324               "image_url": "image_url"
325             },
326             {
327               "id": "id",
328               "name": "name",
329               "description": "description",
330               "image_url": "image_url"
331             }
332           ],
333           "updated_at": "2024-01-15T09:30:00Z",
334           "event_subtype": "event_subtype",
335           "event_summary": {
336             "company_count": 1,
337             "environment_id": "environment_id",
338             "event_count": 1,
339             "event_subtype": "event_subtype",
340             "user_count": 1,
341             "last_seen_at": "2024-01-15T09:30:00Z"
342           },
343           "lifecycle_phase": "lifecycle_phase",
344           "maintainer_id": "maintainer_id",
345           "plural_name": "plural_name",
346           "singular_name": "singular_name",
347           "trait": {
348             "created_at": "2024-01-15T09:30:00Z",
349             "display_name": "display_name",
350             "entity_type": "entity_type",
351             "hierarchy": [
352               "hierarchy",
353               "hierarchy"
354             ],
355             "id": "id",
356             "trait_type": "trait_type",
357             "updated_at": "2024-01-15T09:30:00Z"
358           },
359           "trait_id": "trait_id"
360         },
361         "metric_reset_at": "2024-01-15T09:30:00Z",
362         "month_reset": "month_reset",
363         "monthly_usage_based_price": {
364           "created_at": "2024-01-15T09:30:00Z",
365           "currency": "currency",
366           "id": "id",
367           "interval": "interval",
368           "is_active": true,
369           "price": 1,
370           "price_external_id": "price_external_id",
371           "price_id": "price_id",
372           "product_external_id": "product_external_id",
373           "product_id": "product_id",
374           "product_name": "product_name",
375           "updated_at": "2024-01-15T09:30:00Z",
376           "usage_type": "usage_type",
377           "meter_id": "meter_id"
378         },
379         "period": "period",
380         "plan": {
381           "created_at": "2024-01-15T09:30:00Z",
382           "description": "description",
383           "icon": "icon",
384           "id": "id",
385           "name": "name",
386           "plan_type": "plan_type",
387           "updated_at": "2024-01-15T09:30:00Z",
388           "audience_type": "audience_type"
389         },
390         "price_behavior": "price_behavior",
391         "soft_limit": 1,
392         "usage": 1,
393         "yearly_usage_based_price": {
394           "created_at": "2024-01-15T09:30:00Z",
395           "currency": "currency",
396           "id": "id",
397           "interval": "interval",
398           "is_active": true,
399           "price": 1,
400           "price_external_id": "price_external_id",
401           "price_id": "price_id",
402           "product_external_id": "product_external_id",
403           "product_id": "product_id",
404           "product_name": "product_name",
405           "updated_at": "2024-01-15T09:30:00Z",
406           "usage_type": "usage_type",
407           "meter_id": "meter_id"
408         }
409       }
410     ]
411   },
412   "params": {
413     "keys": {
414       "keys": {
415         "key": "value"
416       }
417     }
418   }
419 }

Query parameters

keysmap from strings to anyRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Get feature usage by company

Headers

Query parameters

Response

Errors