### Get Target SDK On-Device Decisioning Rules Bundle (String Example) Source: https://developer.adobe.com/target/administer/admin-api This is a placeholder example for the response when retrieving the private rules bundle for Target SDK on-device decisioning. The actual content is a string representing the bundle. ```string "string" ``` -------------------------------- ### Get Mbox Parameters (JSON Example) Source: https://developer.adobe.com/target/administer/admin-api This JSON response example displays the details of mbox parameters for a given mbox name. It includes the local ID, name, and associated audience IDs. ```json { "locationLocalId": 0, "name": "string", "audienceIds": [ 0 ] } ``` -------------------------------- ### Get Promotion Example (JSON) Source: https://developer.adobe.com/target/administer/recommendations-api This snippet shows a sample JSON response when retrieving a promotion. It includes details like promotion ID, name, type, schedule, order, configuration, and associated 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 /target/clients/settings Source: https://developer.adobe.com/target/administer/admin-api Retrieves the client settings for a given tenant. ```APIDOC ## GET /target/clients/settings ### Description Retrieves client settings. ### 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" } ``` ``` -------------------------------- ### List Profile Attributes and Mbox Parameters (JSON Example) Source: https://developer.adobe.com/target/administer/admin-api This JSON response example illustrates the structure for listing available profile attributes and mbox parameters of type profile. The response contains a single key, 'mboxProfileAttributes', which is an array of strings. ```json { "mboxProfileAttributes": [ "string" ] } ``` -------------------------------- ### GET /target/clients/uisettings Source: https://developer.adobe.com/target/administer/admin-api Retrieves the client UI settings for a given tenant. ```APIDOC ## GET /target/clients/uisettings ### Description Retrieves client UI settings. ### Method GET ### Endpoint https://mc.adobe.io/{tenant}/target/clients/uisettings ### Parameters #### Path Parameters - **tenant** (string) - Required - The tenant ID. ### Response #### Success Response (200) - **defaultSimulatorUrl** (string) - The default simulator URL. - **enableExperienceThumbs** (boolean) - Whether to enable experience thumbnails. - **enableProxyInEe** (boolean) - Whether to enable proxy in EE. - **loadMixedContent** (boolean) - Whether to load mixed content. - **useElementIds** (boolean) - Whether to use element IDs. - **useClassIds** (boolean) - Whether to use class IDs. - **enableFineGrainedPriorities** (boolean) - Whether to enable fine-grained priorities. - **enableProjectedEarnings** (boolean) - Whether to enable projected earnings. - **reportingCloudSolution** (string) - The reporting cloud solution. #### Response Example ```json { "defaultSimulatorUrl": "string", "enableExperienceThumbs": true, "enableProxyInEe": true, "loadMixedContent": true, "useElementIds": true, "useClassIds": true, "enableFineGrainedPriorities": true, "enableProjectedEarnings": true, "reportingCloudSolution": "target" } ``` ``` -------------------------------- ### GET /target/environments Source: https://developer.adobe.com/target/administer/admin-api Retrieves a list of all environments for a given tenant. ```APIDOC ## GET /target/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 date and time the environment was last modified. - **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 } ] } ``` ``` -------------------------------- ### List Available Mboxes (JSON Example) Source: https://developer.adobe.com/target/administer/admin-api This JSON response sample shows the structure for listing all available mboxes for a specific client. It includes the total count of mboxes and an array of mbox objects, each with a name, status, and last requested timestamp. ```json { "total": 0, "mboxes": [ { "name": "string", "status": "string", "lastRequestedAt": "2019-08-24T14:15:22Z" } ] } ``` -------------------------------- ### Get Criteria by ID - Request Example Source: https://developer.adobe.com/target/administer/recommendations-api This is an example of a successful response (HTTP 200) when retrieving criteria information using its ID. It provides minimal details about the criteria, including its ID, name, criteria title, and group. This is useful for quick lookups without fetching the full configuration. ```json { "id": 34, "name": "Recently Viewed Biking Accessories", "criteriaTitle": "Recently Viewed Biking Accessories", "criteriaGroup": "RECENT" } ``` -------------------------------- ### at.js Settings Response Sample (JSON) Source: https://developer.adobe.com/target/administer/admin-api A sample JSON response detailing the configuration settings for at.js. This includes client code, IMS organization ID, decisioning method, caching parameters, and other library-specific configurations. ```json { "clientCode": "string", "imsOrgId": "string", "decisioningMethod": "string", "artifactCacheTtl": 0, "profileLifetime": 0, "serverDomain": "string", "libraryHeader": "string", "libraryFooter": "string", "crossDomain": "string", "globalMboxName": "string", "globalMboxAutoCreate": true, "legacyBrowserSupport": true, "timeout": 0 } ``` -------------------------------- ### Get Revision by Revision ID (JSON Example) Source: https://developer.adobe.com/target/administer/admin-api This snippet shows the JSON response structure for retrieving a specific revision by its entity ID and revision ID. It includes summary information about the revision's operation, modification details, and the JSON data itself. ```json { "summary": { "id": 0, "operation": "create", "modifiedBy": "string", "modifiedByName": "string", "modifiedAt": "2019-08-24T14:15:22Z" }, "jsonData": "string" } ``` -------------------------------- ### POST /target/environments Source: https://developer.adobe.com/target/administer/admin-api Creates a new environment for a given tenant. ```APIDOC ## POST /target/environments ### Description Creates a new environment for a given tenant. ### Method POST ### Endpoint https://mc.adobe.io/{tenant}/target/environments ### Parameters #### Path Parameters - **tenant** (string) - Required - The tenant ID. #### Request Body - **id** (integer) - Required - The environment ID. - **name** (string) - Required - The environment name. - **serveInactiveActivities** (boolean) - Required - Whether to serve inactive activities. - **lastModified** (string) - Required - The date and time the environment was last modified. - **default** (boolean) - Required - Whether this is the default environment. ### Request Example ```json { "id": 0, "name": "string", "serveInactiveActivities": true, "lastModified": "2019-08-24T14:15:22Z", "default": true } ``` ### Response #### Success Response (201) - **id** (integer) - The environment ID. - **name** (string) - The environment name. - **serveInactiveActivities** (boolean) - Whether to serve inactive activities. - **lastModified** (string) - The date and time the environment was last modified. - **default** (boolean) - Whether this is the default environment. #### Response Example ```json { "id": 0, "name": "string", "serveInactiveActivities": true, "lastModified": "2019-08-24T14:15:22Z", "default": true } ``` ``` -------------------------------- ### List Custom Criteria API Endpoint (Curl) Source: https://developer.adobe.com/target/administer/recommendations-api Example of how to retrieve a list of all available custom criteria using a GET request. This operation requires BearerToken and ApiKey authorization and supports offset and limit query parameters. ```curl curl -X GET https://mc.adobe.io/{tenantId}/target/recs/criteria/custom?offset=0&limit=10 \ -H "Authorization: Bearer YOUR_BEARER_TOKEN" \ -H "x-api-key: YOUR_API_KEY" ``` -------------------------------- ### GET /criteria/recent Source: https://developer.adobe.com/target/administer/recommendations-api Gets all available recent view based criteria. ```APIDOC ## GET /criteria/recent ### Description Gets all available recent view based criteria. ### Method GET ### Endpoint /criteria/recent ### 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 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) - **offset** (integer) - The offset of the results. - **limit** (integer) - The limit of the results. - **total** (integer) - The total number of criteria available. - **list** (array) - A list of recent criteria resources. - **id** (integer) - The unique identifier of the criteria. - **name** (string) - The name of the criteria. - **criteriaTitle** (string) - A user-friendly title for the criteria. - **criteriaGroup** (string) - The group the criteria belongs to (e.g., RECENT). - **minInventory** (integer) - Minimum inventory count. - **configuration** (object) - The configuration details. - **rankingRules** (array) - Rules for ranking. - **inclusionRules** (array) - Rules for inclusion. - **attribute** (string) - The attribute for the rule. - **operation** (string) - The operation to perform. - **source** (object) - The source of the attribute. - **name** (string) - The name of the source. - **type** (string) - The type of the source (e.g., ENTITY). - **excludeAllWhenEmpty** (boolean) - Whether to exclude all when empty. - **lowRange** (string) - The lower bound of the range. - **highRange** (string) - The upper bound of the range. #### Response Example ```json { "offset": 0, "limit": 2147483647, "total": 2, "list": [ { "id": 1, "name": "Recently Viewed Products", "criteriaTitle": "Just Seen Items", "criteriaGroup": "RECENT", "minInventory": 1, "configuration": { "rankingRules": [] } }, { "id": 2, "name": "Recently Viewed in Same Brand", "criteriaGroup": "RECENT", "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 /criteria/profileattribute/{id} Source: https://developer.adobe.com/target/administer/recommendations-api Gets the profile attribute based criteria with the given ID. ```APIDOC ## Get profile attribute criteria ### Description Gets the profile attribute based criteria with the given ID. ### Method GET ### Endpoint /criteria/profileattribute/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the profile attribute criteria to retrieve. ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the criteria. - **name** (string) - Name of the criteria. - **criteriaTitle** (string) - Displayed title of the criteria. - **criteriaGroup** (string) - Type of the criteria group. - **type** (string) - Recommendation logic type. - **aggregation** (string) - Aggregation method. - **daysCount** (string) - Time range for historical data. - **minInventory** (integer) - Minimum inventory count. - **partialDesignAllowed** (boolean) - Whether partial design is allowed. - **backupDisabled** (boolean) - Whether backup is disabled. - **excludePurchases** (boolean) - Whether purchases are excluded. - **configuration** (object) - Configuration details for the criteria. #### Response Example ```json { "id": 1, "name": "city-bike-recs", "criteriaTitle": "Bike recommendations per city", "criteriaGroup": "PROFILEATTRIBUTE", "type": "VIEWED_CF", "aggregation": "NONE", "daysCount": "ONE_MONTH", "minInventory": 5, "partialDesignAllowed": true, "backupDisabled": false, "excludePurchases": true, "configuration": { "attribute": "profile.city", "inclusionRules": [ { "attribute": "city", "operation": "dynamicallyMatches" }, { "attribute": "category", "operation": "contains", "values": [ "bike" ] } ], "datasource": "mboxes" } } ``` ``` -------------------------------- ### Get Content Offer by ID (GET) Source: https://developer.adobe.com/target/administer/admin-api Retrieves the content of a content offer using its ID. This operation requires the offer ID in the URL. ```http GET /{tenant}/target/offers/content/{id} HTTP/1.1 Host: mc.adobe.io Authorization: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Response Samples Source: https://developer.adobe.com/target/administer/admin-api Example response for a successful operation, likely related to fetching activity details. ```APIDOC ## Response Sample (200 OK) ### Description This is a sample JSON response representing an Adobe Target activity. ### Content Type `application/vnd.adobe.target.v3+json` ### Response Body Example ```json { "id": 0, "thirdPartyId": "string", "name": "string", "startsAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "state": "approved", "priority": 0, "entryConstraint": { "mboxes": [ { "name": "string", "audienceIds": [ 0 ] } ], "visitorPercentage": 0 }, "applicationContext": { "channel": "web", "applicationVersions": [ "string" ], "mobilePlatformVersions": [ "string" ], "deviceType": "phone", "screenOrientation": "landscape" }, "options": [ { "optionLocalId": 0, "name": "string", "offerId": 0, "offerTemplates": [ { "offerTemplateId": 0, "templateParameters": [ { "name": "string", "value": "string" } ] } ] } ], "locations": { "mboxes": [ { "locationLocalId": 0, "name": "string", "audienceIds": [ 0 ] } ], "selectors": [ { "locationLocalId": 0, "name": "string", "selector": "string", "audienceIds": [ 0 ], "selectorVersion": 0, "viewLocalId": 0 } ] }, "views": [ { "viewLocalId": 0, "viewId": 0, "audienceIds": [ 0 ] } ], "experiences": [ { "experienceLocalId": 0, "name": "string", "audienceIds": [ 0 ], "visitorPercentage": 0, "optionLocations": [ { "locationLocalId": 0, "optionLocalId": 0 } ] } ], "metrics": [ { "metricLocalId": 0, "name": "string", "conversion": true, "engagement": "page_count", "action": { "type": "count_once", "conditions": { "maxVisitCount": 0, "maxImpressionCount": 0, "experiences": [ { "experienceLocalId": 0, "maxVisitCount": 0, "maxImpressionCount": 0 } ] }, "onConditionsMetAction": "count_once" }, "mboxes": [ { "name": "string", "successEvent": "mbox_clicked", "audienceIds": [ 0 ] } ], "clickTrackSelectors": [ { "selector": "string", "audienceIds": [ 0 ], "selectorVersion": 0, "viewLocalId": 0 } ], "views": [ { "viewLocalId": 0, "audienceIds": [ 0 ] } ], "analytics": { "dataCollectionHost": "string", "reportSuites": [ { "companyName": "string", "reportSuites": [ "string" ] } ] } } ], "reportingAudiences": [ { "reportingAudienceLocalId": 0, "audienceId": 0, "metricLocalId": 0 } ], "reportingSource": "target", "analytics": { "dataCollectionHost": "string", "reportSuites": [ { "companyName": "string", "reportSuites": [ "string" ] } ] }, "workspace": "string", "propertyIds": [ 0 ], "modifiedAt": "2019-08-24T14:15:22Z", "modifiedByName": "string", "platform": { "sandbox": { "name": "string" } } } ``` ``` -------------------------------- ### GET /criteria/popularity Source: https://developer.adobe.com/target/administer/recommendations-api Gets all available popularity-based criteria. This endpoint requires BearerToken and ApiKey authorization. ```APIDOC ## GET /criteria/popularity ### Description Gets all available popularity based criteria. ### Method GET ### Endpoint `https://mc.adobe.io/{tenantId}/target/recs/criteria/popularity` ### 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. ### Responses #### Success Response (200) - **offset** (integer) - The offset for the returned list. - **limit** (integer) - The limit for the returned list. - **total** (integer) - The total number of criteria available. - **list** (array) - A list of popularity criteria resources. - **id** (integer) - The ID of the criteria. - **name** (string) - The name of the criteria. - **criteriaGroup** (string) - The group of the criteria (e.g., "POPULARITY"). - **type** (string) - The type of criteria (e.g., "VIEWED", "SELLERS"). - **aggregation** (string) - The aggregation method used. - **daysCount** (string) - The time period for the criteria (e.g., "TWO_DAYS", "ONE_MONTH"). - **minInventory** (integer) - Minimum inventory level. - **partialDesignAllowed** (boolean) - Whether partial design is allowed. - **backupDisabled** (boolean) - Whether backup is disabled. - **excludePurchases** (boolean) - Whether to exclude purchases. - **backupInclusionFilteringEnabled** (boolean) - Whether backup inclusion filtering is enabled. - **configuration** (object) - Configuration details for the criteria. - **datasource** (string) - The data source for the popularity criteria. - **grouping** (object) - Optional grouping configuration. - **type** (string) - The type of grouping (e.g., "SEQUENTIAL"). - **attributes** (array) - List of attributes for grouping. #### Response Example (200) ```json { "offset": 0, "limit": 2147483647, "total": 2, "list": [ { "id": 3422, "name": "Garage Top Viewed", "criteriaGroup": "POPULARITY", "type": "VIEWED", "aggregation": "NONE", "daysCount": "TWO_DAYS", "minInventory": 2, "partialDesignAllowed": true, "backupDisabled": false, "excludePurchases": true, "backupInclusionFilteringEnabled": true, "configuration": { "datasource": "mboxes" } }, { "id": 9321, "name": "Top sold by region", "criteriaGroup": "POPULARITY", "type": "SELLERS", "aggregation": "ALL_OR_NOTHING", "daysCount": "ONE_MONTH", "configuration": { "datasource": "mboxes", "grouping": { "type": "SEQUENTIAL", "attributes": [ "user.city", "user.county", "user.state" ] } } } ] } ``` ``` -------------------------------- ### GET /criteria/item Source: https://developer.adobe.com/target/administer/recommendations-api Gets all available item based criteria. Requires BearerToken and ApiKey authorization. ```APIDOC ## List item criteria 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 first available resource. - **limit** (integer) - Optional - Number of resources to request. If not specified, the response will include all available resources. ### Responses #### Success Response (200) Successful request with list of item criteria resources in response. #### Response Example ```json { "id": 45, "name": "Classes Events", "criteriaTitle": "Classes & Events", "criteriaGroup": "CUSTOM", "key": "PROFILE_ATTRIBUTE", "partialDesignAllowed": true, "backupDisabled": false, "excludePurchases": true, "backupInclusionFilteringEnabled": true, "configuration": { "attribute": "profile.city", "feed": { "environmentId": 2304, "scheduleType": "daily", "scheduleTime": "00:00", "connection": { "type": "ftp", "attributes": { "SERVER": "ftp://ftp.adobe-weretail.com", "DIRECTORY": "/events/e4s", "FILENAME": "classesevents.csv", "USERNAME": "johnmuir", "PASSWORD": "apZMtr+dm2jk5K7INSz5Fg==" } }, "uploadHistory": [ { "status": "SUCCESS", "message": "800/50", "date": "2018-04-21T15:10:44.000-04:00" }, { "status": "UNKNOWN_ERROR", "message": "Connect to 54.22.123.21 timed out", "date": "2018-04-20T15:12:31.000-04:00" } ] } } } ``` ``` -------------------------------- ### POST /activities/autoallocate/{id}/qamode Source: https://developer.adobe.com/target/administer/admin-api Generates preview links for an Auto-Allocate activity. This endpoint allows specifying URLs, audience evaluation, and current activity relevance for preview generation. ```APIDOC ## POST /activities/autoallocate/{id}/qamode ### Description Creates preview links for an Auto-Allocate activity. You can specify the URL, control audience evaluation (true/false), and determine if only the current activity should be considered. ### Method POST ### Endpoint `post/{tenant}/target/activities/autoallocate/{id}/qamode` `https://mc.adobe.io/{tenant}/target/activities/autoallocate/{id}/qamode` ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the activity. #### Request Body - **url** (string) - Required - The URL where the activity will be running. - **currentActivityOnly** (boolean) - Optional - Defaults to true. Indicates whether to ignore other activities running on the same URL. - **audienceIdsEvaluatedAsTrue** (array of integers) - Optional - A list of audience IDs to be evaluated as true. - **audienceIdsEvaluatedAsFalse** (array of integers) - Optional - A list of audience IDs to be evaluated as false. ### Request Example ```json { "url": "https://example.com", "currentActivityOnly": true, "audienceIdsEvaluatedAsTrue": [ 123 ], "audienceIdsEvaluatedAsFalse": [ 456 ] } ``` ### Response #### Success Response (200) - **previewLinks** (array) - A list of preview links. #### Response Example ```json { "previewLinks": [ "https://example.com?adobe_preview_token=..." ] } ``` #### Error Responses - **400** - Bad Request - **401** - Unauthorized - **404** - Not Found - **406** - Not Acceptable - **407** - Proxy Authentication Required ``` -------------------------------- ### POST /activities/ab/{id}/qamode Source: https://developer.adobe.com/target/administer/admin-api Generates preview links for an AB activity in QA mode. Allows specifying URL, activity scope, and audience evaluation. ```APIDOC ## POST /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. If true, ignores other activities running on the same URL. - **audienceIdsEvaluatedAsTrue** (array of integers) - Optional - A list of audience IDs to be evaluated as true. - **audienceIdsEvaluatedAsFalse** (array of integers) - Optional - A list of audience 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 /designs/{id} Source: https://developer.adobe.com/target/administer/recommendations-api Gets the design with the specified ID. Supports filtering by including the script content. Requires BearerToken and 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) - **id** (integer) - The unique identifier of the design. - **name** (string) - The name of the design. - **script** (string) - The script content of the design (only if `includeScript` is true). - **type** (string) - The content type of the design script. #### Response Example ```json { "offset": 0, "limit": 2147483647, "total": 2, "list": [ { "id": 4, "name": "Landing Page", "script": "\n \n \n \n \n \n
\n \n \n
$profile\n
$token\n
$url\n \n 		\n \n \n
$entity2.name\n
$entity2.message\n
$entity2.value\n \n 		\n \n \n
$entity3.name\n
$entity3.message\n
$entity3.value\n \n
", "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" } ] } ``` ``` -------------------------------- ### Get Client UI Settings API Response Sample Source: https://developer.adobe.com/target/administer/admin-api This JSON snippet represents the response when retrieving client UI settings. It includes various boolean flags for enabling features like experience thumbnails and proxy, as well as configuration for simulators and rendering. ```json { "defaultSimulatorUrl": "string", "enableExperienceThumbs": true, "enableProxyInEe": true, "loadMixedContent": true, "useElementIds": true, "useClassIds": true, "enableFineGrainedPriorities": true, "enableProjectedEarnings": true, "reportingCloudSolution": "target" } ``` -------------------------------- ### POST /activities/abt/{id}/qamode Source: https://developer.adobe.com/target/administer/admin-api Generates preview links for an AB activity in QA mode. Allows specifying URL, activity scope, and audience evaluation. ```APIDOC ## POST /activities/abt/{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/abt/{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. If true, ignores other activities running on the same URL. - **audienceIdsEvaluatedAsTrue** (array of integers) - Optional - A list of audience IDs to be evaluated as true. - **audienceIdsEvaluatedAsFalse** (array of integers) - Optional - A list of audience 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 } ] } ] } ``` ``` -------------------------------- ### Get Client Blocked Features (GET) Source: https://developer.adobe.com/target/administer/models-api Retrieves the globally blocked features for the client. Requires the tenant ID as a path parameter. Returns a JSON object detailing the blocked features and their sources. ```HTTP GET https://mc.adobe.io/{tenant}/target/models/features/blockList/global ``` -------------------------------- ### Get at.js Settings Source: https://developer.adobe.com/target/administer/admin-api Retrieves the current settings for at.js. ```APIDOC ## Get at.js Settings ### Description Retrieve at.js settings. ### Method GET ### Endpoint `/{tenant}/target/atjs/settings` ### Parameters (No specific parameters are listed for this GET request, but tenant is a path parameter.) ### Request Example (No request example provided for GET method) ### Response #### Success Response (200) - **clientCode** (string) - The client code for Adobe Target. - **imsOrgId** (string) - The IMS Organization ID. - **decisioningMethod** (string) - The decisioning method used by at.js. - **artifactCacheTtl** (integer) - The Time-To-Live for cached artifacts. - **profileLifetime** (integer) - The lifetime of user profiles. - **serverDomain** (string) - The server domain for at.js requests. - **libraryHeader** (string) - Custom header script for at.js. - **libraryFooter** (string) - Custom footer script for at.js. - **crossDomain** (string) - Cross-domain tracking configuration. - **globalMboxName** (string) - The name of the global Mbox. - **globalMboxAutoCreate** (boolean) - Whether the global Mbox should be auto-created. - **legacyBrowserSupport** (boolean) - Whether to enable legacy browser support. - **timeout** (integer) - The timeout for at.js requests. #### Response Example ```json { "clientCode": "string", "imsOrgId": "string", "decisioningMethod": "string", "artifactCacheTtl": 0, "profileLifetime": 0, "serverDomain": "string", "libraryHeader": "string", "libraryFooter": "string", "crossDomain": "string", "globalMboxName": "string", "globalMboxAutoCreate": true, "legacyBrowserSupport": true, "timeout": 0 } ``` ```