Code Monkey home page Code Monkey logo

cli-plugin-abtest's Introduction

VTEX Plugin A/B Test

vtex plugin abtest

oclif npm

Usage

Host: app.io.vtex.com

Initialize a test or add workspaces to a running test:

/vtex.ab-tester/v0/{{account}}/master/\_v/private/abtesting/initialize

Body:

{
  "InitializingWorkspaces": "Workspace1 Workspace2 Workspace3",    // the workspaces that will be tested; no need to include master
  "Proportion": 5000,    // 100 times the percentage of traffic you want the master workspace to receive during the first hours of test
  "Hours": 5,    // the number of hours the test will run with the initially fixed proportion (after that, it starts to update the proportion accordingly to each workspace's performance
  "Type": "conversion"   // you can also select "revenue", in which case the ab-testing system will look at each workspace's revenue (and not conversion) when updating the traffic
}

Get the status of a test:

/vtex.ab-tester/v0/{{account}}/master/\_v/private/abtesting/status

Remove a specific workspace from a running test:

/vtex.ab-tester/v0/{{account}}/master/\_v/private/abtesting/finish/{{finishingWorkspace}}

To finish a test:

/vtex.ab-tester/v0/{{account}}/master/\_v/private/abtesting/finish

Important note

If you add or remove a workspace to/from a running test, the test is reinitialized, which means that the starting date is updated. (edited)

Commands

oclif-example workspace:abtest:finish

Stops all A/B tests from running on the current account.

USAGE
  $ oclif-example workspace:abtest:finish

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

See code: build/commands/workspace/abtest/finish.ts

oclif-example workspace:abtest:start

Starts a new A/B test on the current workspace.

USAGE
  $ oclif-example workspace:abtest:start

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

See code: build/commands/workspace/abtest/start.ts

oclif-example workspace:abtest:status

Displays the results of the active A/B tests.

USAGE
  $ oclif-example workspace:abtest:status

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  Show debug level logs
  --trace        Ensure all requests to VTEX IO are traced

See code: build/commands/workspace/abtest/status.ts

cli-plugin-abtest's People

Contributors

verasthiago avatar valentino-amadeus avatar mateuspontes avatar carolinamenezes avatar

Stargazers

Filipe W. Lima avatar

Watchers

Rafael Floriano da Silva avatar Lucas Marinho avatar Alan Prando avatar Guilherme Carvalho avatar Lailson Bandeira avatar Thiago Emmanuel Pereira avatar Douglas Lima avatar Cláudio Luz avatar James Cloos avatar Merca Ionel avatar Lenderson Morais avatar Raony Benjamim de Assis Alves avatar Guilherme Dantas Heynemann Bruzzi avatar Felippe Nardi avatar Lucian Sturião avatar Anderson Moreira avatar Raphael Saez avatar ronanpcruz avatar Jessé Soares avatar Alexandre Fumes avatar  avatar  avatar Carla Demarchi avatar pipinho avatar Antonio Freire avatar  avatar James Van Arsdale III avatar  avatar  avatar Renan Sies avatar Ellen Silva avatar Ricardo Neto avatar Will Ferri avatar Carolina Krrô avatar Pedro Gabriel avatar Dandy Hirama avatar Leandro Karam avatar Ana Luiza Motta avatar Vítor de Albuquerque Torreão avatar Válber Laux avatar Renan Porto avatar Raildo Mascena de Sousa Filho avatar Hector Tinjaca Sanchez avatar Artur Magalhães avatar Eric Reis Figueiredo avatar Mayza Nunes avatar Vtex Integration Tool avatar Felipe Cardoso Barbosa avatar Eduardo Insaurriaga avatar  avatar Lucas Schenatto avatar Bernardo Lemgruber avatar Augusto Lazaro avatar Rafael Nascimento Bezerra avatar Marcel Fernandes avatar Antonio Müller avatar Vilma Bezerra Alves avatar Anderson Menezes avatar Gustavo Ribeiro avatar Mateus Ildefonso avatar Paulo Vinicius Soares avatar Eduardo Mendes Camara avatar Albert Mendoza avatar André De Marco Toyama avatar Marcelo Meneses avatar Jose Angel Bermudez avatar Mateus Ribeiro de Castro avatar Alysson Gomes avatar Julia Feitosa  avatar  avatar Carla Frazão avatar deimer.marin avatar Larissa Coelho avatar Matheus Oliveira avatar  avatar Guilherme Barros avatar Lucas Feijó avatar Eric Breno avatar L B avatar Juliana Skubs  avatar  avatar Murilo Varela avatar Wagner Lemos Duarte avatar DENIS MARCELO SANTA HELENA avatar arthur sampaio  avatar Gisely Lacerda avatar Nicácio Oliveira de Sousa avatar  avatar Fabiana Ferreira Fonseca avatar Pedro Oliveira avatar Camilo Andres Camargo De Martino avatar  avatar ullayne avatar  avatar Andreia Almeida avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.