Check flag

POST

https://api.schematichq.com/flags/:key/check

POST

/flags/:key/check

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.features.checkFlag("key", {});
8 }
9 main();

1 {
2   "data": {
3     "flag": "string",
4     "reason": "string",
5     "value": true,
6     "company_id": "string",
7     "entitlement": {
8       "feature_id": "string",
9       "feature_key": "string",
10       "value_type": "boolean",
11       "allocation": 1,
12       "consumption_rate": 1.1,
13       "credit_id": "string",
14       "credit_remaining": 1.1,
15       "credit_reserved": 1.1,
16       "credit_settled": 1.1,
17       "credit_total": 1.1,
18       "credit_used": 1.1,
19       "event_name": "string",
20       "event_subtype": "string",
21       "metric_period": "all_time",
22       "metric_reset_at": "2024-01-15T09:30:00Z",
23       "month_reset": "billing_cycle",
24       "soft_limit": 1,
25       "usage": 1,
26       "warning_tiers": [
27         {
28           "key": "string",
29           "value": 1
30         }
31       ]
32     },
33     "error": "string",
34     "feature_usage_period": "all_time",
35     "flag_id": "string",
36     "rule_id": "string",
37     "rule_type": "company_override",
38     "user_id": "string",
39     "feature_allocation": 1,
40     "feature_usage": 1,
41     "feature_usage_event": "string",
42     "feature_usage_reset_at": "2024-01-15T09:30:00Z"
43   },
44   "params": {}
45 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

keystringRequired

key

Request

This endpoint expects an object.

companymap from strings to strings or nullOptional

preflightobjectOptional

Hypothetical usage to evaluate the flag against, for answering “would this action be allowed?” before performing it. Only supported when checking a single flag. Values are caller-asserted and can widen a verdict as well as narrow it, so do not forward untrusted input here when the result gates access. Only the flag value reflects the preflight; the entitlement and usage figures in the response are the company’s current, unsimulated ones

usermap from strings to strings or nullOptional

Response

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error