Lytics API | Experience

List

GEThttps://api.lytics.io/api/experience

Endpoint fetches all Experience records available to provided authorization token as well as various side-loaded dependencies.

__Sideloading__: A variety of dependent or associated data will be side-loaded as part of the primary request. The list of side-loaded data for this particular request is:

- All available Experience templates.

- All parent groups one branch up the tree for returned Experiences.

Hide Parameters

Query Parameters

account_idoptionalstring

Your Lytics account ID.

limitoptionalstring

limit the number of Experience records returned

Example:

10

provideroptionalstring

id of provider to filter results by

Example:

65b80b0a8e0544aa8144022b3c085da1

deletedoptionalstring

include soft deleted Experiences

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Create

POSThttps://api.lytics.io/api/experience

Endpoint creates a single Experience record.

__Sideloading__

- None

__Required Fields__

- label

- vehicle.provider_id

- vehicle.tactic

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|201 Created

Created

Fetch

GEThttps://api.lytics.io/api/experience/{id}

Endpoint fetches a single Experience record by id as well as various side-loaded dependencies.

__Sideloading__: A variety of dependent or associated data will be side-loaded as part of the primary request. The list of side-loaded data for this particular request is:

- All parent groups all the way up the family tree for the Experience.

Hide Parameters

URL Parameters

idrequiredstring

id of the experience. if orphan is passed as Experience it will list all Experiences with no parent.

Example:

76c7115c492e78cfd12f30a7389919bb

Query Parameters

account_idoptionalstring

Your Lytics account ID.

deletedoptionalstring

include soft deleted Experiences

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Update

PATCHhttps://api.lytics.io/api/experience/{id}

Endpoint updates a single Experience record.

__Sideloading__: None

Hide Parameters

URL Parameters

idrequiredstring

id of the experience. if orphan is passed as Experience it will list all Experiences with no parent.

Example:

76c7115c492e78cfd12f30a7389919bb

Query Parameters

account_idoptionalstring

Your Lytics account ID.

update_stateoptionalstring

allow the state of the Experience to be altered, all other changes will be thrown out of this request when flag is true.

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Delete

DELETEhttps://api.lytics.io/api/experience/{id}

Removes an Experience record.

Hide Parameters

URL Parameters

idrequiredstring

id of the Experience

Example:

96d774bca4ac26c92aa323b246a148fd

Query Parameters

account_idoptionalstring

Your Lytics account ID.

methodoptionalstring

method to be used for deletion. hard deletes permanently and is unrecoverable. soft is default and deletes with ability to be recovered.

Example:

hard

recursiveoptionalstring

recursive delete will also delete all downstream dependencies.

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|204 No Content

No Content

Fetch

GEThttps://api.lytics.io/api/experience/import

Request a list of importable Experiences from a third party provider such as Facebook or Iterable.

Hide Parameters

Query Parameters

account_idoptionalstring

Your Lytics account ID.

provider_slugrequiredstring

slug of provider to fetch Experiences from

Example:

facebook

auth_idrequiredstring

id of the authorization for the requested provider

Example:

7391398335174372b3aecd83c5a5d292

include_existingoptionalstring

should the response include Experiences already imported

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Create

POSThttps://api.lytics.io/api/experience/import

Creates Experiences in a batch based on valid Experience import records. This endpoint should be used exclusively with the results from the Experience import GET and not leveraged as a bulk Experience create.

__Required Fields__

- all

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|201 Created

Created

List

GEThttps://api.lytics.io/api/experience/template

Fetches all Experience templates available to provided authorization token.

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Create

POSThttps://api.lytics.io/api/experience/template

Creates an Experience template.

__Required Fields__

- all

- see experience or group for nested requirements

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|201 Created

Created

Fetch

GEThttps://api.lytics.io/api/experience/template/{id}

Fetches an Experience template by id.

Hide Parameters

URL Parameters

idrequiredstring

id of the template

Example:

864a26fd5d5148b0b7fa187828368b81

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Update

PATCHhttps://api.lytics.io/api/experience/template/{id}

Updates an Experience template.

Hide Parameters

URL Parameters

idrequiredstring

id of the template

Example:

864a26fd5d5148b0b7fa187828368b81

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Delete

DELETEhttps://api.lytics.io/api/experience/template/{id}

Removes an Experience template.

Hide Parameters

URL Parameters

idrequiredstring

id of the template

Example:

864a26fd5d5148b0b7fa187828368b81

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|204 No Content

No Content

List

GEThttps://api.lytics.io/api/experience/candidate

Fetches all Experience candidate records available to token.

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Preview Config

GEThttps://api.lytics.io/api/experience/preview/{accountid}/{id}/config.js

Renders a JavaScript file containing a single Experiences Pathfora configuration for previewing a web personalize Experience.

