List feature usage

GET

https://api.schematichq.com/feature-usage

GET

/feature-usage

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

Try it

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

Query parameters

company_idstringOptional

company_keysmap from strings to stringsOptional

feature_idslist of stringsOptional

qstringOptional

without_negative_entitlementsbooleanOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List feature usage

Headers

Query parameters

Response

Errors