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           "billing_scheme": "billing_scheme",
162           "created_at": "2024-01-15T09:30:00Z",
163           "currency": "currency",
164           "id": "id",
165           "interval": "interval",
166           "is_active": true,
167           "package_size": 1,
168           "price": 1,
169           "price_external_id": "price_external_id",
170           "price_id": "price_id",
171           "price_tier": [
172             {
173               "flat_amount": 1,
174               "per_unit_price": 1,
175               "per_unit_price_decimal": "per_unit_price_decimal",
176               "up_to": 1
177             },
178             {
179               "flat_amount": 1,
180               "per_unit_price": 1,
181               "per_unit_price_decimal": "per_unit_price_decimal",
182               "up_to": 1
183             }
184           ],
185           "product_external_id": "product_external_id",
186           "product_id": "product_id",
187           "product_name": "product_name",
188           "updated_at": "2024-01-15T09:30:00Z",
189           "usage_type": "usage_type",
190           "meter_id": "meter_id",
191           "price_decimal": "price_decimal"
192         },
193         "period": "period",
194         "plan": {
195           "created_at": "2024-01-15T09:30:00Z",
196           "description": "description",
197           "icon": "icon",
198           "id": "id",
199           "name": "name",
200           "plan_type": "plan_type",
201           "updated_at": "2024-01-15T09:30:00Z",
202           "audience_type": "audience_type"
203         },
204         "price_behavior": "price_behavior",
205         "soft_limit": 1,
206         "usage": 1,
207         "yearly_usage_based_price": {
208           "billing_scheme": "billing_scheme",
209           "created_at": "2024-01-15T09:30:00Z",
210           "currency": "currency",
211           "id": "id",
212           "interval": "interval",
213           "is_active": true,
214           "package_size": 1,
215           "price": 1,
216           "price_external_id": "price_external_id",
217           "price_id": "price_id",
218           "price_tier": [
219             {
220               "flat_amount": 1,
221               "per_unit_price": 1,
222               "per_unit_price_decimal": "per_unit_price_decimal",
223               "up_to": 1
224             },
225             {
226               "flat_amount": 1,
227               "per_unit_price": 1,
228               "per_unit_price_decimal": "per_unit_price_decimal",
229               "up_to": 1
230             }
231           ],
232           "product_external_id": "product_external_id",
233           "product_id": "product_id",
234           "product_name": "product_name",
235           "updated_at": "2024-01-15T09:30:00Z",
236           "usage_type": "usage_type",
237           "meter_id": "meter_id",
238           "price_decimal": "price_decimal"
239         }
240       },
241       {
242         "access": true,
243         "allocation_type": "boolean",
244         "entitlement_id": "entitlement_id",
245         "entitlement_type": "entitlement_type",
246         "allocation": 1,
247         "entitlement_expiration_date": "2024-01-15T09:30:00Z",
248         "feature": {
249           "created_at": "2024-01-15T09:30:00Z",
250           "description": "description",
251           "feature_type": "feature_type",
252           "flags": [
253             {
254               "created_at": "2024-01-15T09:30:00Z",
255               "default_value": true,
256               "description": "description",
257               "flag_type": "flag_type",
258               "id": "id",
259               "key": "key",
260               "name": "name",
261               "rules": [
262                 {
263                   "condition_groups": [],
264                   "conditions": [],
265                   "created_at": "2024-01-15T09:30:00Z",
266                   "environment_id": "environment_id",
267                   "id": "id",
268                   "name": "name",
269                   "priority": 1,
270                   "rule_type": "rule_type",
271                   "updated_at": "2024-01-15T09:30:00Z",
272                   "value": true
273                 },
274                 {
275                   "condition_groups": [],
276                   "conditions": [],
277                   "created_at": "2024-01-15T09:30:00Z",
278                   "environment_id": "environment_id",
279                   "id": "id",
280                   "name": "name",
281                   "priority": 1,
282                   "rule_type": "rule_type",
283                   "updated_at": "2024-01-15T09:30:00Z",
284                   "value": true
285                 }
286               ],
287               "updated_at": "2024-01-15T09:30:00Z",
288               "feature": {
289                 "created_at": "2024-01-15T09:30:00Z",
290                 "description": "description",
291                 "feature_type": "feature_type",
292                 "icon": "icon",
293                 "id": "id",
294                 "name": "name",
295                 "updated_at": "2024-01-15T09:30:00Z"
296               },
297               "feature_id": "feature_id",
298               "last_checked_at": "2024-01-15T09:30:00Z",
299               "maintainer_id": "maintainer_id"
300             },
301             {
302               "created_at": "2024-01-15T09:30:00Z",
303               "default_value": true,
304               "description": "description",
305               "flag_type": "flag_type",
306               "id": "id",
307               "key": "key",
308               "name": "name",
309               "rules": [
310                 {
311                   "condition_groups": [],
312                   "conditions": [],
313                   "created_at": "2024-01-15T09:30:00Z",
314                   "environment_id": "environment_id",
315                   "id": "id",
316                   "name": "name",
317                   "priority": 1,
318                   "rule_type": "rule_type",
319                   "updated_at": "2024-01-15T09:30:00Z",
320                   "value": true
321                 },
322                 {
323                   "condition_groups": [],
324                   "conditions": [],
325                   "created_at": "2024-01-15T09:30:00Z",
326                   "environment_id": "environment_id",
327                   "id": "id",
328                   "name": "name",
329                   "priority": 1,
330                   "rule_type": "rule_type",
331                   "updated_at": "2024-01-15T09:30:00Z",
332                   "value": true
333                 }
334               ],
335               "updated_at": "2024-01-15T09:30:00Z",
336               "feature": {
337                 "created_at": "2024-01-15T09:30:00Z",
338                 "description": "description",
339                 "feature_type": "feature_type",
340                 "icon": "icon",
341                 "id": "id",
342                 "name": "name",
343                 "updated_at": "2024-01-15T09:30:00Z"
344               },
345               "feature_id": "feature_id",
346               "last_checked_at": "2024-01-15T09:30:00Z",
347               "maintainer_id": "maintainer_id"
348             }
349           ],
350           "icon": "icon",
351           "id": "id",
352           "name": "name",
353           "plans": [
354             {
355               "id": "id",
356               "name": "name",
357               "description": "description",
358               "image_url": "image_url"
359             },
360             {
361               "id": "id",
362               "name": "name",
363               "description": "description",
364               "image_url": "image_url"
365             }
366           ],
367           "updated_at": "2024-01-15T09:30:00Z",
368           "event_subtype": "event_subtype",
369           "event_summary": {
370             "company_count": 1,
371             "environment_id": "environment_id",
372             "event_count": 1,
373             "event_subtype": "event_subtype",
374             "user_count": 1,
375             "last_seen_at": "2024-01-15T09:30:00Z"
376           },
377           "lifecycle_phase": "lifecycle_phase",
378           "maintainer_id": "maintainer_id",
379           "plural_name": "plural_name",
380           "singular_name": "singular_name",
381           "trait": {
382             "created_at": "2024-01-15T09:30:00Z",
383             "display_name": "display_name",
384             "entity_type": "entity_type",
385             "hierarchy": [
386               "hierarchy",
387               "hierarchy"
388             ],
389             "id": "id",
390             "trait_type": "trait_type",
391             "updated_at": "2024-01-15T09:30:00Z"
392           },
393           "trait_id": "trait_id"
394         },
395         "metric_reset_at": "2024-01-15T09:30:00Z",
396         "month_reset": "month_reset",
397         "monthly_usage_based_price": {
398           "billing_scheme": "billing_scheme",
399           "created_at": "2024-01-15T09:30:00Z",
400           "currency": "currency",
401           "id": "id",
402           "interval": "interval",
403           "is_active": true,
404           "package_size": 1,
405           "price": 1,
406           "price_external_id": "price_external_id",
407           "price_id": "price_id",
408           "price_tier": [
409             {
410               "flat_amount": 1,
411               "per_unit_price": 1,
412               "per_unit_price_decimal": "per_unit_price_decimal",
413               "up_to": 1
414             },
415             {
416               "flat_amount": 1,
417               "per_unit_price": 1,
418               "per_unit_price_decimal": "per_unit_price_decimal",
419               "up_to": 1
420             }
421           ],
422           "product_external_id": "product_external_id",
423           "product_id": "product_id",
424           "product_name": "product_name",
425           "updated_at": "2024-01-15T09:30:00Z",
426           "usage_type": "usage_type",
427           "meter_id": "meter_id",
428           "price_decimal": "price_decimal"
429         },
430         "period": "period",
431         "plan": {
432           "created_at": "2024-01-15T09:30:00Z",
433           "description": "description",
434           "icon": "icon",
435           "id": "id",
436           "name": "name",
437           "plan_type": "plan_type",
438           "updated_at": "2024-01-15T09:30:00Z",
439           "audience_type": "audience_type"
440         },
441         "price_behavior": "price_behavior",
442         "soft_limit": 1,
443         "usage": 1,
444         "yearly_usage_based_price": {
445           "billing_scheme": "billing_scheme",
446           "created_at": "2024-01-15T09:30:00Z",
447           "currency": "currency",
448           "id": "id",
449           "interval": "interval",
450           "is_active": true,
451           "package_size": 1,
452           "price": 1,
453           "price_external_id": "price_external_id",
454           "price_id": "price_id",
455           "price_tier": [
456             {
457               "flat_amount": 1,
458               "per_unit_price": 1,
459               "per_unit_price_decimal": "per_unit_price_decimal",
460               "up_to": 1
461             },
462             {
463               "flat_amount": 1,
464               "per_unit_price": 1,
465               "per_unit_price_decimal": "per_unit_price_decimal",
466               "up_to": 1
467             }
468           ],
469           "product_external_id": "product_external_id",
470           "product_id": "product_id",
471           "product_name": "product_name",
472           "updated_at": "2024-01-15T09:30:00Z",
473           "usage_type": "usage_type",
474           "meter_id": "meter_id",
475           "price_decimal": "price_decimal"
476         }
477       }
478     ]
479   },
480   "params": {
481     "keys": {
482       "keys": "keys"
483     }
484   }
485 }

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