Get feature usage by company

GET

Query parameters

keysmap from strings to anyRequired

Key/value pairs

Response

This endpoint returns an object

dataobject

paramsobject

Input parameters

GET

1 curl -G https://api.schematichq.com/usage-by-company \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      --data-urlencode keys={"string":{}}

200Retrieved

1 {
2   "data": {
3     "features": [
4       {
5         "access": true,
6         "allocation": 0,
7         "allocation_type": "boolean",
8         "entitlement_id": "string",
9         "entitlement_type": "string",
10         "feature": {
11           "created_at": "2023-01-01T00:00:00Z",
12           "description": "string",
13           "event_subtype": "string",
14           "event_summary": {
15             "company_count": 0,
16             "environment_id": "string",
17             "event_count": 0,
18             "event_subtype": "string",
19             "last_seen_at": "2023-01-01T00:00:00Z",
20             "user_count": 0
21           },
22           "feature_type": "string",
23           "flags": [
24             {
25               "created_at": "2023-01-01T00:00:00Z",
26               "default_value": true,
27               "description": "string",
28               "feature": {
29                 "created_at": "2023-01-01T00:00:00Z",
30                 "description": "string",
31                 "event_subtype": "string",
32                 "feature_type": "string",
33                 "icon": "string",
34                 "id": "string",
35                 "lifecycle_phase": "string",
36                 "maintainer_id": "string",
37                 "name": "string",
38                 "trait_id": "string",
39                 "updated_at": "2023-01-01T00:00:00Z"
40               },
41               "feature_id": "string",
42               "flag_type": "string",
43               "id": "string",
44               "key": "string",
45               "last_checked_at": "2023-01-01T00:00:00Z",
46               "maintainer_id": "string",
47               "name": "string",
48               "rules": [
49                 {
50                   "condition_groups": [
51                     {
52                       "conditions": [
53                         {
54                           "comparison_trait": {
55                             "created_at": "2023-01-01T00:00:00Z",
56                             "display_name": "string",
57                             "entity_type": "string",
58                             "hierarchy": [
59                               "string"
60                             ],
61                             "id": "string",
62                             "trait_type": "string",
63                             "updated_at": "2023-01-01T00:00:00Z"
64                           },
65                           "comparison_trait_id": "string",
66                           "condition_group_id": "string",
67                           "condition_type": "string",
68                           "created_at": "2023-01-01T00:00:00Z",
69                           "environment_id": "string",
70                           "event_subtype": "string",
71                           "flag_id": "string",
72                           "id": "string",
73                           "metric_period": "string",
74                           "metric_value": 0,
75                           "operator": "string",
76                           "plan_id": "string",
77                           "resource_ids": [
78                             "string"
79                           ],
80                           "resources": [
81                             {
82                               "id": "string",
83                               "name": "string"
84                             }
85                           ],
86                           "rule_id": "string",
87                           "trait": {
88                             "created_at": "2023-01-01T00:00:00Z",
89                             "display_name": "string",
90                             "entity_type": "string",
91                             "hierarchy": [
92                               "string"
93                             ],
94                             "id": "string",
95                             "trait_type": "string",
96                             "updated_at": "2023-01-01T00:00:00Z"
97                           },
98                           "trait_entity_type": "string",
99                           "trait_id": "string",
100                           "trait_value": "string",
101                           "updated_at": "2023-01-01T00:00:00Z"
102                         }
103                       ],
104                       "created_at": "2023-01-01T00:00:00Z",
105                       "environment_id": "string",
106                       "flag_id": "string",
107                       "id": "string",
108                       "plan_id": "string",
109                       "rule_id": "string",
110                       "updated_at": "2023-01-01T00:00:00Z"
111                     }
112                   ],
113                   "conditions": [
114                     {
115                       "comparison_trait": {
116                         "created_at": "2023-01-01T00:00:00Z",
117                         "display_name": "string",
118                         "entity_type": "string",
119                         "hierarchy": [
120                           "string"
121                         ],
122                         "id": "string",
123                         "trait_type": "string",
124                         "updated_at": "2023-01-01T00:00:00Z"
125                       },
126                       "comparison_trait_id": "string",
127                       "condition_group_id": "string",
128                       "condition_type": "string",
129                       "created_at": "2023-01-01T00:00:00Z",
130                       "environment_id": "string",
131                       "event_subtype": "string",
132                       "flag_id": "string",
133                       "id": "string",
134                       "metric_period": "string",
135                       "metric_value": 0,
136                       "operator": "string",
137                       "plan_id": "string",
138                       "resource_ids": [
139                         "string"
140                       ],
141                       "resources": [
142                         {
143                           "id": "string",
144                           "name": "string"
145                         }
146                       ],
147                       "rule_id": "string",
148                       "trait": {
149                         "created_at": "2023-01-01T00:00:00Z",
150                         "display_name": "string",
151                         "entity_type": "string",
152                         "hierarchy": [
153                           "string"
154                         ],
155                         "id": "string",
156                         "trait_type": "string",
157                         "updated_at": "2023-01-01T00:00:00Z"
158                       },
159                       "trait_entity_type": "string",
160                       "trait_id": "string",
161                       "trait_value": "string",
162                       "updated_at": "2023-01-01T00:00:00Z"
163                     }
164                   ],
165                   "created_at": "2023-01-01T00:00:00Z",
166                   "environment_id": "string",
167                   "flag_id": "string",
168                   "id": "string",
169                   "name": "string",
170                   "plan_id": "string",
171                   "priority": 0,
172                   "rule_type": "string",
173                   "updated_at": "2023-01-01T00:00:00Z",
174                   "value": true
175                 }
176               ],
177               "updated_at": "2023-01-01T00:00:00Z"
178             }
179           ],
180           "icon": "string",
181           "id": "string",
182           "lifecycle_phase": "string",
183           "maintainer_id": "string",
184           "name": "string",
185           "plans": [
186             {
187               "description": "string",
188               "id": "string",
189               "image_url": "string",
190               "name": "string"
191             }
192           ],
193           "trait": {
194             "created_at": "2023-01-01T00:00:00Z",
195             "display_name": "string",
196             "entity_type": "string",
197             "hierarchy": [
198               "string"
199             ],
200             "id": "string",
201             "trait_type": "string",
202             "updated_at": "2023-01-01T00:00:00Z"
203           },
204           "trait_id": "string",
205           "updated_at": "2023-01-01T00:00:00Z"
206         },
207         "period": "string",
208         "plan": {
209           "audience_type": "string",
210           "created_at": "2023-01-01T00:00:00Z",
211           "description": "string",
212           "icon": "string",
213           "id": "string",
214           "name": "string",
215           "plan_type": "string",
216           "updated_at": "2023-01-01T00:00:00Z"
217         },
218         "usage": 0
219       }
220     ]
221   },
222   "params": {
223     "keys": {
224       "string": {}
225     }
226   }
227 }

