Evaluate flags for an end user

Evaluates the project's flags in use for one end user, as their app would, and says why each came out as it did.

Name the end user by any of personId, distinctId, email or externalIds. Changes nothing and is safe to repeat.

Errors

Status	`type`	`code`	When
400	`invalid_request`	`identity_required`	Without one.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Feature flags

Name the end user by any of personId, distinctId, email or externalIds. Changes nothing and is safe to repeat.

Guide: Feature flags and A/B tests

Errors

Status	`type`	`code`	When
400	`invalid_request`	`identity_required`	Without one.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Feature flags

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

personId?|

The end user's person id, person_....

distinctId?|

A distinct id your app knows the end user by; when it belongs to a person, their other identities match too.

email?|

The end user's email address, for overrides and targets that name it.

externalIds?array<string>|

The end user's external ids, for overrides and targets that name them.

keys?array<string>|

The keys of the flags to evaluate; omitted, every flag in use is.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/feature-flags/evaluate" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "distinctId": "user_8231",    "keys": [      "new-checkout"    ]  }'

{  "flags": [    {      "featureFlagId": "ff_v8b3n5q0w2e7h7d2k9m4x1c6",      "key": "new-checkout",      "isEnabled": true,      "variantKey": null,      "value": null,      "reason": "rollout"    }  ]}

{  "error": {    "type": "invalid_request",    "code": "identity_required",    "message": "Name the end user by personId, distinctId, email or externalIds."  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Evaluate flags for an end user

Errors

More in Feature flags

Evaluate flags for an end user

Errors

More in Feature flags

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Evaluate flags for an end user

Evaluate flags for an end user

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`