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": "entitlement_id",
7       "entitlement_type": "entitlement_type",
8       "allocation": 1,
9       "entitlement_expiration_date": "2024-01-15T09:30:00Z",
10       "feature": {
11         "created_at": "2024-01-15T09:30:00Z",
12         "description": "description",
13         "feature_type": "feature_type",
14         "flags": [
15           {
16             "created_at": "2024-01-15T09:30:00Z",
17             "default_value": true,
18             "description": "description",
19             "flag_type": "flag_type",
20             "id": "id",
21             "key": "key",
22             "name": "name",
23             "rules": [
24               {
25                 "condition_groups": [
26                   {
27                     "conditions": [
28                       {
29                         "condition_type": "condition_type",
30                         "created_at": "2024-01-15T09:30:00Z",
31                         "environment_id": "environment_id",
32                         "id": "id",
33                         "operator": "operator",
34                         "resource_ids": [
35                           "resource_ids"
36                         ],
37                         "resources": [
38                           {
39                             "id": "id",
40                             "name": "name"
41                           }
42                         ],
43                         "rule_id": "rule_id",
44                         "trait_value": "trait_value",
45                         "updated_at": "2024-01-15T09:30:00Z"
46                       }
47                     ],
48                     "created_at": "2024-01-15T09:30:00Z",
49                     "environment_id": "environment_id",
50                     "id": "id",
51                     "rule_id": "rule_id",
52                     "updated_at": "2024-01-15T09:30:00Z"
53                   }
54                 ],
55                 "conditions": [
56                   {
57                     "condition_type": "condition_type",
58                     "created_at": "2024-01-15T09:30:00Z",
59                     "environment_id": "environment_id",
60                     "id": "id",
61                     "operator": "operator",
62                     "resource_ids": [
63                       "resource_ids"
64                     ],
65                     "resources": [
66                       {
67                         "id": "id",
68                         "name": "name"
69                       }
70                     ],
71                     "rule_id": "rule_id",
72                     "trait_value": "trait_value",
73                     "updated_at": "2024-01-15T09:30:00Z"
74                   }
75                 ],
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             "updated_at": "2024-01-15T09:30:00Z"
87           }
88         ],
89         "icon": "icon",
90         "id": "id",
91         "name": "name",
92         "plans": [
93           {
94             "id": "id",
95             "name": "name"
96           }
97         ],
98         "updated_at": "2024-01-15T09:30:00Z"
99       },
100       "metric_reset_at": "2024-01-15T09:30:00Z",
101       "month_reset": "month_reset",
102       "monthly_usage_based_price": {
103         "billing_scheme": "billing_scheme",
104         "created_at": "2024-01-15T09:30:00Z",
105         "currency": "currency",
106         "id": "id",
107         "interval": "interval",
108         "is_active": true,
109         "package_size": 1,
110         "price": 1,
111         "price_external_id": "price_external_id",
112         "price_id": "price_id",
113         "price_tier": [
114           {}
115         ],
116         "product_external_id": "product_external_id",
117         "product_id": "product_id",
118         "product_name": "product_name",
119         "updated_at": "2024-01-15T09:30:00Z",
120         "usage_type": "usage_type"
121       },
122       "period": "period",
123       "plan": {
124         "created_at": "2024-01-15T09:30:00Z",
125         "description": "description",
126         "icon": "icon",
127         "id": "id",
128         "name": "name",
129         "plan_type": "plan_type",
130         "updated_at": "2024-01-15T09:30:00Z"
131       },
132       "price_behavior": "price_behavior",
133       "soft_limit": 1,
134       "usage": 1,
135       "yearly_usage_based_price": {
136         "billing_scheme": "billing_scheme",
137         "created_at": "2024-01-15T09:30:00Z",
138         "currency": "currency",
139         "id": "id",
140         "interval": "interval",
141         "is_active": true,
142         "package_size": 1,
143         "price": 1,
144         "price_external_id": "price_external_id",
145         "price_id": "price_id",
146         "price_tier": [
147           {}
148         ],
149         "product_external_id": "product_external_id",
150         "product_id": "product_id",
151         "product_name": "product_name",
152         "updated_at": "2024-01-15T09:30:00Z",
153         "usage_type": "usage_type"
154       }
155     }
156   ],
157   "params": {
158     "company_id": "company_id",
159     "company_keys": {
160       "key": "value"
161     },
162     "feature_ids": [
163       "feature_ids"
164     ],
165     "limit": 1,
166     "offset": 1,
167     "q": "q",
168     "without_negative_entitlements": true
169   }
170 }

Query parameters

company_idstringOptional

company_keysmap from strings to stringsOptional

feature_idsstringOptional

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