Built with

1	curl -G https://api.schematichq.com/usage-by-company \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	--data-urlencode keys={"string":{}}

1	{
2	"data": {
3	"features": [
4	{
5	"access": true,
6	"allocation": 0,
7	"allocation_type": "boolean",
8	"entitlement_id": "string",
9	"entitlement_type": "string",
10	"feature": {
11	"created_at": "2023-01-01T00:00:00Z",
12	"description": "string",
13	"event_subtype": "string",
14	"event_summary": {
15	"company_count": 0,
16	"environment_id": "string",
17	"event_count": 0,
18	"event_subtype": "string",
19	"last_seen_at": "2023-01-01T00:00:00Z",
20	"user_count": 0
21	},
22	"feature_type": "string",
23	"flags": [
24	{
25	"created_at": "2023-01-01T00:00:00Z",
26	"default_value": true,
27	"description": "string",
28	"feature": {
29	"created_at": "2023-01-01T00:00:00Z",
30	"description": "string",
31	"event_subtype": "string",
32	"feature_type": "string",
33	"icon": "string",
34	"id": "string",
35	"lifecycle_phase": "string",
36	"maintainer_id": "string",
37	"name": "string",
38	"trait_id": "string",
39	"updated_at": "2023-01-01T00:00:00Z"
40	},
41	"feature_id": "string",
42	"flag_type": "string",
43	"id": "string",
44	"key": "string",
45	"last_checked_at": "2023-01-01T00:00:00Z",
46	"maintainer_id": "string",
47	"name": "string",
48	"rules": [
49	{
50	"condition_groups": [
51	{
52	"conditions": [
53	{
54	"comparison_trait": {
55	"created_at": "2023-01-01T00:00:00Z",
56	"display_name": "string",
57	"entity_type": "string",
58	"hierarchy": [
59	"string"
60	],
61	"id": "string",
62	"trait_type": "string",
63	"updated_at": "2023-01-01T00:00:00Z"
64	},
65	"comparison_trait_id": "string",
66	"condition_group_id": "string",
67	"condition_type": "string",
68	"created_at": "2023-01-01T00:00:00Z",
69	"environment_id": "string",
70	"event_subtype": "string",
71	"flag_id": "string",
72	"id": "string",
73	"metric_period": "string",
74	"metric_value": 0,
75	"operator": "string",
76	"plan_id": "string",
77	"resource_ids": [
78	"string"
79	],
80	"resources": [
81	{
82	"id": "string",
83	"name": "string"
84	}
85	],
86	"rule_id": "string",
87	"trait": {
88	"created_at": "2023-01-01T00:00:00Z",
89	"display_name": "string",
90	"entity_type": "string",
91	"hierarchy": [
92	"string"
93	],
94	"id": "string",
95	"trait_type": "string",
96	"updated_at": "2023-01-01T00:00:00Z"
97	},
98	"trait_entity_type": "string",
99	"trait_id": "string",
100	"trait_value": "string",
101	"updated_at": "2023-01-01T00:00:00Z"
102	}
103	],
104	"created_at": "2023-01-01T00:00:00Z",
105	"environment_id": "string",
106	"flag_id": "string",
107	"id": "string",
108	"plan_id": "string",
109	"rule_id": "string",
110	"updated_at": "2023-01-01T00:00:00Z"
111	}
112	],
113	"conditions": [
114	{
115	"comparison_trait": {
116	"created_at": "2023-01-01T00:00:00Z",
117	"display_name": "string",
118	"entity_type": "string",
119	"hierarchy": [
120	"string"
121	],
122	"id": "string",
123	"trait_type": "string",
124	"updated_at": "2023-01-01T00:00:00Z"
125	},
126	"comparison_trait_id": "string",
127	"condition_group_id": "string",
128	"condition_type": "string",
129	"created_at": "2023-01-01T00:00:00Z",
130	"environment_id": "string",
131	"event_subtype": "string",
132	"flag_id": "string",
133	"id": "string",
134	"metric_period": "string",
135	"metric_value": 0,
136	"operator": "string",
137	"plan_id": "string",
138	"resource_ids": [
139	"string"
140	],
141	"resources": [
142	{
143	"id": "string",
144	"name": "string"
145	}
146	],
147	"rule_id": "string",
148	"trait": {
149	"created_at": "2023-01-01T00:00:00Z",
150	"display_name": "string",
151	"entity_type": "string",
152	"hierarchy": [
153	"string"
154	],
155	"id": "string",
156	"trait_type": "string",
157	"updated_at": "2023-01-01T00:00:00Z"
158	},
159	"trait_entity_type": "string",
160	"trait_id": "string",
161	"trait_value": "string",
162	"updated_at": "2023-01-01T00:00:00Z"
163	}
164	],
165	"created_at": "2023-01-01T00:00:00Z",
166	"environment_id": "string",
167	"flag_id": "string",
168	"id": "string",
169	"name": "string",
170	"plan_id": "string",
171	"priority": 0,
172	"rule_type": "string",
173	"updated_at": "2023-01-01T00:00:00Z",
174	"value": true
175	}
176	],
177	"updated_at": "2023-01-01T00:00:00Z"
178	}
179	],
180	"icon": "string",
181	"id": "string",
182	"lifecycle_phase": "string",
183	"maintainer_id": "string",
184	"name": "string",
185	"plans": [
186	{
187	"description": "string",
188	"id": "string",
189	"image_url": "string",
190	"name": "string"
191	}
192	],
193	"trait": {
194	"created_at": "2023-01-01T00:00:00Z",
195	"display_name": "string",
196	"entity_type": "string",
197	"hierarchy": [
198	"string"
199	],
200	"id": "string",
201	"trait_type": "string",
202	"updated_at": "2023-01-01T00:00:00Z"
203	},
204	"trait_id": "string",
205	"updated_at": "2023-01-01T00:00:00Z"
206	},
207	"period": "string",
208	"plan": {
209	"audience_type": "string",
210	"created_at": "2023-01-01T00:00:00Z",
211	"description": "string",
212	"icon": "string",
213	"id": "string",
214	"name": "string",
215	"plan_type": "string",
216	"updated_at": "2023-01-01T00:00:00Z"
217	},
218	"usage": 0
219	}
220	]
221	},
222	"params": {
223	"keys": {
224	"string": {}
225	}
226	}
227	}