Adobe  I/O

Adobe Target

List activities

GET /{tenant}/target/activities
Get a list of AB and Experience Targeted activities created in Target, with the ability to filter and sort by attributes.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
parameters (required) Query Parameter — Undefined

Create an AB activity

POST /{tenant}/target/activities/ab
Creates a new AB activity with the specified contents and returns the created activity.
REQUEST BODY
abActivity (required) Body Parameter — ABActivity
RESPONSES
201 Created
400 There was an error creating the AB activity. Most probably invalid data was provided by the user.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.

Get AB activity by id

GET /{tenant}/target/activities/ab/{id}
Fetch the current definition of a AB activity if it is found as referenced by the id.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Update an AB activity

PUT /{tenant}/target/activities/ab/{id}
Updates the AB activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.
REQUEST BODY
abActivity (required) Body Parameter — ABActivity
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Delete an AB activity

DELETE /{tenant}/target/activities/ab/{id}
Deletes the activity that is referenced by the id, if it is found.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
204 No Content
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Rename an AB activity

PUT /{tenant}/target/activities/ab/{id}/name
Updates the name of the AB activity that is referenced by the supplied id.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Change priority for AB activity

PUT /{tenant}/target/activities/ab/{id}/priority
Change priority for the AB activity that is referenced by the supplied id.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

AB activity performance report

GET /{tenant}/target/activities/ab/{id}/report/performance
Retrieve the performance report data for the AB activity referenced by the provided id.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer
parameters (required) Query Parameter — Undefined

Update the an AB activity's schedule

PUT /{tenant}/target/activities/ab/{id}/schedule
Update the startsAt and endsAt fields of the AB activity referenced by the provided id.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Update state for an AB activity

PUT /{tenant}/target/activities/ab/{id}/state
Update state for the AB activity that is referenced by the provided id.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Create a Behavior Targeted activity

POST /{tenant}/target/activities/abt
Creates a new Behavior Targeted activity with the specified contents and returns the created activity.
REQUEST BODY
abtActivity (required) Body Parameter — ABTActivity
RESPONSES
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.

Get Behavior Targeted activity by id

GET /{tenant}/target/activities/abt/{id}
Fetch the current definition of a Behavior Targeted activity if it is found as referenced by the id.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Create a Behavior Targeted activity

PUT /{tenant}/target/activities/abt/{id}
Creates a new Behavior Targeted activity with the specified contents and returns the created activity.
REQUEST BODY
abtActivity (required) Body Parameter — ABTActivity
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Delete an Behavior Targeted activity

DELETE /{tenant}/target/activities/abt/{id}
Deletes the Behavior Targeted activity that is referenced by the id, if it is found.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
204 No Content
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Behavior Targeted activity performance report

GET /{tenant}/target/activities/abt/{id}/report/performance
Retrieve the performance report data for the Behavior Targeted activity referenced by the provided id.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer
parameters (required) Query Parameter — Undefined

Create a XT activity

POST /{tenant}/target/activities/xt
Create an Experience Targeted activity based on the provided contents.
REQUEST BODY
abActivity (required) Body Parameter — ABActivity
RESPONSES
201 Created
400 There was an error creating the Experience Targeted activity. Most probably invalid data was provided by the user.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.

Get a XT activity by id

GET /{tenant}/target/activities/xt/{id}
Gets a Experience Targeted activity that is referenced by the id.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Update a XT activity

PUT /{tenant}/target/activities/xt/{id}
Updates the Experience Targeted activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.
REQUEST BODY
abActivity (required) Body Parameter — ABActivity
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Delete a XT activity

DELETE /{tenant}/target/activities/xt/{id}
Delete a Experience Targeted activity.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
204 No Content
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Rename a XT activity

PUT /{tenant}/target/activities/xt/{id}/name
Rename a Experience Targeted activity.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Change priority for an XT activity

PUT /{tenant}/target/activities/xt/{id}/priority
Change priority for the Experience Targeted activity.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

XT activity performance report

GET /{tenant}/target/activities/xt/{id}/report/performance
Retrieve the performance report data for the Experience activity referenced by the provided id.
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer
parameters (required) Query Parameter — Undefined

Update schedule of an XT activity

PUT /{tenant}/target/activities/xt/{id}/schedule
Update the startsAt and endsAt fields of an Experience Targeted activity.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Update state for an XT activity

PUT /{tenant}/target/activities/xt/{id}/state
Update the state for the Experience Targeted activity.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

List activity changelog

GET /{tenant}/target/activities/{id}/changelog
documentation.notes.activities.changelog.getChangelog
RETURN TYPE
RESPONSES
200 OK
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer
parametersMap (required) Query Parameter — Undefined

Rename an activity

PUT /{tenant}/target/activities/{id}/name
Rename an activity. This change will be reflected on the Target user interface after the next refresh.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Change priority for an activity

PUT /{tenant}/target/activities/{id}/priority
Changes the priority for an activity, which will affect the way Target will evaluate the activity selection at runtime.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Update the schedule of an activity

PUT /{tenant}/target/activities/{id}/schedule
Update the startsAt and endsAt fields of an activity which controls when the activity goes live.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer

Update state for an activity

PUT /{tenant}/target/activities/{id}/state
Update state for an activity. Allowed states are approved, deactivated, deleted, paused, saved.
REQUEST BODY
activityDescription (required) Body Parameter — ActivityDescription
RETURN TYPE
RESPONSES
200 OK
201 Created
400 Bad Request. Most probably the data provided in the request is invalid.
401 The user is not allowed to perform this operation.
403 Access to this resource is forbidden.
404 The referenced resource was not found.
PARAMETERS
id (required) Path Parameter — integer