Resources

path methods description
  • /v1/audit/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/auth/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/dp/tenant
  • POST
Live Experience REST APIs. URI: /v1/*
  • /v1/dp/tenant/{tenant}
  • DELETE PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}
  • GET POST
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}/reorder
  • PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}/{scenarioName}
  • DELETE GET PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}/{scenarioName}/enable/{enable}
  • PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagements/count/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/engagements/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/engagements/{tenant}/{id}
  • DELETE
Live Experience REST APIs. URI: /v1/*
  • /v1/metrics/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/users/{tenant}
  • GET POST
Live Experience REST APIs. URI: /v1/*
  • /v1/users/{tenant}/{email}
  • DELETE GET PUT
Live Experience REST APIs. URI: /v1/*

Data Types

JSON

type description
AccessTokenResponseV1 Model class for access token response.
ApiResponseV1 Model class for create user response.
AuditRecordV1 Model class representing an audit record.
BaseModel A base class for Search and Retrieval model objects.
BehavioursV1 Model class for engagement scenario behaviours.
ConfigurationV1 Model class for engagement scenario message.
ContextMetricsV1 Model class for Context Metric.
EngagementListV1 Model class for Engagements List.
EngagementScenarioConditionV1 Model calss for engagement scenario condition.
EngagementScenarioConfigurationV1 Model class for engagement scenario configuation.
EngagementScenarioListV1 Model class for EngagementScenario list.
EngagementScenarioRuleV1 Model class for engagement scenario rule.
EngagementScenarioV1 Model class for EngagementScenario.
EngagementUserV1 Model class for engagement user.
EngagementV1 Model class for engagement.
Entitlement Model sub class for entitlement.
MediaOption Enum of Media Option.
MessageV1 Model class for engagement scenario message.
MetricsListV1 Model class for Metrics List.
MetricsV1 Model class for report metrics.
Operation Operation enum.
PerUserMetricsV1 A user (associate) uri and associated metrics.
QualityMetricsV1 Model class for Quality Metric.
RecordingV1 Model class for recording data contained within an engagement.
RuleType enum RuleType.
SIContextV1 Model class for service instance context required for tenant provisioning.
SIPropertiesV1 Model class for properties of service instance provisioned tenant.
SIServiceV1 Model class for retrieving provisioned service instance.
SSOConfigV1 Model class for SSO configuration.
SeatType Valid Live Experience seat license types.
ServiceInstanceV1 Model class for service instance provisioning.
ServiceState Possible service states.
SubTenantV1 Model class for sub-tenant.
UserListV1 Model class for Users list.
UserV1 Model class for user.

XML

Default Namespace
type description
accessTokenResponseV1 Model class for access token response.
apiResponseV1 Model class for create user response.
contextMetrics Model class for Context Metric.
engagementListV1 Model class for Engagements List.
engagementScenarioConfigurationV1 Model class for engagement scenario configuation.
behavioursV1 Model class for engagement scenario behaviours.
configurationV1 Model class for engagement scenario message.
mediaOption Enum of Media Option.
messageV1 Model class for engagement scenario message.
engagementScenarioListV1 Model class for EngagementScenario list.
engagementScenarioRuleV1 Model class for engagement scenario rule.
engagementScenarioConditionV1 Model calss for engagement scenario condition.
operation Operation enum.
ruleType enum RuleType.
engagementScenarioV1 Model class for EngagementScenario.
engagementUserV1 Model class for engagement user.
engagementV1 Model class for engagement.
metricsListV1 Model class for Metrics List.
metricsV1 Model class for report metrics.
users A user (associate) uri and associated metrics.
qualityMetricsV1 Model class for Quality Metric.
recordingV1 Model class for recording data contained within an engagement.
SIContextV1 Model class for service instance context required for tenant provisioning.
entitlement Model sub class for entitlement.
SIParametersV1 Model class for service instance parameters required to provision a tenant.
internalSku Valid Live Experience internal sku names for mapping feature sets.
seatType Valid Live Experience seat license types.
SIPropertiesV1 Model class for properties of service instance provisioned tenant.
SIServiceV1 Model class for retrieving provisioned service instance.
serviceState Possible service states.
SSOConfigV1 Model class for SSO configuration.
serviceInstanceV1 Model class for service instance provisioning.
subTenantV1 Model class for sub-tenant.
userListV1 Model class for Users list.
userV1 Model class for user.
auditRecordV1 Model class representing an audit record.
baseModel A base class for Search and Retrieval model objects.