Recommendations API (1.0)

Download OpenAPI specification:Download

API Reference

Recommendations API are based on REST. This describes the resources that make up the official Adobe Target Recommendations API. The resources are designated by nouns or objects in the world of Recommendations like a feed or a design. The functionalities or operations on resources are designated by HTTP methods in each resource request.

Adobe Target has multiple sets of APIs:

  • Admin API: Programmatically create and modify Activities, Audiences and Offers.
  • Reporting API: Export activity results and other reports.
  • Profile API: Retrieve and modify user profiles stored in Adobe Target.
  • Delivery API: Retrieve optimized and personalized content from Target for delivery and to an end user.

Recommendations API are a subset of the Admin API.

Getting Started

A Recommendations API call looks like this:

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"
        ]
      }
    }
  ]
}'

The tenantId is your Adobe Experience Cloud tenant ID. It is present as a subdomain of your Experience Cloud URL. For example, if your Experience Cloud URL is piedpiper.experiencecloud.adobe.com or piedpiper.marketing.adobe.com, the tenant ID is piedpiper.

bearerToken and xApiKey are security token variables explained below in Authentication.

Limitations

  • These APIs do not allow you to interact with resources created in the legacy Recommendations Classic UI.
  • Resources can not be deleted until they are no longer referenced by any other resources. For example, a criteria cannot be deleted if its being used in a recommendation unit. It can only be deleted if its removed from from wherever it is used.
  • This documentation does not include following APIs:

    • Entity Recommendation Download: To download CSV containing entity recommendations for a recommendation unit.
    • Custom Algorithm Upload (legacy): To upload custom algorithm feed through request payload.
    • Exclusions*
    • Feeds*

    * Coming soon

Authentication

OAuth 2.0

This API uses OAuth 2.0 framework for authentication and authorization. Refer this to the generate access token required for API calls.

