Rivier/ Reference/ hosting

Plan an A/B test of a page or a section

post/hosting/sites/{id}/experiments

Plan an A/B test of a page or a section: variants are patches, the goal is a click, a form submit or an event, and the baseline rate and the smallest change worth acting on fix how many page views each arm needs. It stays a draft until a person starts it.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Mcp
rivier_site_experiment_plan
Graphql
Mutation.hostingExperimentCreate
Sdk
hosting.experiment.create
Cli
hosting experiment create

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestringrequired
    At most 80 characters.
  • pageIdstringrequired
    At most 80 characters.
  • hypothesisstring
    Default: . At most 400 characters.
  • variantslist of objectrequired
    • namestringrequired
      At most 60 characters.
    • opslist of objectrequired
  • goalobjectrequired
  • baselineRatenumberrequired
    At least 0.001. At most 0.9.
  • minEffectnumber
    Default: 0.2. At least 0.02. At most 1.
  • horizoninteger
    At least 100. At most 1000000.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown