getABTestCampaign
get
/ccadmin/v1/abTestCampaigns/{abTestCampaignId}
This operation is used to get a specific A/B Test Campaign.
Request
Supported Media Types
- application/json
Path Parameters
-
abTestCampaignId: string
The A/B Test Campaign ID.
Response
Supported Media Types
- application/json
200 Response
The following model is returned when operation succeeds.
Root Schema : getABTestCampaign_response
Type:
Show Source
object
-
actions(optional):
array actions
The actions associated with the A/B Test Campaign.
-
campaignLastEditedInternal(optional):
string
An optional string representing the latest edit date and time of the A/B Test Campaign in UTC format in the internal system.
-
id(optional):
string
The ID of the A/B Test Campaign.
-
links(optional):
array links
Links associated with the A/B Test Campaign, including overview and optionally performance.
-
name(optional):
string
The name of the A/B Test Campaign.
-
publishedAtExternal(optional):
string
An optional string representing the latest publish date and time of the A/B Test Campaign in UTC format in the external system.
-
state(optional):
string
The state of the A/B Test Campaign. Allowed Values: [ "Implementing", "NotCollectingData", "Live", "Paused", "Stopped" ].
-
updatedAtExternal(optional):
string
A string representing the latest update date and time of the A/B Test Campaign in UTC format in the external system.
Nested Schema : links
Type:
array
Links associated with the A/B Test Campaign, including overview and optionally performance.
Show Source
Nested Schema : items
Type:
Show Source
object
-
actionType(optional):
string
The type of action.
-
description(optional):
string
The description for this action.
-
id(optional):
string
The action id.
-
isPrimary(optional):
boolean
A flag to indicate if this action is the primary action for the A/B Test Campaign.
-
mappings(optional):
array mappings
Mappings associated with this action. This array can only contain one value.
-
name(optional):
string
The name of the action.
Nested Schema : mappings
Type:
array
Mappings associated with this action. This array can only contain one value.
Show Source
Nested Schema : items
Type:
Show Source
object
-
mappingId(optional):
string
The id of the mapping.
-
mappingType(optional):
string
The type of the mapping.
-
mappingValue(optional):
object mappingValue
The value for the mapping.
Nested Schema : mappingValue
Type:
object
The value for the mapping.
Show Source
-
conditions(optional):
array conditions
The conditions used to determine if a match occurs. Optional. Only required when the mappingType is productPageConditions or collectionPageConditions. Can't be empty.
-
ids(optional):
array ids
The list of item ids to match. Optional. Only required when the mappingType is productPage or collectionPage. Can't be empty.
-
itemType(optional):
string
The type of item to match. Must be category, product, or a product subtype.
-
operator(optional):
string
The operator to use for the conditional check. This only accepts a value of "all".
-
value(optional):
string
The value to use for the conditional check.
Nested Schema : conditions
Type:
array
The conditions used to determine if a match occurs. Optional. Only required when the mappingType is productPageConditions or collectionPageConditions. Can't be empty.
Show Source
Nested Schema : ids
Type:
array
The list of item ids to match. Optional. Only required when the mappingType is productPage or collectionPage. Can't be empty.
Show Source
Nested Schema : items
Type:
Show Source
object
-
locale(optional):
string
The locale to use for the condition. Optional. Only required if the condition property is localizable.
-
operator(optional):
string
The operator used for checking the condition.
-
property(optional):
string
The collection of product properties to evaluate.
-
value(optional):
string
The value for the condition. Optional. Only not required when the operator is exists or notexists.
Nested Schema : items
Type:
Show Source
object
-
href(optional):
string
The href for the link.
-
rel(optional):
string
The link type.
Example Response (application/json)
{
"updatedAtExternal":"2022-02-06T21:51:22.000Z",
"publishedAtExternal":"2022-02-06T21:51:44.000Z",
"name":"Registration Campaign",
"links":[
{
"rel":"overview",
"href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/92980"
},
{
"rel":"performance",
"href":"https://report-eu.maxymiser.com/site-products_demo_env-com/2381/campaign-Registration Campaign/92980/CampaignPerformanceReport"
},
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/abTestCampaigns/MDkyOTgw"
}
],
"state":"Live",
"id":"MDkyOTgw",
"actions":[
{
"actionType":"Sign_up",
"mappings":[
],
"isPrimary":true,
"name":"RegistrationTracking",
"description":"",
"id":"MBf6Xks6"
},
{
"actionType":"Sales_Quantity",
"mappings":[
],
"isPrimary":false,
"name":"Sales Quantity 5",
"description":"",
"id":"MCk6Sld9"
},
{
"actionType":"Sales_Amount",
"mappings":[
],
"isPrimary":false,
"name":"Sales Amount 8",
"description":"",
"id":"MHk8Dls8"
},
{
"actionType":"Page_Impressions",
"mappings":[
{
"mappingId":"600001",
"mappingValue":{
"ids":[
"prod10017"
]
},
"mappingType":"productPage"
}
],
"isPrimary":false,
"name":"View Action 46",
"description":"",
"id":"MJd8Gks6"
},
{
"actionType":"Page_Impressions",
"mappings":[
{
"mappingId":"600002",
"mappingValue":{
"value":"home",
"operator":"startswith"
},
"mappingType":"pageUrl"
}
],
"isPrimary":false,
"name":"View Action 47",
"description":null,
"id":"MKs6Dnj8"
},
{
"actionType":"Page_Impressions",
"mappings":[
{
"mappingId":"600003",
"mappingValue":{
"itemType":"product",
"conditions":[
{
"property":"brand",
"locale":"en",
"value":"Microsoft",
"operator":"eq"
}
],
"operator":"all"
},
"mappingType":"productPageConditions"
}
],
"isPrimary":false,
"name":"View Action 48",
"description":null,
"id":"MKs7Dks7"
}
],
"campaignLastEditedInternal":"2022-04-13T21:48:24.582Z"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|41000|There is no A/B Test Campaign with ID.|
|41047|An error occurred while trying to sync the A/B Test Campaign.|
|41006|A/B Test Campaign ID is null.|
|41003|A/B Test Campaign repository has not been initialized.|
|41007|An error occurred while trying to access the A/B Test Campaign repository.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code