Difference between revisions of "User: JenkinsSBO"
From Genesys Documentation
JenkinsSBO (talk | contribs) |
JenkinsSBO (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | == APIs == | ||
{{YAML | {{YAML | ||
|id= | |id= | ||
| − | yaml- | + | yaml-23-0 |
|method= | |method= | ||
| − | + | POST | |
|content= | |content= | ||
|path= | |path= | ||
| − | / | + | /ab_testing/join |
|parameters= | |parameters= | ||
{{{!}} | {{{!}} | ||
| − | ! Name | + | !width="10%"{{!}} Name |
| − | ! Located in | + | !width="27%"{{!}} Located in |
| − | ! Description | + | !width="29%"{{!}} Description |
| − | ! Required | + | !width="21%"{{!}} Required |
| − | ! Schema | + | !width="10%"{{!}} Schema |
{{!}}- | {{!}}- | ||
{{!}} json | {{!}} json | ||
{{!}} body | {{!}} body | ||
| − | {{!}} A valid JSON containing ''''' | + | {{!}} A valid JSON containing the following parameters: '''token''', '''prrPredictor''', '''from_date''' (optional), '''to_date''' (optional). For additional details, see the schema definition. |
{{!}} Yes | {{!}} Yes | ||
| − | {{!}} | + | {{!}} [[#predictorabtestrequest|PredictorABTestRequest]] |
{{!}}} | {{!}}} | ||
| − | |summary= | + | |summary=A/B Test predictor |
|description= | |description= | ||
| − | A | + | A POST REST endpoint to join A/B test predictor. |
| − | <pre>curl -X | + | <pre>curl -X POST |
| − | + | 'https://app.journeyoptimization.com/api/v2.0/ab_testing/join' | |
| − | + | -H 'Content-Type: application/json' | |
| − | + | -d '{ | |
| + | "prrPredictor": "P1", | ||
"token": "token", | "token": "token", | ||
| − | " | + | "from_date": "11/11/2011", |
| − | + | "to_date": "12/12/2012" | |
| + | }'</pre> | ||
|responses= | |responses= | ||
| − | {{{!}} | + | { |
| + | {{!}} | ||
! Code | ! Code | ||
! Description | ! Description | ||
| − | {{!}}} | + | ! Schema |
| + | |||
| + | {{!}}- | ||
| + | |||
| + | |||
| + | {{!}} 200 | ||
| + | {{!}} The job result to join A/B data. | ||
| + | |||
| + | '''Example''' (''JSON response''): | ||
| − | + | <pre>{ | |
| − | <pre>{ | + | "ok": true, |
| + | "message": "Job to join A/B data started successfully." | ||
| + | }</pre> | ||
| + | |||
| + | {{!}} object | ||
{{!}} | {{!}} | ||
| + | {{!}}} | ||
|security= | |security= | ||
}} | }} | ||
Revision as of 08:23, October 7, 2020
Contents
APIs[ | edit source]
POST /ab_testing/join
A/B Test predictor
Description
A POST REST endpoint to join A/B test predictor.
curl -X POST
'https://app.journeyoptimization.com/api/v2.0/ab_testing/join'
-H 'Content-Type: application/json'
-d '{
"prrPredictor": "P1",
"token": "token",
"from_date": "11/11/2011",
"to_date": "12/12/2012"
}'
Parameters[edit source]
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| json | body | A valid JSON containing the following parameters: token, prrPredictor, from_date (optional), to_date (optional). For additional details, see the schema definition. | Yes | PredictorABTestRequest |
Responses
{ | ! Code ! Description ! Schema
|-
| 200
| The job result to join A/B data.
Example (JSON response):
{
"ok": true,
"message": "Job to join A/B data started successfully."
}
| object | |}