Adobe Target Recommendations API

openapi: 3.1.0
info:
  title: Recommendations API Reference
  description: "Recommendations API are based on [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). This describes the\nresources that make up the official Adobe Target Recommendations API. The resources are designated by nouns or objects in the\nworld of Recommendations like a feed or a design. The functionalities or operations on resources are designated by HTTP\nmethods in each resource request.\n\n# Getting Started\nA Recommendations API request looks like this:\n```\ncurl -X POST \\\nhttps://mc.adobe.io/{{tenantId}}/target/recs/collections \\\n-H 'Accept: application/vnd.adobe.target.v1+json' \\\n-H 'Authorization: Bearer {{bearerToken}}' \\\n-H 'Content-Type: application/vnd.adobe.target.v1+json' \\\n-H 'X-Api-Key: {{xApiKey}}' \\\n-d '{\n  \"name\": \"Backpacking Tents\",\n  \"rules\": [\n    {\n      \"id\": {\n        \"contains\": [\n          \"backpacking\"\n        ]\n      }\n    }\n  ]\n}'\n```\nThe `tenantId` is your Adobe Experience Cloud tenant ID. It is present as a subdomain of your Experience Cloud URL.\nFor example, if your Experience Cloud URL is _piedpiper.experiencecloud.adobe.com_ or _piedpiper.marketing.adobe.com_, the\ntenant ID is _piedpiper_.\n\n`bearerToken` and `xApiKey` are security token variables explained below in Authentication.\n\n## Limitations\n- These APIs do not allow you to interact with resources created in the Recommendations Classic.\n- Resources can not be deleted until they are no longer referenced by any other resources. For example, a criteria cannot be\n  deleted if its being used in a recommendation activity. It can only be deleted if its removed from from wherever it is used.\n- This documentation does not include following APIs:\n  - Entity Recommendation Download (legacy): To download CSV containing entity recommendations.\n  - Custom Algorithm Upload (legacy): To upload custom algorithm feed through POST request.\n  - Feeds\n\n  # Postman\n  All Recommendations API requests are available in a Postman collection. Click the \"Run in Postman\" button to download the\n  collection as a JSON file, then import it in Postman. Note this collection references a Postman environment, which is\n  available from the [Adobe I/O console integration page](https://console.adobe.io/integrations) for your specific\n  integration.\n\n  [![Run in Postman](https://run.pstmn.io/button.svg)](https://raw.githubusercontent.com/AdobeDocs/target-developers/main/src/Recommendations.postman_collection.json)\n"
  termsOfService: https://www.adobe.com/legal/terms.html
  contact:
    name: Support
    email: customercare@adobe.com
  version: latest
  x-logo:
    url: http://developers.adobetarget.com/api/recommendations/adobe_target-logo.png
    altText: Adobe Target
servers:
- url: https://mc.adobe.io/{tenantId}/target/recs
  description: Adobe I/O gateway
  variables:
    tenantId:
      default: demo
      description: Tenant ID
security:
- BearerToken: []
- ApiKey: []
tags:
- name: Collections
  description: '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.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/entities/collections.html
- name: Criteria
  description: '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.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Cart Criteria
  description: 'Cart Criteria are criteria based on visitor''s activity on multiple items. The recommendation keys are supplied through

    mbox parameter `cartIds` in comma-separated values. Only the first 10 values are considered.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Category Criteria
  description: 'Category Criteria are criteria based on item category. The recommendation

    key is currently viewed item category or visitor favorite category.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Custom Criteria
  description: '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.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/recommendations-csv.html
- name: Item Criteria
  description: 'Item Criteria are criteria based on visitor''s activity on item. The recommendation key is currently viewed item, last viewed

    item, most viewed item or last purchased item. Note that this does not include recently viewed item, check Recent Criteria

    APIs for that.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Popularity Criteria
  description: 'Popularity Criteria are criteria that generate popular items as recommendations. The recommendation key is top sellers, most

    viewed items or Analytics product report metric.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Profile Attribute Criteria
  description: Profile Attribute Criteria are criteria where recommendation is determined by an item that is stored in visitor's profile using either `user.*` or `profile.*` attributes. The profile attribute contains the item ID on which the recommendations are based.
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Recent Criteria
  description: Recent Criteria are criteria based on recently viewed items.
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Sequence Criteria
  description: 'A Sequence Criteria is a combination of multiple criteria. Such sequence of up to five criteria can be used to exercise

    greater control of recommendations. By using a criteria sequence, you can provide additional targeted recommendations,

    instead of using more generic backup recommendations, when a criteria doesn''t return enough results to fill your design.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/create-criteria-sequence.html
- name: User History Criteria
  description: 'User History Criteria are criteria based on visitor''s browsing, viewing or purchasing history. It is generally

    referred to as "Recommended for You".

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/criteria/algorithms.html
- name: Designs
  description: 'A design is a script that is used to determine how your recommendations look. You can create customized designs to provide

    the appearance you desire. The script can be HTML or non-HTML; non-HTML for non-web environments where click-tracking is not

    possible. Recommendation designs use Apache Velocity, so the script should make use of

    [Velocity Template Language](http://velocity.apache.org/engine/1.7/vtl-reference.html).

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/recommendations-design/design-overview.html
- name: Entities
  description: 'Entities refer to the items you want to recommend. Entities can be anything such as products, content (such as articles,

    slide shows, images, movies, and TV shows), job listings, restaurants, and so forths

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/entities/products.html
- name: Promotions
  description: 'Promotion is a special type of criteria that includes promoted items in your recommendation design. Item recommendation by

    promotions use available slots in the design and take precedence over criteria results and backup recommendations.

    '
  externalDocs:
    description: More info.
    url: https://experienceleague.adobe.com/docs/target/using/recommendations/recommendations-activity/adding-promotions.html


# --- truncated at 32 KB (176 KB total) ---
# Full source: https://artifacts.apis.io/adobe/openapi/adobe-target-recommendations-openapi.yml