Launch a Market Test
Route: /api/ocmr/launch
Action: POST
Launch a Market Test experiment.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
type | string | The type of the Market Test experiment, limited to valid experiment types. |
stimuli | string[] <=5 | Text array of stimuli. |
productType | string | Type of product being launched |
description | string | Optional product description |
Valid experiment types
| Experiment Type | Parameter name |
|---|---|
| Product Concept Test | product-concept-test |
| Business Name Evaluator | company-name-test |
| Domain Name Likability Check | domain-name-likability-check |
| Product Name Test | product-name-test |
| Brand Name Test | brand-name-test |
| Ad Copy Test | ad-copy-test |
| Product Description Test | product-description-test |
Example Query
{
"type": 'company-name-test'
"stimuli": ["Arrizo","Mirai","Baccarat","Philomene","Efris"]
"productType": "Card game"
"description": "A new type of card game, to be played with groups of friends"
}
Response Parameters
| Parameter | Type | Description |
|---|---|---|
id | number | Id of the launching job |
status | string | Status of the job, set to created |
response | string | Response Json when job is completed or failed |
Example Response
{
"id": 948032
"status": 'created'
"response": null
}
Results of checking job status
When checking job status after a launch request has been posted, the response that you receive is dependent on the current job status.
Example Response - Job state is completed
{
"id": 948032
"status": 'completed'
"response": {
"experiment_id": Number // id of experiment being created
}
}
Example Response - Job state is failed
{
"id": 948032
"status": 'created'
"response": {
"message": String|null // error message
}
}
Example Response - Job state is created or pending
{
"id": 948032
"status": 'created'
"response": null
}