Experience
API for creating and managing Experiences as well as all related and/or dependent models such as but not limited to Groups, Templates, Candidates, etc.
List
https://api.lytics.io/api/experienceEndpoint 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.
Query Parameters
account_idoptionalstringlimitoptionalstringExample:
10provideroptionalstringExample:
65b80b0a8e0544aa8144022b3c085da1deletedoptionalstringExample:
trueHeaders
AuthorizationoptionalstringOK
Create
https://api.lytics.io/api/experienceEndpoint creates a single Experience record.
__Sideloading__
- None
__Required Fields__
- label
- vehicle.provider_id
- vehicle.tactic
Headers
AuthorizationoptionalstringCreated
Fetch
https://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.
URL Parameters
idrequiredstringExample:
76c7115c492e78cfd12f30a7389919bbQuery Parameters
account_idoptionalstringdeletedoptionalstringExample:
trueHeaders
AuthorizationoptionalstringOK
Update
https://api.lytics.io/api/experience/{id}Endpoint updates a single Experience record.
__Sideloading__: None
URL Parameters
idrequiredstringExample:
76c7115c492e78cfd12f30a7389919bbQuery Parameters
account_idoptionalstringupdate_stateoptionalstringExample:
trueHeaders
AuthorizationoptionalstringOK
Delete
https://api.lytics.io/api/experience/{id}Removes an Experience record.
URL Parameters
idrequiredstringExample:
96d774bca4ac26c92aa323b246a148fdQuery Parameters
account_idoptionalstringmethodoptionalstringExample:
hardrecursiveoptionalstringExample:
trueHeaders
AuthorizationoptionalstringNo Content
Fetch
https://api.lytics.io/api/experience/importRequest a list of importable Experiences from a third party provider such as Facebook or Iterable.
Query Parameters
account_idoptionalstringprovider_slugrequiredstringExample:
facebookauth_idrequiredstringExample:
7391398335174372b3aecd83c5a5d292include_existingoptionalstringExample:
trueHeaders
AuthorizationoptionalstringOK
Create
https://api.lytics.io/api/experience/importCreates 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
Headers
AuthorizationoptionalstringCreated
List
https://api.lytics.io/api/experience/templateFetches all Experience templates available to provided authorization token.
Headers
AuthorizationoptionalstringOK
Create
https://api.lytics.io/api/experience/templateCreates an Experience template.
__Required Fields__
- all
- see experience or group for nested requirements
Headers
AuthorizationoptionalstringCreated
Fetch
https://api.lytics.io/api/experience/template/{id}Fetches an Experience template by id.
URL Parameters
idrequiredstringExample:
864a26fd5d5148b0b7fa187828368b81Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringOK
Update
https://api.lytics.io/api/experience/template/{id}Updates an Experience template.
URL Parameters
idrequiredstringExample:
864a26fd5d5148b0b7fa187828368b81Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringOK
Delete
https://api.lytics.io/api/experience/template/{id}Removes an Experience template.
URL Parameters
idrequiredstringExample:
864a26fd5d5148b0b7fa187828368b81Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringNo Content
List
https://api.lytics.io/api/experience/candidateFetches all Experience candidate records available to token.
Headers
AuthorizationoptionalstringOK
Preview Config
https://api.lytics.io/api/experience/preview/{accountid}/{id}/config.jsRenders a JavaScript file containing a single Experiences Pathfora configuration for previewing a web personalize Experience.
URL Parameters
accountidrequiredstringExample:
864a26fd5d5148b0b7fa187828368b81idrequiredstringExample:
864a26fd5d5148b0b7fa187828368b81Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringOK
Production Config
https://api.lytics.io/api/experience/candidate/{accountid}/config.jsRenders a JavaScript file containing all published Experiences Candidate Pathfora configurations.
URL Parameters
accountidrequiredstringExample:
864a26fd5d5148b0b7fa187828368b81Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringOK
List
https://api.lytics.io/api/experience/groupFetches all Experience Group records available to the authorization token.
Query Parameters
account_idoptionalstringlimitoptionalstringExample:
10deletedoptionalstringExample:
trueHeaders
AuthorizationoptionalstringOK
Create
https://api.lytics.io/api/experience/groupCreates 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.
Headers
AuthorizationoptionalstringFetch
https://api.lytics.io/api/experience/group/{id}Fetches an Experience Group record by id.
URL Parameters
idrequiredstringExample:
ef9154b3a5f982e1bd4ec0230664b57cQuery Parameters
account_idoptionalstringdeletedoptionalstringExample:
trueHeaders
AuthorizationoptionalstringOK
Update
https://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.
URL Parameters
idrequiredstringExample:
ef9154b3a5f982e1bd4ec0230664b57cQuery Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringDelete
https://api.lytics.io/api/experience/group/{id}Removes an Experience Group record.
URL Parameters
idrequiredstringExample:
ef9154b3a5f982e1bd4ec0230664b57cQuery Parameters
account_idoptionalstringmethodoptionalstringExample:
hardrecursiveoptionalstringExample:
trueHeaders
AuthorizationoptionalstringNo Content
List
https://api.lytics.io/api/experience/prioritizationFetches all prioritization records available to token.
Headers
AuthorizationoptionalstringOK
Create
https://api.lytics.io/api/experience/prioritizationCreates a prioritization record.
__Required Fields__
- all
Headers
AuthorizationoptionalstringCreated
Fetch
https://api.lytics.io/api/experience/prioritization/{id}Fetches a prioritization record by id.
URL Parameters
idrequiredstringExample:
87cb58050ad27cd539935d8e3838f239Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringOK
Update
https://api.lytics.io/api/experience/prioritization/{id}Updates a prioritization record.
URL Parameters
idrequiredstringExample:
87cb58050ad27cd539935d8e3838f239Query Parameters
account_idoptionalstringHeaders
AuthorizationoptionalstringOK
Delete
https://api.lytics.io/api/experience/prioritization/{id}Removes a prioritization record.
URL Parameters
idrequiredstringExample:
87cb58050ad27cd539935d8e3838f239Query Parameters
account_idoptionalstringmethodoptionalstringExample:
hardHeaders
AuthorizationoptionalstringNo Content
Master Group Priority
https://api.lytics.io/api/experience/group/priorityManages the unique top level Journey priority record for an account. Used only for managing hierarchy of Experience Groups classified as Journeys in the UI.
Headers
AuthorizationoptionalstringOK