Security scheme type: OAuth2
password OAuth Flow
Token URL: https://ims-na1.adobelogin.com/ims/token/
Scopes:

    API Key

    This API also uses API Key for authorization. You can obtain the API Key from your Adobe I/O Console.

    Security scheme type: API Key
    header parameter name: X-Api-Key

    Collections

    A collection is a set of items that are eligible for a recommendation. It is defined by a set of membership rules. If an item satisfies these rules, it is a member of the collection.

    List collections

    Gets all available collections.

    Authorizations:
    OAuth 2.0 & API Key
    query Parameters
    offset
    integer <int32> (offset)

    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 <int32> (limit)

    Number of resources to request. If not specified, the response will include all available resources.

    Responses

    200

    Successful request with list of collection resources in response

    get /collections
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/collections

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "offset": 0,
    • "limit": 2147483647,
    • "total": 2,
    • "list":
      [
      ]
    }

    Create collection

    Creates a new collection as specified by the rules provided and returns the newly created collection definition.

    Authorizations:
    OAuth 2.0 & API Key
    Request Body schema: application/vnd.adobe.target.v1+json
    name
    required
    string <= 250 characters

    Unique name of the collection.

    rules
    required
    Array of object (RestBasicMatcher)

    Array of rules containing attribute : operation pairs.

    The attribute is any valid entity attribute. It is a required field and it should not be more than 100 characters.

    The operation is a pair of operator and operand values. The operator can be one of:

    • Numeric operators: greaterOrEquals, lesserOrEquals
    • String operators: startsWith, endsWith, contains, doesNotContain
    • Alphanumeric operators: equals, notEquals, valueIsPresent, valueIsNotPresent

    The other part of operation, operand values, is an array of values. Each value cannot be more than 250 characters. There must be atleast 1 value and no more than 1000 values. Operand values are not required when operator is either valueIsPresent or valueIsNotPresent. Numeric operators accept integer or floating point operand values.

    Responses

    201

    Collection resource created with resource definition in response

    post /collections
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/collections

    Request samples

    application/vnd.adobe.target.v1+json
    Copy
    Expand all Collapse all
    {
    • "name": "Backpacking Tents",
    • "rules":
      [
      ]
    }

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 1,
    • "name": "Backpacking Tents",
    • "rules":
      [
      ]
    }

    Get collection

    Gets the collection with the given ID.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>

    Responses

    200

    Successful request with collection resource in response

    get /collections/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/collections/{id}

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 1,
    • "name": "Backpacking Tents",
    • "rules":
      [
      ]
    }

    Edit collection

    Updates the collection with new name and/or new rules as specified and returns the updated collection definition.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>
    Request Body schema: application/vnd.adobe.target.v1+json
    name
    required
    string <= 250 characters

    Unique name of the collection.

    rules
    required
    Array of object (RestBasicMatcher)

    Array of rules containing attribute : operation pairs.

    The attribute is any valid entity attribute. It is a required field and it should not be more than 100 characters.

    The operation is a pair of operator and operand values. The operator can be one of:

    • Numeric operators: greaterOrEquals, lesserOrEquals
    • String operators: startsWith, endsWith, contains, doesNotContain
    • Alphanumeric operators: equals, notEquals, valueIsPresent, valueIsNotPresent

    The other part of operation, operand values, is an array of values. Each value cannot be more than 250 characters. There must be atleast 1 value and no more than 1000 values. Operand values are not required when operator is either valueIsPresent or valueIsNotPresent. Numeric operators accept integer or floating point operand values.

    Responses

    200

    Successful request with updated collection resource in response

    put /collections/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/collections/{id}

    Request samples

    application/vnd.adobe.target.v1+json
    Copy
    Expand all Collapse all
    {
    • "name": "Backpacking Tents",
    • "rules":
      [
      ]
    }

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 1,
    • "name": "Backpacking Tents",
    • "rules":
      [
      ]
    }

    Delete collection

    Deletes the collection referenced by the given ID.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>

    Responses

    200

    Successful request with deleted collection resource in response

    delete /collections/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/collections/{id}

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 1,
    • "name": "Backpacking Tents",
    • "rules":
      [
      ]
    }

    Criteria

    Criteria are rules that determine which items to recommend based on a predetermined set of visitor behaviors. Criteria are categorized into different groups depending on the recommendation key and recommendation logic. These groups are: category, item, recent, popularity, profile attribute, custom.

    List criteria

    Gets all available criteria.

    Authorizations:
    OAuth 2.0 & API Key
    query Parameters
    offset
    integer <int32> (offset)

    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 <int32> (limit)

    Number of resources to request. If not specified, the response will include all available resources.

    references
    boolean

    Whether to retrieve the number of recommendation units and legacy recommendation objects associated with each criteria. A recommendation unit or a legacy recommendation object is an internal object that has a one-to-one correspondence with the recommendation activity.

    Responses

    200

    Successful request with list of criteria resources in response

    get /criteria
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "offset": "2,",
    • "limit": "2147483647,",
    • "total": 3,
    • "list":
      [
      ]
    }

    Get criteria

    Gets minimal criteria information with the given ID. For detailed information, make API call to criteria group path, for example, /criteria/item/{id}.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>

    Responses

    200

    Successful request with criteria resource in response

    get /criteria/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/{id}

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 34,
    • "name": "Recently Viewed Biking Accessories",
    • "criteriaTitle": "Recently Viewed Biking Accessories",
    • "criteriaGroup": "RECENT"
    }

    Category Criteria

    Category Criteria are criteria based on item category. The recommendation key is currently viewed item category or visitor favorite category.

    List category criteria

    Gets all available category based criteria.

    Authorizations:
    OAuth 2.0 & API Key
    query Parameters
    offset
    integer <int32> (offset)

    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 <int32> (limit)

    Number of resources to request. If not specified, the response will include all available resources.

    references
    boolean

    Whether to retrieve the number of recommendation units and legacy recommendation objects associated with each criteria. A recommendation unit or a legacy recommendation object is an internal object that has a one-to-one correspondence with the recommendation activity.

    Responses

    200

    Successful request with list of category criteria resources in response

    get /criteria/category
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/category

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "offset": 2,
    • "limit": 2147483647,
    • "total": 3,
    • "list":
      [
      ]
    }

    Create category criteria

    Creates a new category based criteria as specified by the settings and configuration provided and returns the newly created criteria definition.

    Authorizations:
    OAuth 2.0 & API Key
    Request Body schema: application/vnd.adobe.target.v1+json
    criteriaTitle
    string <= 250 characters

    Displayed in the design using variable $criteria.title.

    name
    required
    string <= 250 characters

    Unique name of the criteria.

    aggregation
    string
    Default: "NONE"
    Enum:"NONE" "AGGREGATE" "ALL_OR_NOTHING"

    Whether recommendations should be shown solely based on the key (NONE) or visitor's behavioral history with respect to the key (AGGREGATE, ALL_OR_NOTHING).

    • NONE implies no aggregation, to only show recommendations for the given key.
    • AGGREGATE begins with recommendations for the given key, favorite category in this instance, then continues to next favorite of visitor's favorite categories until the design is filled.
    • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, favorite category in this instance, has enough recommendations to fill the design. If the key does not have enough recommendations, next favorite category in visitor's favorite categories is considered sequentially until the design is filled.

    If the key is current category, only NONE is valid. For key as favorite category, all aggregation options are available.

    backupDisabled
    boolean
    Default: false

    Whether backup recommendations are disabled when criteria does not generate enough recommendations.

    backupInclusionFilteringEnabled
    boolean
    Default: true

    Whether inclusion rules on the criteria should be applied to backup recommendations.

    configuration
    object (CriteriaCategoryConfiguration)

    Object containing inclusion rules, attribute weighting, price filter, and some more configuration options specific to the criteria group.

    daysCount
    required
    string
    Enum:"ONE_DAY" "TWO_DAYS" "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "TWO_MONTHS"

    Time range of historical visitor behavioral data to consider for generating recommendations.

    excludePurchases
    boolean
    Default: false

    Whether items that were previously purchased by the visitor should be excluded in recommendations.

    key
    required
    string
    Enum:"CURRENT" "FAVORITE"

    Recommendation key. Values:

    • CURRENT: The category of the currently viewed item.
    • FAVORITE: The category among visitor's categories with highest score. The recommendations are determined by the categories that have been most viewed. The score is determined by recency/frequency: 10 points for first category view, 5 points for every subsequent view.
    minInventory
    integer <int32> >= 0

    Minimum number of pieces needed in stock for an item to be considered for recommendaton.

    partialDesignAllowed
    boolean
    Default: false

    Whether design be shown when the number of recommendations are less than item slots in the design.

    type
    required
    string
    Enum:"BOUGHT" "VIEWED"

    Recommendation logic. Values:

    • BOUGHT: Top sold items.
    • VIEWED: Most viewed items.

    Responses

    201

    Criteria resource created with resource definition in response

    post /criteria/category
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/category

    Request samples

    application/vnd.adobe.target.v1+json
    Copy
    Expand all Collapse all
    {
    • "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,
    • "backupInclusionFilteringEnabled": true,
    • "configuration":
      {
      }
    }

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "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":
      {
      }
    }

    Get category criteria

    Gets the category based criteria with the given ID.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>
    query Parameters
    references
    boolean

    Whether to retrieve list of recommendation units and legacy recommendation objects associated with the criteria. A recommendation unit or a legacy recommendation object is an internal object that has a one-to-one correspondence with the recommendation activity. If there are no associated recommendation units or legacy recommendation objects, no references are returned.

    Responses

    200

    Successful request with criteria resource in response

    get /criteria/category/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/category/{id}

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "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":
      {
      }
    }

    Edit category criteria

    Updates the category based criteria with new settings and configuration as specified and returns the updated criteria definition.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>
    query Parameters
    references
    boolean

    Whether to retrieve list of recommendation units and legacy recommendation objects associated with the criteria. A recommendation unit or a legacy recommendation object is an internal object that has a one-to-one correspondence with the recommendation activity. If there are no associated recommendation units or legacy recommendation objects, no references are returned.

    Request Body schema: application/vnd.adobe.target.v1+json
    criteriaTitle
    string <= 250 characters

    Displayed in the design using variable $criteria.title.

    name
    required
    string <= 250 characters

    Unique name of the criteria.

    aggregation
    string
    Default: "NONE"
    Enum:"NONE" "AGGREGATE" "ALL_OR_NOTHING"

    Whether recommendations should be shown solely based on the key (NONE) or visitor's behavioral history with respect to the key (AGGREGATE, ALL_OR_NOTHING).

    • NONE implies no aggregation, to only show recommendations for the given key.
    • AGGREGATE begins with recommendations for the given key, favorite category in this instance, then continues to next favorite of visitor's favorite categories until the design is filled.
    • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, favorite category in this instance, has enough recommendations to fill the design. If the key does not have enough recommendations, next favorite category in visitor's favorite categories is considered sequentially until the design is filled.

    If the key is current category, only NONE is valid. For key as favorite category, all aggregation options are available.

    backupDisabled
    boolean
    Default: false

    Whether backup recommendations are disabled when criteria does not generate enough recommendations.

    backupInclusionFilteringEnabled
    boolean
    Default: true

    Whether inclusion rules on the criteria should be applied to backup recommendations.

    configuration
    object (CriteriaCategoryConfiguration)

    Object containing inclusion rules, attribute weighting, price filter, and some more configuration options specific to the criteria group.

    daysCount
    required
    string
    Enum:"ONE_DAY" "TWO_DAYS" "ONE_WEEK" "TWO_WEEKS" "ONE_MONTH" "TWO_MONTHS"

    Time range of historical visitor behavioral data to consider for generating recommendations.

    excludePurchases
    boolean
    Default: false

    Whether items that were previously purchased by the visitor should be excluded in recommendations.

    key
    required
    string
    Enum:"CURRENT" "FAVORITE"

    Recommendation key. Values:

    • CURRENT: The category of the currently viewed item.
    • FAVORITE: The category among visitor's categories with highest score. The recommendations are determined by the categories that have been most viewed. The score is determined by recency/frequency: 10 points for first category view, 5 points for every subsequent view.
    minInventory
    integer <int32> >= 0

    Minimum number of pieces needed in stock for an item to be considered for recommendaton.

    partialDesignAllowed
    boolean
    Default: false

    Whether design be shown when the number of recommendations are less than item slots in the design.

    type
    required
    string
    Enum:"BOUGHT" "VIEWED"

    Recommendation logic. Values:

    • BOUGHT: Top sold items.
    • VIEWED: Most viewed items.

    Responses

    200

    Successful request with updated criteria resource in response

    put /criteria/category/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/category/{id}

    Request samples

    application/vnd.adobe.target.v1+json
    Copy
    Expand all Collapse all
    {
    • "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,
    • "backupInclusionFilteringEnabled": true,
    • "configuration":
      {
      }
    }

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "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":
      {
      }
    }

    Delete category criteria

    Deletes the category based criteria referenced by the given ID.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>

    Responses

    200

    Successful request with deleted criteria resource in response

    delete /criteria/category/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/category/{id}

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "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":
      {
      }
    }

    Custom Criteria

    Custom Criteria are criteria based on user-defined custom recommendations. You upload a CSV containing item keys and their corresponding list of recommendations. These recommendations, after applying configuration rules and settings, if any, will be delivered to your page. The item keys in your CSV should map to items or categories in the catalog. The recommendation key of this criteria can be any item based, category based key or profile attribute key depending on the item keys in the CSV. The CSV upload is carried out through a feed as part of configuration to create a custom criteria. Note, an item key refers to the key in the CSV feed whereas a recommendation key refers to how the item key will be treated, that is, it can be treated as ID of currently viewed item or visitor's favorite category.

    List custom criteria

    Gets all available custom criteria.

    Authorizations:
    OAuth 2.0 & API Key
    query Parameters
    offset
    integer <int32> (offset)

    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 <int32> (limit)

    Number of resources to request. If not specified, the response will include all available resources.

    references
    boolean

    Whether to retrieve the number of recommendation units and legacy recommendation objects associated with each criteria. A recommendation unit or a legacy recommendation object is an internal object that has a one-to-one correspondence with the recommendation activity.

    Responses

    200

    Successful request with list of custom criteria resources in response

    get /criteria/custom
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/custom

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "offset": 42,
    • "limit": 45,
    • "total": 3,
    • "list":
      [
      ]
    }

    Create custom criteria

    Creates a new custom criteria as specified by the settings, configuration, and feed provided and returns the newly created criteria definition.

    Authorizations:
    OAuth 2.0 & API Key
    Request Body schema: application/vnd.adobe.target.v1+json
    criteriaTitle
    string <= 250 characters

    Displayed in the design using variable $criteria.title.

    name
    required
    string <= 250 characters

    Unique name of the criteria.

    backupDisabled
    boolean
    Default: false

    Whether backup recommendations are disabled when enough recommendations from CSV feed are not applicable in design.

    backupInclusionFilteringEnabled
    boolean
    Default: true

    Whether inclusion rules on the criteria should be applied to backup recommendations.

    configuration
    required
    object (CriteriaCustomConfiguration)

    Object containing inclusion rules, attribute weighting, price filter, and some more configuration options specific to the criteria group.

    excludePurchases
    boolean
    Default: false

    Whether items that were previously purchased by the visitor should be excluded in recommendations.

    key
    required
    string
    Enum:"CURRENT" "LAST_VIEWED" "LAST_PURCHASED" "MOST_VIEWED" "CURRENT_CATEGORY" "FAVORITE_CATEGORY" "PROFILE_ATTRIBUTE"

    Recommendation key. Values:

    • CURRENT: The currently viewed item.
    • LAST_VIEWED: The last viewed item.
    • LAST_PURCHASED: The last purchased item.
    • MOST_VIEWED: The most viewed item. The recommendations are determined by items that have been most viewed. The score is determined by recency/frequency: 10 points for first item view, 5 points for every subsequent view, all points are halved after the session ends.
    • CURRENT_CATEGORY: The category of the currently viewed item.
    • FAVORITE_CATEGORY: The category among visitor's categories with highest score. The recommendations are determined by the categories that have been most viewed. The score is determined by recency/frequency: 10 points for first category view, 5 points for every subsequent view.
    • PROFILE_ATTRIBUTE: Profile attribute.
    minInventory
    integer <int32> >= 0

    Minimum number of pieces needed in stock for an item to be considered for recommendaton.

    partialDesignAllowed
    boolean
    Default: false

    Whether design be shown when the number of recommendations are less than item slots in the design.

    Responses

    201

    Criteria resource created with resource definition in response

    post /criteria/custom
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/custom

    Request samples

    application/vnd.adobe.target.v1+json
    Copy
    Expand all Collapse all
    {
    • "name": "Classes Events",
    • "criteriaTitle": "Classes & Events",
    • "key": "PROFILE_ATTRIBUTE",
    • "partialDesignAllowed": true,
    • "backupDisabled": false,
    • "excludePurchases": true,
    • "backupInclusionFilteringEnabled": true,
    • "configuration":
      {
      }
    }

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 45,
    • "name": "Classes Events",
    • "criteriaTitle": "Classes & Events",
    • "criteriaGroup": "CUSTOM",
    • "key": "PROFILE_ATTRIBUTE",
    • "partialDesignAllowed": true,
    • "backupDisabled": false,
    • "excludePurchases": true,
    • "backupInclusionFilteringEnabled": true,
    • "configuration":
      {
      }
    }

    Get custom criteria

    Gets the custom criteria with the given ID.

    Authorizations:
    OAuth 2.0 & API Key
    path Parameters
    id
    required
    integer <int32>
    query Parameters
    references
    boolean

    Whether to retrieve list of recommendation units and legacy recommendation objects associated with the criteria. A recommendation unit or a legacy recommendation object is an internal object that has a one-to-one correspondence with the recommendation activity. If there are no associated recommendation units or legacy recommendation objects, no references are returned.

    Responses

    200

    Successful request with criteria resource in response

    get /criteria/custom/{id}
    Adobe I/O gateway
    https://mc.adobe.io/{tenantId}/target/recs/criteria/custom/{id}

    Response samples

    application/vnd.adobe.target.v1+json;charset=UTF-8
    Copy
    Expand all Collapse all
    {
    • "id": 45,
    • "name": "Classes Events",
    • "criteriaTitle": "Classes & Events",
    • "criteriaGroup": "CUSTOM",
    • "key": "PROFILE_ATTRIBUTE",