### Get Collection Response Example (JSON)
Source: https://developer.adobe.com/target/administer/recommendations-api
An example of a successful response when retrieving a collection from Adobe Target. It includes the collection's ID, metadata, and the defined rules.
```json
{
"id": 1,
"name": "Backpacking Tents",
"description": "Lightweight tents suitable for backpacking.",
"lastModified": "2018-08-07T16:34:01.000Z",
"lastModifiersName": "Buzz Lightyear",
"lastModifierEmail": "buzz@spacemail.com",
"rules": [
{
"bestUse": {
"equals": [
"backpacking"
]
}
},
{
"weight": {
"less than": [
"10"
]
}
},
{
"capacity": {
"less than": [
"4"
]
}
}
]
}
```
--------------------------------
### Create Collection Payload Example (JSON)
Source: https://developer.adobe.com/target/administer/recommendations-api
An example of a request body payload for creating or updating a collection in Adobe Target. It includes fields for name, description, and a set of rules for matching.
```json
{
"name": "Backpacking Tents",
"description": "Lightweight tents suitable for backpacking.",
"rules": [
{
"bestUse": {
"equals": [
"backpacking"
]
}
},
{
"weight": {
"less than": [
"10"
]
}
},
{
"capacity": {
"less than": [
"4"
]
}
}
]
}
```
--------------------------------
### Create Collection Request Example (cURL)
Source: https://developer.adobe.com/target/administer/recommendations-api
Example of how to make a POST request to create a new collection in Adobe Target Recommendations. It specifies the API endpoint, headers for authentication and content type, and a JSON payload defining the collection's name and rules.
```curl
curl -X POST \
https://mc.adobe.io/{{tenantId}}/target/recs/collections \
-H 'Accept: application/vnd.adobe.target.v1+json' \
-H 'Authorization: Bearer {{bearerToken}}' \
-H 'Content-Type: application/vnd.adobe.target.v1+json' \
-H 'X-Api-Key: {{xApiKey}}' \
-d '{
"name": "Backpacking Tents",
"rules": [
{
"id": {
"contains": [
"backpacking"
]
}
}
]
}'
```
--------------------------------
### Get Popularity Criteria Example (JSON)
Source: https://developer.adobe.com/target/administer/recommendations-api
This snippet shows an example JSON response for a successful GET request to retrieve popularity-based criteria. It includes details like criteria ID, name, type, and configuration.
```json
{
"id": 9321,
"name": "Top sold by region",
"criteriaGroup": "POPULARITY",
"type": "VIEWED",
"key": "customProfileAttribute",
"aggregation": "ALL_OR_NOTHING",
"daysCount": "ONE_MONTH",
"configuration": {
"datasource": "mboxes",
"attribute": "user.name",
"groupByEntityAttribute": "brand",
"grouping": {
"type": "SEQUENTIAL",
"attributes": [
"user.city",
"user.county",
"user.state"
]
}
}
}
```
--------------------------------
### Get Cart Criteria Response Example
Source: https://developer.adobe.com/target/administer/recommendations-api
Example JSON response when successfully retrieving a cart-based criteria by its ID from Adobe Target. The response mirrors the structure of the create/update payload, including all configured settings.
```json
{
"id": 3,
"name": "Users who viewed this also bought that across user sessions in the same category.",
"criteriaGroup": "CART",
"daysCount": "TWO_WEEKS",
"partialDesignAllowed": true,
"backupDisabled": false,
"excludePurchases": true,
"backupInclusionFilteringEnabled": true,
"modelActionSettings": {
"actionOnKeyItems": "VIEW",
"actionOnRecommendedItems": "PURCHASE",
"basisForCoOccurrence": "USER"
},
"configuration": {
"inclusionRulesKey": "LAST_PURCHASED",
"inclusionRules": [
{
"attribute": "category",
"operation": "equals",
"source": {
"name": "category",
"type": "ENTITY",
"excludeAllWhenEmpty": true
}
}
]
}
}
```
--------------------------------
### Create Category Criteria Response Example
Source: https://developer.adobe.com/target/administer/recommendations-api
Example JSON response when a category-based criteria is successfully created or updated in Adobe Target. It includes the assigned ID and all configured parameters.
```json
{
"id": 3,
"name": "Most Popular Content from Visitor's Favorite Category",
"criteriaGroup": "CATEGORY",
"type": "VIEWED",
"key": "FAVORITE",
"aggregation": "NONE",
"daysCount": "TWO_WEEKS",
"partialDesignAllowed": false,
"backupDisabled": false,
"excludePurchases": true,
"enableCaching": false,
"backupInclusionFilteringEnabled": true,
"configuration": {
"pastBehaviorOrdinal": 0
}
}
```
--------------------------------
### Catalog Search Successful Response (JSON)
Source: https://developer.adobe.com/target/administer/recommendations-api
Example JSON response for a successful catalog search. It contains the time taken for the search in milliseconds, a list of 'hits' (matching entities with their details), and the starting index.
```json
{
"timeMs": 1701,
"hits": [
{
"id": 602214076,
"category": [
"household goods",
"restroom",
"paper products"
],
"value": 3.14,
"name": "bathroom tissue"
},
{
"id": 186282,
"value": 2.718,
"name": "hand sanitizer",
"inventory": 86400
}
],
"start": 1
}
```
--------------------------------
### GET /offers/templates
Source: https://developer.adobe.com/target/administer/admin-api
Retrieves a list of offer templates created for a given tenant.
```APIDOC
## List offer templates
### Description
Retrieve the list of previously-created offer templates.
### Method
GET
### Endpoint
`get/{tenant}/target/offers/templates`
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant ID for which to retrieve offer templates.
### Request Example
(No request body for GET requests)
### Response
#### Success Response (200)
- **total** (integer) - The total number of offer templates.
- **templates** (array) - A list of offer template objects.
- **offerTemplateId** (integer) - The unique identifier for the offer template.
- **templateParameters** (array) - A list of parameters for the template.
- **name** (string) - The name of the template parameter.
- **value** (string) - The value of the template parameter.
#### Response Example
```json
{
"total": 0,
"templates": [
{
"offerTemplateId": 0,
"templateParameters": [
{
"name": "string",
"value": "string"
}
]
}
]
}
```
```
--------------------------------
### GET /offers
Source: https://developer.adobe.com/target/administer/admin-api
Retrieves a list of offers for a given tenant. Supports filtering and pagination.
```APIDOC
## GET /offers
### Description
Retrieves a list of offers for a given tenant.
### Method
GET
### Endpoint
`get/{tenant}/target/offers`
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant ID for which to retrieve offers.
### Request Example
(No request body for GET requests)
### Response
#### Success Response (200)
- **total** (integer) - The total number of offers available.
- **offers** (array) - A list of offer objects.
- **id** (integer) - The unique identifier for the offer.
- **name** (string) - The name of the offer.
- **type** (string) - The type of the offer (e.g., 'content').
- **modifiedAt** (string) - The timestamp when the offer was last modified (ISO 8601 format).
- **workspace** (string) - The workspace associated with the offer.
#### Response Example
```json
{
"total": 0,
"offers": [
{
"id": 0,
"name": "string",
"type": "content",
"modifiedAt": "2019-08-24T14:15:22Z",
"workspace": "string"
}
]
}
```
```
--------------------------------
### Adobe Target Create Promotion Request Sample
Source: https://developer.adobe.com/target/administer/recommendations-api
This JSON object demonstrates a sample request body for creating a new promotion in Adobe Target. It includes essential fields like name, type, schedule, order, configuration, and rules, which define the promotion's behavior and targeting. This serves as a template for developers to construct their promotion creation requests.
```json
{
"name": "Hiking shoes summer promotion",
"type": "EXTERNAL",
"schedule": {
"start": "2018-07-01T00:00:00Z",
"end": "2018-08-31T23:59:59Z"
},
"order": {
"type": "ORIGINAL"
},
"configuration": {
"collectionId": 3432
},
"rules": [
{
"attribute": "category",
"operation": "endsWith",
"values": [
"Hiking Shoes"
]
}
]
}
```
--------------------------------
### Create Promotion
Source: https://developer.adobe.com/target/administer/recommendations-api
Creates a new promotion with the specified settings and configuration.
```APIDOC
## POST /promotions
### Description
Creates a new promotion as specified by the settings and configuration provided and returns the newly created promotion definition.
### Method
POST
### Endpoint
https://mc.adobe.io/{tenantId}/target/recs/promotions
### Request Body
- **name** (string) - Required - Max 250 characters. Unique name of the promotion.
- **type** (string) - Required - Value: "EXTERNAL". Type of promotion.
- **key** (string) - Optional - Enum: "CURRENT", "LAST_PURCHASED", "LAST_VIEWED", "MOST_VIEWED", "PROFILE_ATTRIBUTE". Promotion key.
- **attribute** (string) - Optional - Applicable when key is `PROFILE_ATTRIBUTE`. Profile attribute.
- **schedule** (object) - Optional - Time duration for which promotion should be applied.
- **order** (object) - Optional - Specifies the order of promotion items.
- **configuration** (object) - Optional - Applicable only when rules are empty and type is not `INTERNAL`. Contains the relevant collection for promotion items.
- **rules** (array of objects) - Optional - Rules for applying the promotion.
### Request Example
```json
{
"name": "Hiking shoes summer promotion",
"type": "EXTERNAL",
"schedule": {
"start": "2018-07-01T00:00:00Z",
"end": "2018-08-31T23:59:59Z"
},
"order": {
"type": "ORIGINAL"
},
"configuration": {
"collectionId": 3432
},
"rules": [
{
"attribute": "category",
"operation": "endsWith",
"values": [
"Hiking Shoes"
]
}
]
}
```
### Response
#### Success Response (201)
- **id** (integer) - The unique identifier of the created promotion.
- **name** (string) - The name of the promotion.
- **type** (string) - The type of the promotion.
- **schedule** (object) - The schedule for the promotion.
- **order** (object) - The order configuration for the promotion.
- **configuration** (object) - The configuration for the promotion.
- **rules** (array of objects) - The rules applied to the promotion.
#### Response Example
```json
{
"id": 428,
"name": "Backpacking Tents",
"description": "Exclude backpacking tents with less than 10 items remaining in the inventory",
"lastModifiersEmail": "buzz@spacemail.com",
"lastModifiersName": "Buzz Lightyear",
"lastModified": "2018-08-07T16:34:01.000Z",
"rule": {
"name": {
"contains": "backpacking"
}
}
}
```
```
--------------------------------
### Get Recent Criteria Response (JSON)
Source: https://developer.adobe.com/target/administer/recommendations-api
Example JSON response for retrieving a recent view based criteria. It details the criteria's ID, name, purchase exclusion, inventory minimum, and complex configuration settings.
```json
{
"id": 2,
"name": "Recently Viewed in Same Brand",
"criteriaGroup": "RECENT",
"excludePurchases": true,
"minInventory": 1,
"configuration": {
"inclusionRules": [
{
"attribute": "brand",
"operation": "dynamicallyMatches",
"source": {
"name": "brand",
"type": "ENTITY",
"excludeAllWhenEmpty": true
}
},
{
"attribute": "value",
"operation": "dynamicallyRanges",
"lowRange": "1",
"highRange": "99"
}
],
"rankingRules": [ ]
}
}
```
--------------------------------
### Get Promotion Response Sample - JSON
Source: https://developer.adobe.com/target/administer/recommendations-api
This is a sample JSON response when retrieving a promotion object. It includes details like ID, name, type, schedule, order, configuration, and rules.
```json
{
"id": 1,
"name": "Hiking shoes summer promotion",
"type": "EXTERNAL",
"schedule": {
"start": "2018-07-01T00:00:00Z",
"end": "2018-08-31T23:59:59Z"
},
"order": {
"type": "ORIGINAL"
},
"configuration": {
"collectionId": 3432
},
"rules": [
{
"attribute": "category",
"operation": "endsWith",
"values": [
"Hiking Shoes"
]
}
]
}
```
--------------------------------
### GET /criteria/item
Source: https://developer.adobe.com/target/administer/recommendations-api
Gets all available item based criteria.
```APIDOC
## GET /criteria/item
### Description
Gets all available item based criteria.
### Method
GET
### Endpoint
`/criteria/item`
### Parameters
#### Query Parameters
- **offset** (integer) - Optional - Number of resources to skip from start in the server list. If not specified, the response list will start from the first available resource.
- **limit** (integer) - Optional - Number of resources to request. If not specified, the response will include all available resources.
### Response
#### Success Response (200)
- Returns a list of item criteria resources.
#### Response Example
(Response example not provided in the source text)
```
--------------------------------
### GET /designs/{id}
Source: https://developer.adobe.com/target/administer/recommendations-api
Gets the design with the given ID. Requires BearerToken or ApiKey authorization.
```APIDOC
## GET /designs/{id}
### Description
Gets the design with the given ID.
### Method
GET
### Endpoint
https://mc.adobe.io/{tenantId}/target/recs/designs/{id}
### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the design.
#### Query Parameters
- **includeScript** (boolean) - Optional - Whether to include the design content in the response.
### Response
#### Success Response (200)
- **offset** (integer) - The starting offset of the design list.
- **limit** (integer) - The maximum number of designs to return.
- **total** (integer) - The total number of designs available.
- **list** (array) - A list of design objects.
- **id** (integer) - The unique identifier of the design.
- **name** (string) - The name of the design.
- **script** (string) - The Velocity template script for the design (only if `includeScript` is true).
- **type** (string) - The content type of the design script.
- **lastModifiersEmail** (string) - The email of the last user who modified the design.
- **lastModifiersName** (string) - The name of the last user who modified the design.
- **lastModified** (string) - The timestamp when the design was last modified.
#### Response Example
```json
{
"offset": 0,
"limit": 2147483647,
"total": 2,
"list": [
{
"id": 4,
"name": "Landing Page",
"script": "
",
"type": "HTML",
"lastModifiersEmail": "jneutron@boygenius.com",
"lastModifiersName": "Jimmy Neutron",
"lastModified": "2023-12-25T17:34:01.000Z"
},
{
"id": 5,
"name": "Prime Product Box",
"script": "$entity1.name
",
"type": "HTML",
"lastModifiersEmail": "stentacles@krustykrab.com",
"lastModifiersName": "Squidward Tentacles",
"lastModified": "2022-08-07T16:34:01.000Z"
}
]
}
```
```
--------------------------------
### Adobe Target Delivery API Request Payload Example
Source: https://developer.adobe.com/target/implement/delivery-api
This JSON payload demonstrates a typical request to the Adobe Target Delivery API for retrieving offers. It includes visitor identification, context, and specifies actions for page load and mbox prefetching. Ensure all required fields are populated according to the API schema.
```json
{
"id": {
"tntId": "c43f3c07ad2346e3b48c8144ba2fc5c8"
},
"context": {
"channel": "web",
"address": {
"url": "https://example.com/store.html"
},
"screen": {
"width": 1200,
"height": 1400
}
},
"experienceCloud": {
"analytics": {
"logging": "server_side",
"supplementalDataId": "1122334455667788-1122334455667788",
"trackingServer": "sstats.adobe.com"
}
},
"execute": {
"pageLoad": {
"parameters": {
"pageType": "checkout",
"preferredCurrency": "$"
}
},
"mboxes": [
{
"index": 1,
"name": "orderConfirmPage"
}
]
},
"prefetch": {
"views": [
{
"parameters": {
"ad": "view"
}
}
],
"mboxes": {
"index": 1,
"name": "SummerOffer"
}
}
}
```
--------------------------------
### GET /hosts
Source: https://developer.adobe.com/target/administer/admin-api
Retrieve a list of all hosts. This endpoint allows you to get a collection of hosts associated with your Adobe Target account.
```APIDOC
## List hosts
### Description
Retrieve a list of all hosts.
### Method
GET
### Endpoint
`get/{tenant}/target/hosts`
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
### Request Example
```
GET https://mc.adobe.io/{tenant}/target/hosts
```
### Response
#### Success Response (200)
- **total** (integer) - The total number of hosts.
- **hosts** (array) - A list of host objects.
- **name** (string) - The name of the host.
- **lastRequested** (string) - The timestamp of the last request for this host.
- **environmentId** (integer) - The environment ID associated with the host.
#### Response Example
```json
{
"total": 0,
"hosts": [
{
"name": "string",
"lastRequested": "2019-08-24T14:15:22Z",
"environmentId": 0
}
]
}
```
```
--------------------------------
### Adobe Target List Promotions Response Sample
Source: https://developer.adobe.com/target/administer/recommendations-api
This JSON object showcases a sample response when listing promotions from the Adobe Target API. It includes pagination details (offset, limit, total) and a list of promotion objects, each with its own ID, name, type, schedule, order, configuration, and rules. This is useful for understanding how promotion data is structured.
```json
{
"offset": 0,
"limit": 2147483647,
"total": 2,
"list": [
{
"id": 1,
"name": "Hiking shoes summer promotion",
"type": "EXTERNAL",
"schedule": {
"start": "2018-07-01T00:00:00Z",
"end": "2018-08-31T23:59:59Z"
},
"order": {
"type": "ORIGINAL"
},
"configuration": {
"collectionId": 3432
},
"rules": [
{
"attribute": "category",
"operation": "endsWith",
"values": [
"Hiking Shoes"
]
}
]
},
{
"id": 2,
"name": "Shoes clearance sale",
"type": "EXTERNAL",
"order": {
"type": "ORIGINAL"
},
"rules": [
{
"attribute": "value",
"operation": "lesserOrEquals",
"values": [
"200"
]
}
]
}
]
}
```
--------------------------------
### Response Sample for AB Activity Preview Link
Source: https://developer.adobe.com/target/administer/admin-api
This is a success response payload sample for creating a preview link for an AB activity. It returns a list of QA mode experiences with their associated URLs and local experience IDs.
```json
{
"qaModeExperiences": [
{
"url": "string",
"experienceLocalId": 0,
"locationOptions": [
{
"locationLocalId": 0,
"optionLocalId": 0
}
]
}
]
}
```
--------------------------------
### List Offers API
Source: https://developer.adobe.com/target/administer/admin-api
Retrieves a list of previously-created content, JSON, or Recommendations offers. Query parameters can be used for optional sorting and filtering.
```APIDOC
## List offers
### Description
Retrieve the list of previously-created content/JSON/Recommendations offers. The parameters passed through the query string are optional and are used to indicate the sorting and filtering options.
### Method
GET
### Endpoint
`/{tenant}/target/offers`
### Parameters
#### Query Parameters
(Specific query parameters for sorting and filtering are not detailed in the provided text, but would typically be listed here.)
### Response
#### Success Response (200)
- **offers** (array) - A list of offer objects.
#### Response Example
(Response structure for listing offers is not detailed in the provided text.)
```
--------------------------------
### Create Cart Criteria Request Payload Example
Source: https://developer.adobe.com/target/administer/recommendations-api
Example JSON payload for creating or updating a cart-based criteria in Adobe Target. This includes settings for recommendation logic, such as historical data range, purchase exclusions, and inclusion rules.
```json
{
"name": "Users who viewed this also bought that across user sessions in the same category.",
"criteriaGroup": "CART",
"daysCount": "TWO_WEEKS",
"partialDesignAllowed": true,
"backupDisabled": false,
"excludePurchases": true,
"backupInclusionFilteringEnabled": true,
"modelActionSettings": {
"actionOnKeyItems": "VIEW",
"actionOnRecommendedItems": "PURCHASE",
"basisForCoOccurrence": "USER"
},
"configuration": {
"inclusionRulesKey": "LAST_PURCHASED",
"inclusionRules": [
{
"attribute": "category",
"operation": "equals",
"source": {
"name": "category",
"type": "ENTITY",
"excludeAllWhenEmpty": true
}
}
]
}
}
```
--------------------------------
### List Offer Templates (JSON Response Sample)
Source: https://developer.adobe.com/target/administer/admin-api
This snippet illustrates a sample JSON response for listing offer templates. It contains the total number of templates and an array of templates, each with an ID and parameters.
```json
{
"total": 0,
"templates": [
{
"offerTemplateId": 0,
"templateParameters": [
{
"name": "string",
"value": "string"
}
]
}
]
}
```
--------------------------------
### POST /collections
Source: https://developer.adobe.com/target/administer/recommendations-api
Creates a new Adobe Target collection with the specified name, description, and rules. Returns the created collection resource upon success.
```APIDOC
## POST /collections
### Description
Creates a new Adobe Target collection with the specified name, description, and rules. Returns the created collection resource upon success.
### Method
POST
### Endpoint
`https://mc.adobe.io/{tenantId}/target/recs/collections`
### Parameters
#### Request Body
- **name** (string) - Required - Unique name of the collection. Max 250 characters.
- **description** (string) - Optional - Description of the collection. Max 1000 characters.
- **rules** (array of objects) - Required - Array of rules containing attribute: operation pairs. Max 1000 items.
- **attribute** (string) - Required - Any valid entity attribute. Max 100 characters.
- **operation** (object) - Required - A pair of operator and operand values.
- **operator** (string) - Required - One of: `greaterOrEquals`, `lesserOrEquals`, `startsWith`, `endsWith`, `contains`, `doesNotContain`, `equals`, `notEquals`, `valueIsPresent`, `valueIsNotPresent`.
- **operandValues** (array of strings) - Optional (if operator is `valueIsPresent` or `valueIsNotPresent`) - Array of operand values. Max 1000 values, each max 250 characters.
### Request Example
```json
{
"name": "Backpacking Tents",
"description": "Lightweight tents suitable for backpacking.",
"rules": [
{
"bestUse": {
"equals": [
"backpacking"
]
}
},
{
"weight": {
"lesserOrEquals": [
"10"
]
}
},
{
"capacity": {
"lesserOrEquals": [
"4"
]
}
}
]
}
```
### Response
#### Success Response (201)
- **id** (integer) - Unique identifier for the collection.
- **name** (string) - Name of the collection.
- **description** (string) - Description of the collection.
- **lastModified** (string) - Timestamp of the last modification.
- **lastModifiersName** (string) - Name of the last modifier.
- **lastModifierEmail** (string) - Email of the last modifier.
- **rules** (array of objects) - Array of rules associated with the collection.
#### Response Example
```json
{
"id": 1,
"name": "Backpacking Tents",
"description": "Lightweight tents suitable for backpacking.",
"lastModified": "2018-08-07T16:34:01.000Z",
"lastModifiersName": "Buzz Lightyear",
"lastModifierEmail": "buzz@spacemail.com",
"rules": [
{
"bestUse": {
"equals": [
"backpacking"
]
}
},
{
"weight": {
"lesserOrEquals": [
"10"
]
}
},
{
"capacity": {
"lesserOrEquals": [
"4"
]
}
}
]
}
```
```
--------------------------------
### Get Activity Blocked Features
Source: https://developer.adobe.com/target/administer/models-api
Retrieves the blocklist of features for an activity.
```APIDOC
## GET /target/models/features/{tenant}/{activityId}
### Description
Retrieves the blocked features for a specific activity.
### Method
GET
### Endpoint
/target/models/features/{tenant}/{activityId}
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **activityId** (integer) - Required - The ID of the activity.
### Request Example
```json
{
"example": "Not applicable for GET request"
}
```
### Response
#### Success Response (200)
- **features** (array of objects) - A list of features.
- **externalName** (string) - The external name of the feature.
- **internalName** (string) - The internal name of the feature.
- **type** (string) - The type of the feature.
#### Response Example
```json
{
"features": [
{
"externalName": "string",
"internalName": "string",
"type": "string"
}
]
}
```
```
--------------------------------
### POST /target/activities/ab/{id}/qamode
Source: https://developer.adobe.com/target/administer/admin-api
Get a set of preview links for the AB activity referenced by the provided ID. This endpoint allows specifying the URL, whether to consider only the current activity, and audience IDs for true/false evaluation.
```APIDOC
## POST /target/activities/ab/{id}/qamode
### Description
Get a set of preview links for the AB activity referenced by the provided ID. The **url** parameter indicates the URL on which the activity will be running. The **currentActivityOnly** (defaults to true) indicates whether other activities running on the same URL should be ignored. The payload of the request also allows you to specify which segment ids should be evaluated to true by including these in the **audienceIdsEvaluatedAsTrue** list, so that the user doesn't necessarily have to qualify for these. At the same time you can specify which segments should always evaluate to false by including these in the **audienceIdsEvaluatedAsFalse** list.
### Method
POST
### Endpoint
`https://mc.adobe.io/{tenant}/target/activities/ab/{id}/qamode`
### Parameters
#### Path Parameters
- **id** (integer ) - Required - The ID of the AB activity.
#### Request Body
- **url** (string) - Required - The URL on which the activity will be running.
- **currentActivityOnly** (boolean) - Optional - Defaults to true. Indicates whether other activities running on the same URL should be ignored.
- **audienceIdsEvaluatedAsTrue** (Array of integers ) - Optional - List of segment IDs to be evaluated as true.
- **audienceIdsEvaluatedAsFalse** (Array of integers ) - Optional - List of segment IDs to be evaluated as false.
### Request Example
```json
{
"url": "string",
"currentActivityOnly": true,
"audienceIdsEvaluatedAsTrue": [
0
],
"audienceIdsEvaluatedAsFalse": [
0
]
}
```
### Response
#### Success Response (200)
- **qaModeExperiences** (Array) - A list of QA mode experiences.
- **url** (string) - The URL of the experience.
- **experienceLocalId** (integer) - The local ID of the experience.
- **locationOptions** (Array) - A list of location options for the experience.
- **locationLocalId** (integer) - The local ID of the location.
- **optionLocalId** (integer) - The local ID of the option.
#### Response Example
```json
{
"qaModeExperiences": [
{
"url": "string",
"experienceLocalId": 0,
"locationOptions": [
{
"locationLocalId": 0,
"optionLocalId": 0
}
]
}
]
}
```
```
--------------------------------
### POST /target/activities/xt/{id}/qamode
Source: https://developer.adobe.com/target/administer/admin-api
Get a set of preview links for the XT activity referenced by the provided ID. This endpoint allows specifying the URL, whether to consider only the current activity, and audience IDs for true/false evaluation.
```APIDOC
## POST /target/activities/xt/{id}/qamode
### Description
Get a set of preview links for the XT activity referenced by the provided ID. The **url** parameter indicates the URL on which the activity will be running. The **currentActivityOnly** (defaults to true) indicates whether other activities running on the same URL should be ignored. The payload of the request also allows you to specify which segment ids should be evaluated to true by including these in the **audienceIdsEvaluatedAsTrue** list, so that the user doesn't necessarily have to qualify for these. At the same time you can specify which segments should always evaluate to false by including these in the **audienceIdsEvaluatedAsFalse** list.
### Method
POST
### Endpoint
`https://mc.adobe.io/{tenant}/target/activities/xt/{id}/qamode`
### Parameters
#### Path Parameters
- **id** (integer ) - Required - The ID of the XT activity.
#### Request Body
- **url** (string) - Required - The URL on which the activity will be running.
- **currentActivityOnly** (boolean) - Optional - Defaults to true. Indicates whether other activities running on the same URL should be ignored.
- **audienceIdsEvaluatedAsTrue** (Array of integers ) - Optional - List of segment IDs to be evaluated as true.
- **audienceIdsEvaluatedAsFalse** (Array of integers ) - Optional - List of segment IDs to be evaluated as false.
### Request Example
```json
{
"url": "string",
"currentActivityOnly": true,
"audienceIdsEvaluatedAsTrue": [
0
],
"audienceIdsEvaluatedAsFalse": [
0
]
}
```
### Response
#### Success Response (200)
- **qaModeExperiences** (Array) - A list of QA mode experiences.
- **url** (string) - The URL of the experience.
- **experienceLocalId** (integer) - The local ID of the experience.
#### Response Example
```json
{
"qaModeExperiences": [
{
"url": "string",
"experienceLocalId": 0
}
]
}
```
```
--------------------------------
### Get Client Blocked Features
Source: https://developer.adobe.com/target/administer/models-api
Retrieves the blocklist of features for a client.
```APIDOC
## GET /target/models/features/blockList/global/{tenant}
### Description
Retrieves the global blocklist of features for a client.
### Method
GET
### Endpoint
/target/models/features/blockList/global/{tenant}
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
### Request Example
```json
{
"example": "Not applicable for GET request"
}
```
### Response
#### Success Response (200)
- **blockedFeatures** (array of strings) - A list of blocked feature names.
- **blockedFeatureSources** (array of strings) - A list of sources for the blocked features.
#### Response Example
```json
{
"blockedFeatures": [
"string"
],
"blockedFeatureSources": [
"string"
]
}
```
```
--------------------------------
### Response Samples for Adobe Target API
Source: https://developer.adobe.com/target/implement/delivery-api
This section details the structure of successful responses from the Adobe Target API, including prefetch mbox data.
```APIDOC
## Response Samples for Adobe Target API
### Description
This endpoint provides response samples for the Adobe Target API, detailing the structure of successful (200) and default responses.
### Method
GET (Assumed, as response samples are provided without a specific method)
### Endpoint
/websites/developer_adobe_target (Assumed based on project path)
### Parameters
None explicitly defined in the provided text.
### Request Example
None provided.
### Response
#### Success Response (200)
- **status** (integer) - The status code of the response.
- **requestId** (string) - A unique identifier for the request.
- **client** (string) - The client identifier.
- **id** (object) - An object containing identifiers.
- **tntId** (string) - The TNT ID.
- **edgeHost** (string) - The edge host used for the request.
- **prefetch** (object) - Contains prefetch data.
- **mboxes** (array) - An array of mbox objects.
- **index** (integer) - The index of the mbox.
- **name** (string) - The name of the mbox.
- **options** (object) - Options associated with the mbox.
- **content** (string) - The content of the mbox option (e.g., HTML).
- **type** (string) - The type of content.
- **eventToken** (string) - An event token for tracking.
#### Response Example
```json
{
"status": 200,
"requestId": "5efee0d8-3779-4b12-a74e-e04848faf191",
"client": "demo",
"id": {
"tntId": "c43f3c07ad2346e3b48c8144ba2fc5c8"
},
"edgeHost": "mboxedge34.tt.omtrdc.net",
"prefetch": {
"mboxes": [
{
"index": 1,
"name": "SummerOffer",
"options": {
"content": "Enjoy this 15% discount on your next purchase
",
"type": "html",
"eventToken": "GcvBXDhdJFNR9E9r1tgjfmqipf"
}
}
]
}
}
```
```
--------------------------------
### Adobe Target API: Delete Category Criteria Request Example
Source: https://developer.adobe.com/target/administer/recommendations-api
This example demonstrates how to delete a category-based criteria using its ID. The API endpoint structure is shown, along with the necessary path parameters. Successful deletion returns a 200 status code with the deleted criteria resource.
```http
DELETE /target/recs/criteria/category/{id} HTTP/1.1
Host: mc.adobe.io/{tenantId}
Authorization: Bearer
# Path Parameters:
id: integer (required)
```
--------------------------------
### GET /clients/settings
Source: https://developer.adobe.com/target/administer/admin-api
Retrieves the client settings for a given tenant.
```APIDOC
## GET /clients/settings
### Description
Retrieves the client settings for a given tenant.
### Method
GET
### Endpoint
`https://mc.adobe.io/{tenant}/target/clients/settings`
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant ID.
### Response
#### Success Response (200)
- **enableProfileApiAuthentication** (boolean) - Whether profile API authentication is enabled.
- **locale** (string) - The locale setting.
- **timeZone** (string) - The time zone setting.
- **ipObfuscation** (string) - The IP obfuscation setting (e.g., "NONE").
- **onDeviceDecisioning** (boolean) - Whether on-device decisioning is enabled.
- **onDeviceDecisioningActivityQualification** (boolean) - Whether on-device decisioning activity qualification is enabled.
- **a4TEnabled** (boolean) - Whether A4T is enabled.
- **permissionEnabled** (boolean) - Whether permissions are enabled.
- **mobileDeviceTargetingEnabled** (boolean) - Whether mobile device targeting is enabled.
- **geoLocationEnabled** (boolean) - Whether geolocation is enabled.
- **defaultCompanyName** (string) - The default company name.
- **defaultReportSuite** (string) - The default report suite.
- **defaultDataCollectionHost** (string) - The default data collection host.
#### Response Example
```json
{
"enableProfileApiAuthentication": true,
"locale": "string",
"timeZone": "string",
"ipObfuscation": "NONE",
"onDeviceDecisioning": true,
"onDeviceDecisioningActivityQualification": true,
"a4TEnabled": true,
"permissionEnabled": true,
"mobileDeviceTargetingEnabled": true,
"geoLocationEnabled": true,
"defaultCompanyName": "string",
"defaultReportSuite": "string",
"defaultDataCollectionHost": "string"
}
```
```
--------------------------------
### POST /target/activities/autoallocate/{id}/qamode
Source: https://developer.adobe.com/target/administer/admin-api
Generates preview links for an Auto-Allocate activity. Allows specifying custom audience evaluations for testing purposes.
```APIDOC
## POST /target/activities/autoallocate/{id}/qamode
### Description
Creates preview links for an Auto-Allocate activity. You can specify the URL where the activity will run, whether to consider only the current activity, and define specific audiences that should evaluate as true or false for testing.
### Method
POST
### Endpoint
`https://mc.adobe.io/{tenant}/target/activities/autoallocate/{id}/qamode`
### Path Parameters
- **id** (integer, required) - The unique identifier of the activity.
### Request Body
- **url** (string, required) - The URL on which the activity will be running.
- **currentActivityOnly** (boolean, optional) - Defaults to true. If true, other activities on the same URL are ignored.
- **audienceIdsEvaluatedAsTrue** (array of integers, optional) - A list of audience IDs that should always evaluate to true.
- **audienceIdsEvaluatedAsFalse** (array of integers, optional) - A list of audience IDs that should always evaluate to false.
### Request Example
```json
{
"url": "https://www.example.com",
"currentActivityOnly": true,
"audienceIdsEvaluatedAsTrue": [101, 102],
"audienceIdsEvaluatedAsFalse": [201, 202]
}
```
### Response
#### Success Response (200)
OK. The response will contain preview links.
#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **404** Not Found
- **406** Not Acceptable
- **407** Proxy Authentication Required
```
--------------------------------
### GET /environments
Source: https://developer.adobe.com/target/administer/admin-api
Retrieves a list of all environments for a given tenant.
```APIDOC
## GET /environments
### Description
Retrieves a list of all environments for a given tenant.
### Method
GET
### Endpoint
`https://mc.adobe.io/{tenant}/target/environments`
### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant ID.
### Response
#### Success Response (200)
- **total** (integer) - The total number of environments.
- **environments** (array) - A list of environment objects.
- **id** (integer) - The environment ID.
- **name** (string) - The environment name.
- **serveInactiveActivities** (boolean) - Whether to serve inactive activities.
- **lastModified** (string) - The last modified date and time.
- **default** (boolean) - Whether this is the default environment.
#### Response Example
```json
{
"total": 0,
"environments": [
{
"id": 0,
"name": "string",
"serveInactiveActivities": true,
"lastModified": "2019-08-24T14:15:22Z",
"default": true
}
]
}
```
```
--------------------------------
### Get Offers (JSON Response Sample)
Source: https://developer.adobe.com/target/administer/admin-api
This snippet shows a sample JSON response for retrieving offers. It includes total count and a list of offers with their details like ID, name, type, modification date, and workspace.
```json
{
"total": 0,
"offers": [
{
"id": 0,
"name": "string",
"type": "content",
"modifiedAt": "2019-08-24T14:15:22Z",
"workspace": "string"
}
]
}
```