Adobe Target
redocly logoAPI docs by Redocly

Recommendations API Reference (latest)

Support: customercare@adobe.com Terms of Service

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.

Product documentation

Getting Started

A Recommendations API request 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 Recommendations Classic.
  • 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 activity. It can only be deleted if its removed from from wherever it is used.
  • This documentation does not include following APIs:
    • Entity Recommendation Download (legacy): To download CSV containing entity recommendations.
    • Custom Algorithm Upload (legacy): To upload custom algorithm feed through POST request.
    • Feeds

Postman

All Recommendations API requests are available in a Postman collection. Click the "Run in Postman" button to download the collection as a JSON file, then import it in Postman. Note this collection references a Postman environment, which is available from the Adobe I/O console integration page for your specific integration.

Run in Postman

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.

More info.

List collections

Gets all available collections.

Authorizations:
BearerTokenApiKey
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.

orderby
string
Enum: "id" "name" "lastModified"

Name of the field by which the response list should be sorted. It can be prefixed with a + to indicate ascending order or - to indicate descending order by that field. If the field name is not prefixed, ascending order is assumed.

name
string

String to filter resources by name. If specified, all resources with a name containing the string are selected, otherwise the response will include all resources. Case-insensitive.

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 2 collections.

{
  • "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:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Collection to be created/updated

name
required
string <= 250 characters

Unique name of the collection.

description
string <= 1000 characters
required
Array of objects (BasicMatcher) [ 1 .. 1000 ] items

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

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a collection object to be created/updated.

{
  • "name": "Backpacking Tents",
  • "description": "Lightweight tents suitable for backpacking.",
  • "rules": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a collection object.

{
  • "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": [
    ]
}

Get collection

Gets the collection with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a collection object.

{
  • "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": [
    ]
}

Edit collection

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

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Collection to be created/updated

name
required
string <= 250 characters

Unique name of the collection.

description
string <= 1000 characters
required
Array of objects (BasicMatcher) [ 1 .. 1000 ] items

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

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a collection object to be created/updated.

{
  • "name": "Backpacking Tents",
  • "description": "Lightweight tents suitable for backpacking.",
  • "rules": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a collection object.

{
  • "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": [
    ]
}

Delete collection

Deletes the collection referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a collection object.

{
  • "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": [
    ]
}

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.

More info.

List criteria

Gets all available criteria.

Authorizations:
BearerTokenApiKey
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.

orderby
string
Enum: "id" "name" "lastModified"

Name of the field by which the response list should be sorted. It can be prefixed with a + to indicate ascending order or - to indicate descending order by that field. If the field name is not prefixed, ascending order is assumed.

name
string

String to filter resources by name. If specified, all resources with a name containing the string are selected, otherwise the response will include all resources. Case-insensitive.

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 criteria.

{
  • "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:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a criteria with minimal information.

{
  • "id": 34,
  • "name": "Recently Viewed Biking Accessories",
  • "criteriaTitle": "Recently Viewed Biking Accessories",
  • "criteriaGroup": "RECENT"
}

Designs

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.

More info.

List designs

Gets all available designs.

Authorizations:
BearerTokenApiKey
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.

includeScript
boolean

Whether to include the design content.

orderby
string
Enum: "id" "name" "lastModified"

Name of the field by which the response list should be sorted. It can be prefixed with a + to indicate ascending order or - to indicate descending order by that field. If the field name is not prefixed, ascending order is assumed.

name
string

String to filter resources by name. If specified, all resources with a name containing the string are selected, otherwise the response will include all resources. Case-insensitive.

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 2 designs.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list": [
    ]
}

Create a design

Creates a new design as specified by the script provided and returns the newly created design definition.

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Design to be created/updated

name
required
string <= 250 characters

Unique name of the design.

script
required
string <= 65000 characters

Velocity template containing at least one entity object. Velocity Engine 1.7 is supported.

type
string
Default: "OTHER"
Enum: "HTML" "JSON" "OTHER"

The content type of the design script.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a design to be created/updated.

{
  • "name": "Landing Page",
  • "script": "name = $entity1.name<br/> details= $entity1.details <table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>"
}

Response samples

Content type
application/vnd.adobe.target.v1+json

A response body example of a design object.

{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>",
  • "type": "HTML"
}

Get design

Gets the design with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
query Parameters
includeScript
boolean

Whether to include the design content.

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json

A response body example of a design object.

{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>",
  • "type": "HTML"
}

Edit design

Updates the design with new name and/or new script as specified and returns the updated design definition.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
query Parameters
includeScript
boolean

Whether to include the design content.

Request Body schema: application/vnd.adobe.target.v1+json

Design to be created/updated

name
required
string <= 250 characters

Unique name of the design.

script
required
string <= 65000 characters

Velocity template containing at least one entity object. Velocity Engine 1.7 is supported.

type
string
Default: "OTHER"
Enum: "HTML" "JSON" "OTHER"

The content type of the design script.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a design to be created/updated.

{
  • "name": "Landing Page",
  • "script": "name = $entity1.name<br/> details= $entity1.details <table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>"
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a design object.

{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>",
  • "type": "HTML"
}

Delete design

Deletes the design referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a design object.

{
  • "id": 1,
  • "name": "Landing Page",
  • "script": "<table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>",
  • "type": "HTML"
}

Validate design

Validates a design by verifying the correctness of the script. If its correct, it returns number of entity objects used in the script; otherwise it returns the validation error.

Note this POST request does not create any resource. The endpoint is not a resource but rather it is simply a method to validate the design in request payload..

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Design to be created/updated

name
required
string <= 250 characters

Unique name of the design.

script
required
string <= 65000 characters

Velocity template containing at least one entity object. Velocity Engine 1.7 is supported.

type
string
Default: "OTHER"
Enum: "HTML" "JSON" "OTHER"

The content type of the design script.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a design to be created/updated.

{
  • "name": "Landing Page",
  • "script": "name = $entity1.name<br/> details= $entity1.details <table>\\n <tr>\\n <td>\\n <a href=\\\"$entity1.pageUrl\\\">\\n <img src=\\\"$entity1.thumbnailUrl\\\"/>\\n <br/>$profile\\n <br/> $token\\n <br/>$url\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity2.pageUrl\\\">\\n <img src=\\\"$entity2.thumbnailUrl\\\"/> \\n <br/>$entity2.name\\n <br/>$entity2.message\\n <br/> $entity2.value\\n </a>\\n </td>\\n <td>\\n <a href=\\\"$entity3.pageUrl\\\">\\n <img src=\\\"$entity3.thumbnailUrl\\\"/> \\n <br/>$entity3.name\\n <br/>$entity3.message\\n <br/> $entity3.value\\n </a>\\n </td>\\n </tr>\\n</table>"
}

Response samples

Content type
application/vnd.adobe.target.v1+json

A response body example of validation result of the design object provided in request.

{
  • "entityCount": 0,
  • "valid": false,
  • "errors": [
    ]
}

Entities

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

More info.

Save entities

Creates entities, updates if present, with the given entity details and returns the numbers of entities rejected, and created or updated. Entities can be rejected if entity details do not conform to the schema. More info.

Note this POST request does not create a singular resource. The endpoint is not a resource but rather it is simply a method to save multiple entities specified in request payload.

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Entities to be created/updated

required
Array of objects (Entity) non-empty

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an entity to be created/updated.

{
  • "entities": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of entity batch update result showing a successful update.

{
  • "rejected": 0,
  • "inserted/updated": 1
}

Delete entities

Deletes entities referenced by the given IDs. If no ID is given, all entities in the given environment are deleted. If no environment ID is given, entities will be deleted from all environments. Use this with caution!

Note this DELETE request does not delete a singular resource. The endpoint is not a resource but rather it is simply a method to delete multiple entities specified in request payload.

Authorizations:
BearerTokenApiKey
query Parameters
ids
Array of strings[ items <= 1000 characters ]

List of entity IDs. If not set, all entities will be deleted.

environment
number <double>

ID of an environment. If not set, entities will be deleted from all environments.

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of entity batch delete result indicating all entities were deleted.

{
  • "operation": "Delete by client requested."
}

Get entity

Gets entity with the given ID from default environment. To retrieve entity from a specific environment, environmentId request parameter can be used.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
string <= 1000 characters
query Parameters
environmentId
integer <int64>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an entity object.

{
  • "name": "Rotisserie Chicken",
  • "id": "item1",
  • "environment": 4227,
  • "categories": [
    ],
  • "attributes": {
    }
}

Exclusions

An exclusion is a subset of entities that should not be recommended to visitors. It is defined by a membership rule. If an item satisfies this rule, it is excluded from recommendations to visitors.

More info.

List exclusions

Gets all available exclusions.

Authorizations:
BearerTokenApiKey
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.

orderby
string
Enum: "id" "name" "lastModified"

Name of the field by which the response list should be sorted. It can be prefixed with a + to indicate ascending order or - to indicate descending order by that field. If the field name is not prefixed, ascending order is assumed.

name
string

String to filter resources by name. If specified, all resources with a name containing the string are selected, otherwise the response will include all resources. Case-insensitive.

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 2 exclusions.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list": [
    ]
}

Create exclusion

Creates a new exclusion as specified by the rule provided and returns the newly created exclusion definition.

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Exclusion to be created/updated

name
required
string <= 250 characters
description
string <= 1000 characters
rule
object

A rule containing attribute : operation pair.

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. Operand values are not required when operator is either valueIsPresent or valueIsNotPresent. Numeric operators accept integer or floating point operand values.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an exclusion object to be created/updated.

{
  • "id": 428,
  • "name": "Backpacking Tents",
  • "description": "Exclude backpacking tents with less than 10 items remaining in the inventory",
  • "rule": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an exclusion object.

{
  • "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": {
    }
}

Get exclusion

Gets the exclusion with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an exclusion object.

{
  • "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": {
    }
}

Edit exclusion

Updates the exclusion with new name, description and/or new rule as specified and returns the updated exclusion definition.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Exclusion to be created/updated

name
required
string <= 250 characters
description
string <= 1000 characters
rule
object

A rule containing attribute : operation pair.

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. Operand values are not required when operator is either valueIsPresent or valueIsNotPresent. Numeric operators accept integer or floating point operand values.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an exclusion object to be created/updated.

{
  • "id": 428,
  • "name": "Backpacking Tents",
  • "description": "Exclude backpacking tents with less than 10 items remaining in the inventory",
  • "rule": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an exclusion object.

{
  • "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": {
    }
}

Delete exclusion

Deletes the exclusion referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an exclusion object.

{
  • "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": {
    }
}

Promotions

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.

More info.

List promotions

List all available promotions.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 2 promotions.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list": [
    ]
}

Create promotion

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

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Promotion to be created/updated

name
required
string <= 250 characters

Unique name of the promotion.

type
required
string
Value: "EXTERNAL"

Type of promotion. Currently only external promotions can be created, in which promoted items do not originate from any of the criteria specified in the current recommendation activity.

key
string
Enum: "CURRENT" "LAST_PURCHASED" "LAST_VIEWED" "MOST_VIEWED" "PROFILE_ATTRIBUTE"

Promotion 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.
  • PROFILE_ATTRIBUTE: Profile attribute.
attribute
string^(profile\.|user\.).+

Applicable when key is PROFILE_ATTRIBUTE. This is the profile attribute.

object (PromotionSchedule)

Time duration for which promotion should be applied.

object (PromotionOrder)
object (PromotionConfiguration)

Applicable only when rules are empty and type is not INTERNAL. It contains the relevant collection for promotion items.

Array of objects (InclusionMatcher)

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a promotion object to be created/updated.

{
  • "name": "Hiking shoes summer promotion",
  • "type": "EXTERNAL",
  • "schedule": {
    },
  • "order": {
    },
  • "configuration": {
    },
  • "rules": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a Promotion object.

{
  • "id": 1,
  • "name": "Hiking shoes summer promotion",
  • "type": "EXTERNAL",
  • "schedule": {
    },
  • "order": {
    },
  • "configuration": {
    },
  • "rules": [
    ]
}

Get promotion

Gets the promotion with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a Promotion object.

{
  • "id": 1,
  • "name": "Hiking shoes summer promotion",
  • "type": "EXTERNAL",
  • "schedule": {
    },
  • "order": {
    },
  • "configuration": {
    },
  • "rules": [
    ]
}

Edit promotion

Updates the promotion with the new settings and configuration as specified and return the updated promotion definition.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Promotion to be created/updated

name
required
string <= 250 characters

Unique name of the promotion.

type
required
string
Value: "EXTERNAL"

Type of promotion. Currently only external promotions can be created, in which promoted items do not originate from any of the criteria specified in the current recommendation activity.

key
string
Enum: "CURRENT" "LAST_PURCHASED" "LAST_VIEWED" "MOST_VIEWED" "PROFILE_ATTRIBUTE"

Promotion 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.
  • PROFILE_ATTRIBUTE: Profile attribute.
attribute
string^(profile\.|user\.).+

Applicable when key is PROFILE_ATTRIBUTE. This is the profile attribute.

object (PromotionSchedule)

Time duration for which promotion should be applied.

object (PromotionOrder)
object (PromotionConfiguration)

Applicable only when rules are empty and type is not INTERNAL. It contains the relevant collection for promotion items.

Array of objects (InclusionMatcher)

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a promotion object to be created/updated.

{
  • "name": "Hiking shoes summer promotion",
  • "type": "EXTERNAL",
  • "schedule": {
    },
  • "order": {
    },
  • "configuration": {
    },
  • "rules": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a Promotion object.

{
  • "id": 1,
  • "name": "Hiking shoes summer promotion",
  • "type": "EXTERNAL",
  • "schedule": {
    },
  • "order": {
    },
  • "configuration": {
    },
  • "rules": [
    ]
}

Delete promotion

Deletes the promotion referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a Promotion object.

{
  • "id": 1,
  • "name": "Hiking shoes summer promotion",
  • "type": "EXTERNAL",
  • "schedule": {
    },
  • "order": {
    },
  • "configuration": {
    },
  • "rules": [
    ]
}

Cart Criteria

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.

More info.

List cart criteria

Gets all available cart based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 cart criteria.

{
  • "offset": 2,
  • "limit": 2147483647,
  • "total": 3,
  • "list": [
    ]
}

Create cart criteria

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

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Cart based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

object (CriteriaCartConfiguration)
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.

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.

object

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a cart based criteria to be created/updated.

{
  • "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": {
    },
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a cart based criteria.

{
  • "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": {
    },
  • "configuration": {
    }
}

Get cart criteria

Gets the cart based criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a cart based criteria.

{
  • "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": {
    },
  • "configuration": {
    }
}

Edit cart criteria

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

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Cart based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

object (CriteriaCartConfiguration)
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.

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.

object

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a cart based criteria to be created/updated.

{
  • "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": {
    },
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a cart based criteria.

{
  • "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": {
    },
  • "configuration": {
    }
}

Delete cart criteria

Deletes the cart based criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a cart based criteria.

{
  • "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": {
    },
  • "configuration": {
    }
}

Category Criteria

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

More info.

List category criteria

Gets all available category based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 category criteria.

{
  • "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:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Category based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

object (CriteriaCategoryConfiguration)

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

daysCount
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.

This field can not be used together with hoursCount

hoursCount
integer

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

This field can not be used together with daysCount. Only allowed value 6

excludePurchases
boolean
Default: false

Whether items that were previously purchased by the visitor should be excluded from 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

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a category based criteria to be created/updated.

{
  • "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

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a category based criteria.

{
  • "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:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a category based criteria.

{
  • "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:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Category based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

object (CriteriaCategoryConfiguration)

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

daysCount
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.

This field can not be used together with hoursCount

hoursCount
integer

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

This field can not be used together with daysCount. Only allowed value 6

excludePurchases
boolean
Default: false

Whether items that were previously purchased by the visitor should be excluded from 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

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a category based criteria to be created/updated.

{
  • "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

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a category based criteria.

{
  • "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:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a category based criteria.

{
  • "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.

More info.

List custom criteria

Gets all available custom criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 custom criteria.

{
  • "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:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Custom criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

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 from 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

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a custom criteria to be created/updated.

{
  • "name": "Classes Events",
  • "criteriaTitle": "Classes & Events",
  • "key": "PROFILE_ATTRIBUTE",
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a custom criteria.

{
  • "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:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a custom criteria.

{
  • "id": 45,
  • "name": "Classes Events",
  • "criteriaTitle": "Classes & Events",
  • "criteriaGroup": "CUSTOM",
  • "key": "PROFILE_ATTRIBUTE",
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Edit custom criteria

Updates the custom criteria with new settings, configuration and feed as specified and returns the updated criteria definition.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Custom criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

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 from 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

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a custom criteria to be created/updated.

{
  • "name": "Classes Events",
  • "criteriaTitle": "Classes & Events",
  • "key": "PROFILE_ATTRIBUTE",
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a custom criteria.

{
  • "id": 45,
  • "name": "Classes Events",
  • "criteriaTitle": "Classes & Events",
  • "criteriaGroup": "CUSTOM",
  • "key": "PROFILE_ATTRIBUTE",
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Delete custom criteria

Deletes the custom criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a custom criteria.

{
  • "id": 45,
  • "name": "Classes Events",
  • "criteriaTitle": "Classes & Events",
  • "criteriaGroup": "CUSTOM",
  • "key": "PROFILE_ATTRIBUTE",
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Item Criteria

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.

More info.

List item criteria

Gets all available item based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 item based criteria.

{
  • "offset": 0,
  • "limit": 3,
  • "total": 3,
  • "list": [
    ]
}

Create item criteria

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

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Item based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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, last viewed item, for instance, then continues to next last viewed item by visitor until the design is filled.
  • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, last purchased item, for instance, has enough recommendations to fill the design. If the key does not have enough recommendations, second to last purchased item by visitor is considered and so forth until the design is filled.

If the key is CURRENT, only NONE is valid.

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.

required
object (CriteriaItemConfiguration)

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 from recommendations.

key
required
string
Enum: "CURRENT" "LAST_VIEWED" "LAST_PURCHASED" "MOST_VIEWED"

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.
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: "VIEWED_BOUGHT" "BOUGHT_CF" "VIEWED_CF" "SITE_AFFINITY" "SIMILARITY"

Recommendation logic. Values:

  • VIEWED_BOUGHT: People who viewed this, bought that.
  • BOUGHT_CF: People who bought this, bought that.
  • VIEWED_CF: People who viewed this, viewed that.
  • SITE_AFFINITY: Considers items based on the certainty of a relationship between items. Confidence setting is used to determine how much data (strong or weak affinity) is required before a recommendation is presented.
  • SIMILARITY: Considers items similar to items based on current page activity or past visitor behavior.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an item based criteria to be created/updated.

{
  • "name": "Items after buying road bike",
  • "criteriaGroup": "ITEM",
  • "type": "BOUGHT_CF",
  • "key": "CURRENT",
  • "aggregation": "NONE",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 1,
  • "partialDesignAllowed": false,
  • "backupDisabled": false,
  • "excludePurchases": false,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an item based criteria.

{
  • "id": 2,
  • "name": "Similar items",
  • "criteriaGroup": "ITEM",
  • "type": "BOUGHT_CF",
  • "key": "CURRENT",
  • "aggregation": "NONE",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 1,
  • "partialDesignAllowed": false,
  • "backupDisabled": true,
  • "excludePurchases": false,
  • "enableCaching": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Get item criteria

Gets the item based criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an item based criteria.

{
  • "id": 2,
  • "name": "Similar items",
  • "criteriaGroup": "ITEM",
  • "type": "BOUGHT_CF",
  • "key": "CURRENT",
  • "aggregation": "NONE",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 1,
  • "partialDesignAllowed": false,
  • "backupDisabled": true,
  • "excludePurchases": false,
  • "enableCaching": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Edit item criteria

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

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Item based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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, last viewed item, for instance, then continues to next last viewed item by visitor until the design is filled.
  • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, last purchased item, for instance, has enough recommendations to fill the design. If the key does not have enough recommendations, second to last purchased item by visitor is considered and so forth until the design is filled.

If the key is CURRENT, only NONE is valid.

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.

required
object (CriteriaItemConfiguration)

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 from recommendations.

key
required
string
Enum: "CURRENT" "LAST_VIEWED" "LAST_PURCHASED" "MOST_VIEWED"

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.
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: "VIEWED_BOUGHT" "BOUGHT_CF" "VIEWED_CF" "SITE_AFFINITY" "SIMILARITY"

Recommendation logic. Values:

  • VIEWED_BOUGHT: People who viewed this, bought that.
  • BOUGHT_CF: People who bought this, bought that.
  • VIEWED_CF: People who viewed this, viewed that.
  • SITE_AFFINITY: Considers items based on the certainty of a relationship between items. Confidence setting is used to determine how much data (strong or weak affinity) is required before a recommendation is presented.
  • SIMILARITY: Considers items similar to items based on current page activity or past visitor behavior.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an item based criteria to be created/updated.

{
  • "name": "Items after buying road bike",
  • "criteriaGroup": "ITEM",
  • "type": "BOUGHT_CF",
  • "key": "CURRENT",
  • "aggregation": "NONE",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 1,
  • "partialDesignAllowed": false,
  • "backupDisabled": false,
  • "excludePurchases": false,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an item based criteria.

{
  • "id": 2,
  • "name": "Similar items",
  • "criteriaGroup": "ITEM",
  • "type": "BOUGHT_CF",
  • "key": "CURRENT",
  • "aggregation": "NONE",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 1,
  • "partialDesignAllowed": false,
  • "backupDisabled": true,
  • "excludePurchases": false,
  • "enableCaching": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Delete item criteria

Deletes the item based criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of an item based criteria.

{
  • "id": 2,
  • "name": "Similar items",
  • "criteriaGroup": "ITEM",
  • "type": "BOUGHT_CF",
  • "key": "CURRENT",
  • "aggregation": "NONE",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 1,
  • "partialDesignAllowed": false,
  • "backupDisabled": true,
  • "excludePurchases": false,
  • "enableCaching": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Popularity Criteria

Popularity Criteria are criteria that generate popular items as recommendations. The recommendation key is top sellers, most viewed items or Analytics product report metric.

More info.

List popularity criteria

Gets all available popularity based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 popularity based criteria.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list": [
    ]
}

Create popularity criteria

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

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Popularity based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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, top seller in this instance, then continues to next top seller until the design is filled.
  • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, most viewed item in this instance, has enough recommendations to fill the design. If the key does not have enough recommendations, next most viewed item is considered sequentially until the design is filled.
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.

object (CriteriaPopularityConfiguration)

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

daysCount
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.

This field can not be used together with hoursCount

hoursCount
integer

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

This field can not be used together with daysCount. Only allowed value 6

excludePurchases
boolean
Default: false

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

key
string

Recommendation key. Values:

  • When type is METRIC, this is a required field. The value is the name of an Analytics report suite metric.
  • When type is SELLERS or VIEWED, this field is only used when creating a top sellers by custom profile attribute/most viewed by custom profile attribute criteria. When creating this criteria type, the value should be set to customProfileAttribute and the profile attribute is set in configuration.
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: "SELLERS" "VIEWED" "METRIC"

Recommendation logic. Values:

  • SELLERS: Top sellers.
  • VIEWED: Most viewed items.
  • METRIC: Considers Analytics product report suite for recommendations.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an popularity based criteria to be created/updated.

{
  • "name": "Garage Top Viewed",
  • "type": "VIEWED",
  • "key": "customProfileAttribute",
  • "aggregation": "NONE",
  • "daysCount": "TWO_DAYS",
  • "minInventory": 2,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a popularity based criteria.

{
  • "id": 9321,
  • "name": "Top sold by region",
  • "criteriaGroup": "POPULARITY",
  • "type": "VIEWED",
  • "key": "customProfileAttribute",
  • "aggregation": "ALL_OR_NOTHING",
  • "daysCount": "ONE_MONTH",
  • "configuration": {
    }
}

Get popularity criteria

Gets the popularity based criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a popularity based criteria.

{
  • "id": 9321,
  • "name": "Top sold by region",
  • "criteriaGroup": "POPULARITY",
  • "type": "VIEWED",
  • "key": "customProfileAttribute",
  • "aggregation": "ALL_OR_NOTHING",
  • "daysCount": "ONE_MONTH",
  • "configuration": {
    }
}

Edit popularity criteria

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

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Popularity based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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, top seller in this instance, then continues to next top seller until the design is filled.
  • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, most viewed item in this instance, has enough recommendations to fill the design. If the key does not have enough recommendations, next most viewed item is considered sequentially until the design is filled.
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.

object (CriteriaPopularityConfiguration)

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

daysCount
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.

This field can not be used together with hoursCount

hoursCount
integer

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

This field can not be used together with daysCount. Only allowed value 6

excludePurchases
boolean
Default: false

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

key
string

Recommendation key. Values:

  • When type is METRIC, this is a required field. The value is the name of an Analytics report suite metric.
  • When type is SELLERS or VIEWED, this field is only used when creating a top sellers by custom profile attribute/most viewed by custom profile attribute criteria. When creating this criteria type, the value should be set to customProfileAttribute and the profile attribute is set in configuration.
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: "SELLERS" "VIEWED" "METRIC"

Recommendation logic. Values:

  • SELLERS: Top sellers.
  • VIEWED: Most viewed items.
  • METRIC: Considers Analytics product report suite for recommendations.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an popularity based criteria to be created/updated.

{
  • "name": "Garage Top Viewed",
  • "type": "VIEWED",
  • "key": "customProfileAttribute",
  • "aggregation": "NONE",
  • "daysCount": "TWO_DAYS",
  • "minInventory": 2,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a popularity based criteria.

{
  • "id": 9321,
  • "name": "Top sold by region",
  • "criteriaGroup": "POPULARITY",
  • "type": "VIEWED",
  • "key": "customProfileAttribute",
  • "aggregation": "ALL_OR_NOTHING",
  • "daysCount": "ONE_MONTH",
  • "configuration": {
    }
}

Delete popularity criteria

Deletes the popularity based criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a popularity based criteria.

{
  • "id": 9321,
  • "name": "Top sold by region",
  • "criteriaGroup": "POPULARITY",
  • "type": "VIEWED",
  • "key": "customProfileAttribute",
  • "aggregation": "ALL_OR_NOTHING",
  • "daysCount": "ONE_MONTH",
  • "configuration": {
    }
}

Profile Attribute Criteria

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.

More info.

List profile attribute criteria

Gets all available profile attribute based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 profile attribute based criteria.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list": [
    ]
}

Create profile attribute criteria

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

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Profile attribute based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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, top seller in this instance, then continues to next top seller until the design is filled.
  • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, most viewed item in this instance, has enough recommendations to fill the design. If the key does not have enough recommendations, next most viewed item is considered sequentially until the design is filled.
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.

required
object (CriteriaProfileAttributeConfiguration)

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 from recommendations.

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: "VIEWED_BOUGHT" "BOUGHT_CF" "VIEWED_CF" "SITE_AFFINITY"

Recommendation logic. Values:

  • VIEWED_BOUGHT: People who viewed this, bought that.
  • BOUGHT_CF: People who bought this, bought that.
  • VIEWED_CF: People who viewed this, viewed that.
  • SITE_AFFINITY: Considers items based on the certainty of a relationship between items. Confidence setting is used to determine how much data (strong or weak affinity) is required before a recommendation is presented.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an profile attribute based criteria to be created/updated.

{
  • "name": "city-bike-recs",
  • "criteriaTitle": "Bike recommendations per city",
  • "type": "VIEWED_CF",
  • "aggregation": "NONE",
  • "daysCount": "ONE_MONTH",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a profile attribute based criteria.

{
  • "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": {
    }
}

Get profile attribute criteria

Gets the profile attribute based criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a profile attribute based criteria.

{
  • "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": {
    }
}

Edit profile attribute criteria

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

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Profile attribute based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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, top seller in this instance, then continues to next top seller until the design is filled.
  • ALL_OR_NOTHING is similar to aggregation but the aggregation only happens if the given key, most viewed item in this instance, has enough recommendations to fill the design. If the key does not have enough recommendations, next most viewed item is considered sequentially until the design is filled.
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.

required
object (CriteriaProfileAttributeConfiguration)

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 from recommendations.

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: "VIEWED_BOUGHT" "BOUGHT_CF" "VIEWED_CF" "SITE_AFFINITY"

Recommendation logic. Values:

  • VIEWED_BOUGHT: People who viewed this, bought that.
  • BOUGHT_CF: People who bought this, bought that.
  • VIEWED_CF: People who viewed this, viewed that.
  • SITE_AFFINITY: Considers items based on the certainty of a relationship between items. Confidence setting is used to determine how much data (strong or weak affinity) is required before a recommendation is presented.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of an profile attribute based criteria to be created/updated.

{
  • "name": "city-bike-recs",
  • "criteriaTitle": "Bike recommendations per city",
  • "type": "VIEWED_CF",
  • "aggregation": "NONE",
  • "daysCount": "ONE_MONTH",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a profile attribute based criteria.

{
  • "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": {
    }
}

Delete profile attribute criteria

Deletes the profile attribute based criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a profile attribute based criteria.

{
  • "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": {
    }
}

Recent Criteria

Recent Criteria are criteria based on recently viewed items.

More info.

List recent criteria

Gets all available recent view based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 2 recent view based criteria.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 2,
  • "list": [
    ]
}

Create recent criteria

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

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Recent view based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
object (CriteriaRecentConfiguration)

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

minInventory
integer <int32> >= 0

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

excludePurchases
boolean
Default: false

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

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a recent view based criteria to be created/updated.

{
  • "name": "Recently Viewed Products",
  • "criteriaTitle": "Just Seen Items",
  • "excludePurchases": true,
  • "criteriaGroup": "RECENT",
  • "minInventory": 3,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a recent view based criteria.

{
  • "id": 2,
  • "name": "Recently Viewed in Same Brand",
  • "criteriaGroup": "RECENT",
  • "excludePurchases": true,
  • "minInventory": 1,
  • "configuration": {
    }
}

Get recent criteria

Gets the recent criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a recent view based criteria.

{
  • "id": 2,
  • "name": "Recently Viewed in Same Brand",
  • "criteriaGroup": "RECENT",
  • "excludePurchases": true,
  • "minInventory": 1,
  • "configuration": {
    }
}

Edit recent criteria

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

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Recent view based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
object (CriteriaRecentConfiguration)

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

minInventory
integer <int32> >= 0

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

excludePurchases
boolean
Default: false

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

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a recent view based criteria to be created/updated.

{
  • "name": "Recently Viewed Products",
  • "criteriaTitle": "Just Seen Items",
  • "excludePurchases": true,
  • "criteriaGroup": "RECENT",
  • "minInventory": 3,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a recent view based criteria.

{
  • "id": 2,
  • "name": "Recently Viewed in Same Brand",
  • "criteriaGroup": "RECENT",
  • "excludePurchases": true,
  • "minInventory": 1,
  • "configuration": {
    }
}

Delete recent criteria

Deletes the recent view based criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a recent view based criteria.

{
  • "id": 2,
  • "name": "Recently Viewed in Same Brand",
  • "criteriaGroup": "RECENT",
  • "excludePurchases": true,
  • "minInventory": 1,
  • "configuration": {
    }
}

Sequence Criteria

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.

More info.

List sequence criteria

Gets all available sequence criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 2 sequence criteria.

{
  • "offset": 0,
  • "limit": 2147483647,
  • "total": 3,
  • "list": [
    ]
}

Create sequence criteria

Creates a new sequence criteria as specified by the settings, and single criteria IDs provided and returns the newly created criteria definition.

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Sequence criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

partialDesignAllowed
boolean
Default: false

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

required
Array of objects [ 1 .. 5 ] items

Criteria sequence represented by an array of criteria object IDs.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a sequence criteria to be created/updated.

{
  • "name": "Top Dashboard Items",
  • "criteriaTitle": "Top Dashboard Items",
  • "backupDisabled": true,
  • "sequence": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a sequence criteria.

{
  • "id": 56,
  • "name": "Top Dashboard Items",
  • "criteriaTitle": "Top Dashboard Items",
  • "criteriaGroup": "SEQUENCE",
  • "backupDisabled": true,
  • "sequence": [
    ]
}

Get sequence criteria

Gets the sequence criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a sequence criteria.

{
  • "id": 56,
  • "name": "Top Dashboard Items",
  • "criteriaTitle": "Top Dashboard Items",
  • "criteriaGroup": "SEQUENCE",
  • "backupDisabled": true,
  • "sequence": [
    ]
}

Edit sequence criteria

Updates the sequence criteria with new settings and new single criteria IDs as specified and returns the updated criteria definition.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

Sequence criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

partialDesignAllowed
boolean
Default: false

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

required
Array of objects [ 1 .. 5 ] items

Criteria sequence represented by an array of criteria object IDs.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a sequence criteria to be created/updated.

{
  • "name": "Top Dashboard Items",
  • "criteriaTitle": "Top Dashboard Items",
  • "backupDisabled": true,
  • "sequence": [
    ]
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a sequence criteria.

{
  • "id": 56,
  • "name": "Top Dashboard Items",
  • "criteriaTitle": "Top Dashboard Items",
  • "criteriaGroup": "SEQUENCE",
  • "backupDisabled": true,
  • "sequence": [
    ]
}

Delete sequence criteria

Deletes the sequence criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a sequence criteria.

{
  • "id": 56,
  • "name": "Top Dashboard Items",
  • "criteriaTitle": "Top Dashboard Items",
  • "criteriaGroup": "SEQUENCE",
  • "backupDisabled": true,
  • "sequence": [
    ]
}

User History Criteria

User History Criteria are criteria based on visitor's browsing, viewing or purchasing history. It is generally referred to as "Recommended for You".

More info.

List user history criteria

Gets all available user history based criteria.

Authorizations:
BearerTokenApiKey
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

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a list containing 3 user history criteria.

{
  • "offset": 2,
  • "limit": 2147483647,
  • "total": 3,
  • "list": [
    ]
}

Create user history criteria

Creates a new user history based criteria as specified in the request payload and returns the newly created user history definition.

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

UserHistory based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

object (CriteriaUserHistoryConfiguration)
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 from recommendations.

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.

excludeViews
boolean
Default: false

Whether items that were previously viewed by the visitor should be excluded from recommendations.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a user history based criteria to be created/updated.

{
  • "name": "Recommend for you.",
  • "criteriaTitle": "Recommend for you with Inclusion Rules",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "excludeViews": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a user history based criteria.

{
  • "id": 3,
  • "name": "Recommend for you.",
  • "criteriaTitle": "Recommend for you with Inclusion Rules",
  • "criteriaGroup": "USERHISTORY",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "excludeViews": false,
  • "configuration": {
    }
}

Get user history criteria

Gets the user history based criteria with the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a user history based criteria.

{
  • "id": 3,
  • "name": "Recommend for you.",
  • "criteriaTitle": "Recommend for you with Inclusion Rules",
  • "criteriaGroup": "USERHISTORY",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "excludeViews": false,
  • "configuration": {
    }
}

Edit user history criteria

Updates the user history based criteria with new data as specified in request payload and returns the updated criteria definition.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>
Request Body schema: application/vnd.adobe.target.v1+json

UserHistory based criteria to be created/updated

criteriaTitle
string <= 250 characters

Displayed in the design using variable $criteria.title.

name
required
string <= 250 characters

Unique name of the criteria.

description
string <= 1000 characters
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.

object (CriteriaUserHistoryConfiguration)
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 from recommendations.

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.

excludeViews
boolean
Default: false

Whether items that were previously viewed by the visitor should be excluded from recommendations.

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json

A request body example of a user history based criteria to be created/updated.

{
  • "name": "Recommend for you.",
  • "criteriaTitle": "Recommend for you with Inclusion Rules",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "excludeViews": true,
  • "configuration": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a user history based criteria.

{
  • "id": 3,
  • "name": "Recommend for you.",
  • "criteriaTitle": "Recommend for you with Inclusion Rules",
  • "criteriaGroup": "USERHISTORY",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "excludeViews": false,
  • "configuration": {
    }
}

Delete user history criteria

Deletes the user history based criteria referenced by the given ID.

Authorizations:
BearerTokenApiKey
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8

A response body example of a user history based criteria.

{
  • "id": 3,
  • "name": "Recommend for you.",
  • "criteriaTitle": "Recommend for you with Inclusion Rules",
  • "criteriaGroup": "USERHISTORY",
  • "daysCount": "TWO_WEEKS",
  • "minInventory": 5,
  • "partialDesignAllowed": true,
  • "backupDisabled": false,
  • "excludePurchases": true,
  • "backupInclusionFilteringEnabled": true,
  • "excludeViews": false,
  • "configuration": {
    }
}

Searching Entities

Search Catalog Entities

Searches across all the entities in a given client and environment based on provided match criteria.

Note this POST request does not create any resource. The endpoint is not a resource but rather it is simply a method for searching.

Authorizations:
BearerTokenApiKey
Request Body schema: application/vnd.adobe.target.v1+json

Catalog Search

required
object (SearchMeta)
required
simple double (object) or simple integer (object) or simple string (object) or compound search (object) (SearchQuery)

Responses

Request samples

Content type
application/vnd.adobe.target.v1+json
Example
{
  • "meta": {
    },
  • "query": {
    }
}

Response samples

Content type
application/vnd.adobe.target.v1+json;charset=UTF-8
{
  • "timeMs": 1701,
  • "hits": [
    ],
  • "start": 1
}