1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Admin
  4. A-B Test Campaigns

getABTestCampaign

get

/ccadmin/v1/abTestCampaigns/{abTestCampaignId}

This operation is used to get a specific A/B Test Campaign.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

The following model is returned when operation succeeds.
Body ()
Root Schema : getABTestCampaign_response
Type: object
Show Source
  • actions
    The actions associated with the A/B Test Campaign.
  • An optional string representing the latest edit date and time of the A/B Test Campaign in UTC format in the internal system.
  • The ID of the A/B Test Campaign.
  • links
  • The name of the A/B Test Campaign.
  • An optional string representing the latest publish date and time of the A/B Test Campaign in UTC format in the external system.
  • The state of the A/B Test Campaign. Allowed Values: [ "Implementing", "NotCollectingData", "Live", "Paused", "Stopped" ].
  • A string representing the latest update date and time of the A/B Test Campaign in UTC format in the external system.
Nested Schema : actions
Type: array
The actions associated with the A/B Test Campaign.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : mappings
Type: array
Mappings associated with this action. This array can only contain one value.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : mappingValue
Type: object
The value for the mapping.
Show Source
  • 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
    The list of item ids to match. Optional. Only required when the mappingType is productPage or collectionPage. Can't be empty.
  • The type of item to match. Must be category, product, or a product subtype.
  • The operator to use for the conditional check. This only accepts a value of "all".
  • 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: object
Show Source
  • The locale to use for the condition. Optional. Only required if the condition property is localizable.
  • The operator used for checking the condition.
  • The collection of product properties to evaluate.
  • The value for the condition. Optional. Only not required when the operator is exists or notexists.
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.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top