List an experiment's arms

Lists the experiment's arms with their weights and the paywall each shows at each location.

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Experiments

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousConclude an experiment NextReplace an experiment's arms

On this page

Authorization Path parameters Query parameters Examples Response body Errors More in Experiments

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

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

experimentId*string

The experiment's id, exp_....

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/experiments/exp_c6v8b3n5q0w2e7h7d2k9m4x1/variants" \  -H "Authorization: Bearer vh_sk_..."

{  "data": [    {      "id": "exp_var_w2e7h7d2k9m4x1c6v8b3n5q0",      "name": "Monthly first",      "isControl": true,      "weightPercentage": 50,      "placements": [        {          "paywallLocationId": "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9",          "paywallId": "pw_r3t6y9u2i5o8p1a4s7d0f3g6"        }      ]    },    {      "id": "exp_var_n5q0w2e7h7d2k9m4x1c6v8b3",      "name": "Annual first",      "isControl": false,      "weightPercentage": 50,      "placements": [        {          "paywallLocationId": "pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9",          "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7"        }      ]    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}

{  "error": {    "type": "invalid_request",    "code": "invalid_query",    "message": "The request query is invalid: Expected a finite number\n  at [\"limit\"]"  }}

{  "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."  }}

List an experiment's arms

Errors

More in Experiments

List an experiment's arms

Errors

More in Experiments

Authorization

Path parameters

Query parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

List an experiment's arms

List an experiment's arms

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`