VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List experiments
Create an experiment
Retrieve an experiment
Update an experiment
Archive an experiment
Unarchive an experiment
Start an experiment
Pause an experiment
Conclude an experiment
List an experiment's arms
Replace an experiment's arms
Retrieve an experiment's results

Retrieve an experiment's results

Reports each arm's exposures, conversions and revenue since the experiment last started, until it concluded.

A secret key counts its own environment; a person's own credentials choose with x-environment: production (the default), test or all.

Guide: Feature flags and A/B tests

Errors

StatustypecodeWhen
503unavailableexperiment_results_too_largeWhen it has more events than this deployment can count at once.

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

More in Experiments

  • List experiments GET
  • Create an experiment POST
  • Retrieve an experiment GET
  • Update an experiment PATCH
  • Archive an experiment POST
  • Unarchive an experiment POST
  • Start an experiment POST
  • Pause an experiment POST
  • Conclude an experiment POST
  • List an experiment's arms GET
  • Replace an experiment's arms PUT

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

PreviousReplace an experiment's armsNextList feature flags

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Experiments
GET
/api/v1/projects/{projectId}/experiments/{experimentId}/results

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_....

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/experiments/exp_c6v8b3n5q0w2e7h7d2k9m4x1/results" \  -H "Authorization: Bearer vh_sk_..."
{  "experimentId": "exp_c6v8b3n5q0w2e7h7d2k9m4x1",  "primaryMetricEventName": "$subscription.created",  "variants": [    {      "variantId": "exp_var_w2e7h7d2k9m4x1c6v8b3n5q0",      "exposures": 2400,      "conversions": 84,      "conversionRate": 0.035,      "revenue": 41916,      "currency": "USD"    },    {      "variantId": "exp_var_n5q0w2e7h7d2k9m4x1c6v8b3",      "exposures": 2400,      "conversions": 108,      "conversionRate": 0.045,      "revenue": 53892,      "currency": "USD"    }  ]}
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "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."  }}
{  "error": {    "type": "unavailable",    "code": "experiment_results_too_large",    "message": "This experiment has more events than this deployment can count at once."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json