Hide Parameters

URL Parameters

accountidrequiredstring

id of the account

Example:

864a26fd5d5148b0b7fa187828368b81

idrequiredstring

id of the experience

Example:

864a26fd5d5148b0b7fa187828368b81

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Production Config

GEThttps://api.lytics.io/api/experience/candidate/{accountid}/config.js

Renders a JavaScript file containing all published Experiences Candidate Pathfora configurations.

Hide Parameters

URL Parameters

accountidrequiredstring

id of the account

Example:

864a26fd5d5148b0b7fa187828368b81

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

List

GEThttps://api.lytics.io/api/experience/group

Fetches all Experience Group records available to the authorization token.

Hide Parameters

Query Parameters

account_idoptionalstring

Your Lytics account ID.

limitoptionalstring

limit number of returned experience_group records

Example:

10

deletedoptionalstring

include soft deleted records

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Create

POSThttps://api.lytics.io/api/experience/group

Creates an Experience Group record.

__Required Fields__

- label

- class

__Note__: When creating a new Experience group you have the option of including either a set of nested Experiences or groups, not both, that belong to the new group. As a result, a prioritization record will be created in addition to each individual group or Experience itself being updated with the proper parent_group_id value. Likewise, passing an empty array __WILL REMOVE__ the ownership from the existing children. When no change is intended for nested Experiences or groups you should pass no value or null for both experiences and child_groups.

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|201 Created

Created

Fetch

GEThttps://api.lytics.io/api/experience/group/{id}

Fetches an Experience Group record by id.

Hide Parameters

URL Parameters

idrequiredstring

id of the group

Example:

ef9154b3a5f982e1bd4ec0230664b57c

Query Parameters

account_idoptionalstring

Your Lytics account ID.

deletedoptionalstring

include soft deleted records

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Update

PATCHhttps://api.lytics.io/api/experience/group/{id}

Updates an Experience Group record.

__Note__: When updating an existing Experience group you have the option of including either a set of nested Experiences or groups, not both, that belong to the new group. As a result, a prioritization record will be created in addition to each individual group or Experience itself being updated with the proper parent_group_id value. Likewise, passing an empty array __WILL REMOVE__ the ownership from the existing children. When no change is intended for nested Experiences or groups you should pass no value or null for both experiences and child_groups.

Hide Parameters

URL Parameters

idrequiredstring

id of the group

Example:

ef9154b3a5f982e1bd4ec0230664b57c

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Delete

DELETEhttps://api.lytics.io/api/experience/group/{id}

Removes an Experience Group record.

Hide Parameters

URL Parameters

idrequiredstring

id of the group

Example:

ef9154b3a5f982e1bd4ec0230664b57c

Query Parameters

account_idoptionalstring

Your Lytics account ID.

methodoptionalstring

method to be used for deletion. hard deletes permanently and is unrecoverable. soft is default and deletes with ability to be recovered.

Example:

hard

recursiveoptionalstring

recursive delete will also delete all downstream dependencies.

Example:

true

Headers

Authorizationoptionalstring

Sample Response

Status|204 No Content

No Content

List

GEThttps://api.lytics.io/api/experience/prioritization

Fetches all prioritization records available to token.

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Create

POSThttps://api.lytics.io/api/experience/prioritization

Creates a prioritization record.

__Required Fields__

- all

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|201 Created

Created

Fetch

GEThttps://api.lytics.io/api/experience/prioritization/{id}

Fetches a prioritization record by id.

Hide Parameters

URL Parameters

idrequiredstring

id of the prioritization record

Example:

87cb58050ad27cd539935d8e3838f239

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Update

PATCHhttps://api.lytics.io/api/experience/prioritization/{id}

Updates a prioritization record.

Hide Parameters

URL Parameters

idrequiredstring

id of the prioritization record

Example:

87cb58050ad27cd539935d8e3838f239

Query Parameters

account_idoptionalstring

Your Lytics account ID.

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK

Delete

DELETEhttps://api.lytics.io/api/experience/prioritization/{id}

Removes a prioritization record.

Hide Parameters

URL Parameters

idrequiredstring

id of the prioritization record

Example:

87cb58050ad27cd539935d8e3838f239

Query Parameters

account_idoptionalstring

Your Lytics account ID.

methodoptionalstring

method to be used for deletion. hard deletes permanently and is unrecoverable. soft is default and deletes with ability to be recovered.

Example:

hard

Headers

Authorizationoptionalstring

Sample Response

Status|204 No Content

No Content

Master Group Priority

POSThttps://api.lytics.io/api/experience/group/priority

Manages the unique top level Journey priority record for an account. Used only for managing hierarchy of Experience Groups classified as Journeys in the UI.

Hide Parameters

Headers

Authorizationoptionalstring

Sample Response

Status|200 OK

OK