List feature usage

GET

Query parameters

company_idstringOptional

company_keysmap from strings to optional stringsOptional

feature_idsstringOptional

qstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

This endpoint returns an object

datalist of objects

The returned resources

paramsobject

Input parameters

GET

1 curl https://api.schematichq.com/feature-usage \
2      -H "X-Schematic-Api-Key: <apiKey>"

200Retrieved

1 {
2   "data": [
3     {
4       "access": true,
5       "allocation": 1,
6       "allocation_type": "boolean",
7       "entitlement_id": "entitlement_id",
8       "entitlement_type": "entitlement_type",
9       "feature": {
10         "created_at": "2024-01-15T09:30:00Z",
11         "description": "description",
12         "feature_type": "feature_type",
13         "flags": [
14           {
15             "created_at": "2024-01-15T09:30:00Z",
16             "default_value": true,
17             "description": "description",
18             "flag_type": "flag_type",
19             "id": "id",
20             "key": "key",
21             "name": "name",
22             "rules": [
23               {
24                 "condition_groups": [
25                   {
26                     "conditions": [
27                       {
28                         "condition_type": "condition_type",
29                         "created_at": "2024-01-15T09:30:00Z",
30                         "environment_id": "environment_id",
31                         "id": "id",
32                         "operator": "operator",
33                         "resource_ids": [
34                           "resource_ids"
35                         ],
36                         "resources": [
37                           {
38                             "id": "id",
39                             "name": "name"
40                           }
41                         ],
42                         "rule_id": "rule_id",
43                         "trait_value": "trait_value",
44                         "updated_at": "2024-01-15T09:30:00Z"
45                       }
46                     ],
47                     "created_at": "2024-01-15T09:30:00Z",
48                     "environment_id": "environment_id",
49                     "id": "id",
50                     "rule_id": "rule_id",
51                     "updated_at": "2024-01-15T09:30:00Z"
52                   }
53                 ],
54                 "conditions": [
55                   {
56                     "condition_type": "condition_type",
57                     "created_at": "2024-01-15T09:30:00Z",
58                     "environment_id": "environment_id",
59                     "id": "id",
60                     "operator": "operator",
61                     "resource_ids": [
62                       "resource_ids"
63                     ],
64                     "resources": [
65                       {
66                         "id": "id",
67                         "name": "name"
68                       }
69                     ],
70                     "rule_id": "rule_id",
71                     "trait_value": "trait_value",
72                     "updated_at": "2024-01-15T09:30:00Z"
73                   }
74                 ],
75                 "created_at": "2024-01-15T09:30:00Z",
76                 "environment_id": "environment_id",
77                 "id": "id",
78                 "name": "name",
79                 "priority": 1,
80                 "rule_type": "rule_type",
81                 "updated_at": "2024-01-15T09:30:00Z",
82                 "value": true
83               }
84             ],
85             "updated_at": "2024-01-15T09:30:00Z"
86           }
87         ],
88         "icon": "icon",
89         "id": "id",
90         "name": "name",
91         "plans": [
92           {
93             "id": "id",
94             "name": "name"
95           }
96         ],
97         "updated_at": "2024-01-15T09:30:00Z"
98       },
99       "period": "period",
100       "plan": {
101         "created_at": "2024-01-15T09:30:00Z",
102         "description": "description",
103         "icon": "icon",
104         "id": "id",
105         "name": "name",
106         "plan_type": "plan_type",
107         "updated_at": "2024-01-15T09:30:00Z"
108       },
109       "usage": 1
110     }
111   ],
112   "params": {
113     "company_id": "company_id",
114     "company_keys": {
115       "key": "value"
116     },
117     "feature_ids": [
118       "feature_ids"
119     ],
120     "limit": 1,
121     "offset": 1,
122     "q": "q"
123   }
124 }

Built with

1	curl https://api.schematichq.com/feature-usage \
2	-H "X-Schematic-Api-Key: <apiKey>"

1	{
2	"data": [
3	{
4	"access": true,
5	"allocation": 1,
6	"allocation_type": "boolean",
7	"entitlement_id": "entitlement_id",
8	"entitlement_type": "entitlement_type",
9	"feature": {
10	"created_at": "2024-01-15T09:30:00Z",
11	"description": "description",
12	"feature_type": "feature_type",
13	"flags": [
14	{
15	"created_at": "2024-01-15T09:30:00Z",
16	"default_value": true,
17	"description": "description",
18	"flag_type": "flag_type",
19	"id": "id",
20	"key": "key",
21	"name": "name",
22	"rules": [
23	{
24	"condition_groups": [
25	{
26	"conditions": [
27	{
28	"condition_type": "condition_type",
29	"created_at": "2024-01-15T09:30:00Z",
30	"environment_id": "environment_id",
31	"id": "id",
32	"operator": "operator",
33	"resource_ids": [
34	"resource_ids"
35	],
36	"resources": [
37	{
38	"id": "id",
39	"name": "name"
40	}
41	],
42	"rule_id": "rule_id",
43	"trait_value": "trait_value",
44	"updated_at": "2024-01-15T09:30:00Z"
45	}
46	],
47	"created_at": "2024-01-15T09:30:00Z",
48	"environment_id": "environment_id",
49	"id": "id",
50	"rule_id": "rule_id",
51	"updated_at": "2024-01-15T09:30:00Z"
52	}
53	],
54	"conditions": [
55	{
56	"condition_type": "condition_type",
57	"created_at": "2024-01-15T09:30:00Z",
58	"environment_id": "environment_id",
59	"id": "id",
60	"operator": "operator",
61	"resource_ids": [
62	"resource_ids"
63	],
64	"resources": [
65	{
66	"id": "id",
67	"name": "name"
68	}
69	],
70	"rule_id": "rule_id",
71	"trait_value": "trait_value",
72	"updated_at": "2024-01-15T09:30:00Z"
73	}
74	],
75	"created_at": "2024-01-15T09:30:00Z",
76	"environment_id": "environment_id",
77	"id": "id",
78	"name": "name",
79	"priority": 1,
80	"rule_type": "rule_type",
81	"updated_at": "2024-01-15T09:30:00Z",
82	"value": true
83	}
84	],
85	"updated_at": "2024-01-15T09:30:00Z"
86	}
87	],
88	"icon": "icon",
89	"id": "id",
90	"name": "name",
91	"plans": [
92	{
93	"id": "id",
94	"name": "name"
95	}
96	],
97	"updated_at": "2024-01-15T09:30:00Z"
98	},
99	"period": "period",
100	"plan": {
101	"created_at": "2024-01-15T09:30:00Z",
102	"description": "description",
103	"icon": "icon",
104	"id": "id",
105	"name": "name",
106	"plan_type": "plan_type",
107	"updated_at": "2024-01-15T09:30:00Z"
108	},
109	"usage": 1
110	}
111	],
112	"params": {
113	"company_id": "company_id",
114	"company_keys": {
115	"key": "value"
116	},
117	"feature_ids": [
118	"feature_ids"
119	],
120	"limit": 1,
121	"offset": 1,
122	"q": "q"
123	}
124	}