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

getABTestCampaigns

get

/ccadmin/v1/abTestCampaigns

Get the list of A/B Test Campaigns.

Request

Supported Media Types
Query Parameters
  • This controls which fields are returned in the response body. For example, to include the ID and Name for each campaign in the list, you can send fields=items.id,items.name.
  • This is the field to specify the number of records to be fetched per REST call.
  • This field specifies the offset/starting index from which data to be fetched.
  • This field specifies the query used to limit campaigns.
  • This field specifies the sort order of the list to be fetched.
  • Indicates if the total results should be included in the response.
Back to Top

Response

Supported Media Types

200 Response

The following model is returned when operation succeeds.
Body ()
Root Schema : getABTestCampaigns_response
Type: object
Show Source
Nested Schema : items
Type: array
The returned list of items.
Show Source
Nested Schema : items
Type: object
Show Source
  • The ID of the A/B Test Campaign.
  • A flag that indicates whether the A/B Test Campaign is a server-side one.
  • 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.
Example Response (application/json)
{
    "total":3,
    "totalResults":3,
    "offset":0,
    "limit":200,
    "links":[
        {
            "rel":"campaigns",
            "href":"https://ui-eu.maxymiser.com/CampaignBuilder/site-products_demo_env-com/2381?showListCampaign=true"
        },
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/abTestCampaigns"
        }
    ],
    "sort":[
        {
            "property":"displayName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "updatedAtExternal":"2021-05-10T18:48:19.0000000Z",
            "isServerSide":false,
            "publishedAtExternal":"2021-05-10T18:48:19.0000000Z",
            "name":"Demo4",
            "links":[
                {
                    "rel":"overview",
                    "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/87797"
                },
                {
                    "rel":"performance",
                    "href":"https://report-eu.maxymiser.com/site-products_demo_env-com/2381/campaign-Demo4/87797/CampaignPerformanceReport"
                }
            ],
            "id":"MDg3Nzk3",
            "state":"Live"
        },
        {
            "updatedAtExternal":"2021-05-17T17:32:50.0000000Z",
            "isServerSide":false,
            "name":"VCS",
            "links":[
                {
                    "rel":"overview",
                    "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/88927"
                }
            ],
            "id":"MDg4OTI3",
            "state":"Implementing"
        },
        {
            "updatedAtExternal":"2021-12-20T23:08:21.0000000Z",
            "isServerSide":true,
            "name":"Server-side Campaign",
            "links":[
                {
                    "rel":"overview",
                    "href":"https://cb-eu.maxymiser.com/campaignBuilder/2381/88996"
                }
            ],
            "id":"MDg4OTk2",
            "state":"Implementing"
        }
    ]
}

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| |------------------|------------------| |41028|Unable to retrieve OAuth token.| |41026|The Campaign Management URL is not valid.| |60051|Error during Campaign Management request.| |41022|Error during Campaign Management request.| |41044|Failing retried request.|
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