Phoenix Analytics

User engagement and behavioral insight

Action

Actions are instances of Action Types and are triggered by Events

Properties

Name Type Description
IdSystem.Int32 the primary Identifier of Action[queryable][sortable]
TriggerIdSystem.Int32 the Trigger for which this Action belongs to[queryable][required]
ActionTypeIdSystem.Int32 the type of Action[queryable][required]
DescriptionSystem.String a label for this Action[queryable][sortable]
ConfigurationSystem.Stringthe XML configuration expressing the required parameters to perform the Action
TargetIdSystem.Int32the Id of the object (described in PhoenixIdentity_ResourceId) that is the target of this Action
CreateDateSystem.DateTime UTC date of when this entity was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this entity last modifed
LastTriggeredDateSystem.DateTimeUnavailable
ActionTypeActionTypeNavigation property to ActionType [expandable]

Operations

CreateAction
Creates a new Action objectSoapRestC#
GetAction
Gets a single Action entity by its IdSoapRestC#
ListAction
Returns a paged list of Actions optionally filtered and sortedSoapRestC#
UpdateAction
Updates a list of Action entitiesSoapRestC#

ActionType

Actions can be attached to an Event via a Trigger. Actions can be just about anything from sending an email in Messaging, to creating an article in Syndicate, to performing a HTTP GET on a custom URL.

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the ActionType[queryable][sortable][required]
ActionTypeGroupIdSystem.Int32the group that this Action belongs to[required]
PhoenixIdentity_ResourceIdSystem.Int32The type of Resource within the system that an Action of this ActionType applies to.
PhraseTemplateSystem.Stringthe description of the Action[required]
ReferenceSystem.Stringa unique Reference for this Action Type that can be used by external systems[required]
ProjectIdSystem.Int32The project that this Analytics item belongs to
ActivatorSystem.Stringthe full assembly name and version number relating to the component within the processor to service the action[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
IsClientSideSystem.Boolean whether this type of Action is performed in the client side SDK, rather than within the platform[queryable][required]
ConfigurationModelSystem.StringThe model for configuration of an Action of this ActionType
ActionTypeGroupActionTypeGroupNavigation property to ActionTypeGroup [expandable]

Operations

ListActionType
Returns a paged list of ActionTypes optionally filtered and sortedSoapRestC#

ActionTypeGroup

Each Action belongs to a Group - either a Phoenix module, or an external system

Properties

Name Type Description
IdSystem.Int32 the primary identifier[queryable][sortable][required]
DescriptionSystem.Stringthe name of this group of ActionTypes[required]
ReferenceSystem.Stringa unique Reference for this Category that can be used by external systems[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

DeleteResponse

Properties

Name Type Description

Operations

DeleteAction
Delete a single Action entity by its IdSoapRestC#
DeleteTrigger
Delete a single Trigger entity by its IdSoapRestC#
DeleteWidget
Delete a single Widget entity by its IdSoapRestC#

EventAggregateDTO

Properties

Name Type Description

Operations

ListEventAggregate
Returns a list of events aggregated into a time series interval.SoapRestC#

EventDTO

Properties

Name Type Description

Operations

CreateEvent
Creates an event.SoapRestC#
ListEvent
Returns a list of events.SoapRestC#

EventLog

A log of Events that are performed by Users on objects or on other Users - recording the who, what, where, when and how much.

Properties

Name Type Description
IdSystem.Int32 the primary Identifier[queryable][queryable][sortable][sortable]
ProjectIdSystem.Int32the ProjectId that this Event occurred within
CompanyIdSystem.Int32the Company that this Event occurred within
ProviderIdSystem.Int32the Provider that this Event occurred within
PhoenixIdentity_UserIdSystem.Int32 The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationIdSystem.StringConcatenation of the SessionId and ApplicationId passed into the request
EventParentIdSystem.Int32Whether this Event is a reply to another EventId
TargetIdSystem.Int32 the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
ValueSystem.Doublehow much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParametersList<KeyValuePair<string, string>>optional custom data to log
IpAddressSystem.StringIP Address
ProgressSystem.ByteHow much of the event is completed
StatusDescriptionSystem.StringThe moderation status of this event
SuccessSystem.BooleanIf the event is successful.
IsActiveSystem.Boolean Whether this EventLog is Active or has been revoked[queryable]
CreateDateSystem.DateTime UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationIdSystem.Int32 The Application which recorded the Event[queryable]
ApplicationVersionSystem.String The version of the Application which created the Event.[queryable][sortable]
InstallationIdSystem.String The Id of the Installation that generated the Event[queryable]
DeviceTypeSystem.String The device type of the device which registered the Event[queryable]
OperatingSystemVersionSystem.String The operating system of the device which registered the Event[queryable]
ProjectProjectNavigation property to Project [expandable]
EventTypeEventTypeNavigation property to EventType [expandable]

EventLogAggregateRetrieve

Properties

Name Type Description
EventTypeReferenceSystem.StringThe types of Event that occurred
IdSystem.Int32 the primary Identifier[queryable][queryable][sortable][sortable]
ProjectIdSystem.Int32the ProjectId that this Event occurred within
CompanyIdSystem.Int32the Company that this Event occurred within
ProviderIdSystem.Int32the Provider that this Event occurred within
PhoenixIdentity_UserIdSystem.Int32 The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationIdSystem.StringConcatenation of the SessionId and ApplicationId passed into the request
EventParentIdSystem.Int32Whether this Event is a reply to another EventId
TargetIdSystem.Int32 the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
ValueSystem.Doublehow much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParametersList<KeyValuePair<string, string>>optional custom data to log
IpAddressSystem.StringIP Address
ProgressSystem.ByteHow much of the event is completed
StatusDescriptionSystem.StringThe moderation status of this event
SuccessSystem.BooleanIf the event is successful.
IsActiveSystem.Boolean Whether this EventLog is Active or has been revoked[queryable]
CreateDateSystem.DateTime UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationIdSystem.Int32 The Application which recorded the Event[queryable]
ApplicationVersionSystem.String The version of the Application which created the Event.[queryable][sortable]
InstallationIdSystem.String The Id of the Installation that generated the Event[queryable]
DeviceTypeSystem.String The device type of the device which registered the Event[queryable]
OperatingSystemVersionSystem.String The operating system of the device which registered the Event[queryable]
ProjectProjectNavigation property to Project [expandable]
EventTypeEventTypeNavigation property to EventType [expandable]

EventLogCreate

A log of Events that are performed by Users on objects or on other Users - recording the who, what, where, when and how much.

Properties

Name Type Description
EventTypeRefSystem.StringThe type of action that was performed
LocationSystem.StringThe location that the action occurred. Required format is "latitude, longitude"
GeolocationGeolocationThe location that the action occurred.
IdSystem.Int32 the primary Identifier[queryable][queryable][sortable][sortable]
ProjectIdSystem.Int32the ProjectId that this Event occurred within
CompanyIdSystem.Int32the Company that this Event occurred within
ProviderIdSystem.Int32the Provider that this Event occurred within
PhoenixIdentity_UserIdSystem.Int32 The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationIdSystem.StringConcatenation of the SessionId and ApplicationId passed into the request
EventParentIdSystem.Int32Whether this Event is a reply to another EventId
TargetIdSystem.Int32 the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
ValueSystem.Doublehow much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParametersList<KeyValuePair<string, string>>optional custom data to log
IpAddressSystem.StringIP Address
ProgressSystem.ByteHow much of the event is completed
StatusDescriptionSystem.StringThe moderation status of this event
SuccessSystem.BooleanIf the event is successful.
IsActiveSystem.Boolean Whether this EventLog is Active or has been revoked[queryable]
CreateDateSystem.DateTime UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationIdSystem.Int32 The Application which recorded the Event[queryable]
ApplicationVersionSystem.String The version of the Application which created the Event.[queryable][sortable]
InstallationIdSystem.String The Id of the Installation that generated the Event[queryable]
DeviceTypeSystem.String The device type of the device which registered the Event[queryable]
OperatingSystemVersionSystem.String The operating system of the device which registered the Event[queryable]
ProjectProjectNavigation property to Project [expandable]
EventTypeEventTypeNavigation property to EventType [expandable]

EventLogRetrieve

Properties

Name Type Description
EventTypeIdSystem.Int32the type of action that was performed
LocationSystem.StringThe location that the action occurred. Required format is "latitude, longitude"
GeolocationGeolocationThe Geolocation of the Event that occurred.
IdSystem.Int32 the primary Identifier[queryable][queryable][sortable][sortable]
ProjectIdSystem.Int32the ProjectId that this Event occurred within
CompanyIdSystem.Int32the Company that this Event occurred within
ProviderIdSystem.Int32the Provider that this Event occurred within
PhoenixIdentity_UserIdSystem.Int32 The Id of the Phoenix User who performed the action or had the action performed on them (depending on the context of the action)[queryable]
CorrelationIdSystem.StringConcatenation of the SessionId and ApplicationId passed into the request
EventParentIdSystem.Int32Whether this Event is a reply to another EventId
TargetIdSystem.Int32 the object that the action was performed on. The ActionType determines the class this relates to.[queryable]
ValueSystem.Doublehow much value this action carrier - whether it is 1 view or a rating of 0.8[required]
MetaDataParametersList<KeyValuePair<string, string>>optional custom data to log
IpAddressSystem.StringIP Address
ProgressSystem.ByteHow much of the event is completed
StatusDescriptionSystem.StringThe moderation status of this event
SuccessSystem.BooleanIf the event is successful.
IsActiveSystem.Boolean Whether this EventLog is Active or has been revoked[queryable]
CreateDateSystem.DateTime UTC date of when the Event occurred[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when the EventLog was last changed[queryable][sortable]
ApplicationIdSystem.Int32 The Application which recorded the Event[queryable]
ApplicationVersionSystem.String The version of the Application which created the Event.[queryable][sortable]
InstallationIdSystem.String The Id of the Installation that generated the Event[queryable]
DeviceTypeSystem.String The device type of the device which registered the Event[queryable]
OperatingSystemVersionSystem.String The operating system of the device which registered the Event[queryable]
ProjectProjectNavigation property to Project [expandable]
EventTypeEventTypeNavigation property to EventType [expandable]

Operations

CreateEventLog
Record an event interaction against an object within the systemSoapRestC#
ListEventLog
Returns a paged list of EventLogs optionally filtered and sortedSoapRestC#
UpdateEventLog
Updates an EventLog entitySoapRestC#

EventType

A list of interactive Events performed by users and objects such as Media.Uploaded, User.Created, Article.Agreed

Properties

Name Type Description
IdSystem.Int32 the primary Identier for the Action Type[queryable][sortable]
CompanyIdSystem.Int32  the Company that this EventType belongs to (if a custom Event)[queryable][sortable]
NameSystem.Stringthe Name of the EntityType[required]
DescriptionSystem.Stringa verbose Description of this Event Type
ReferenceSystem.Stringa label that a third party can use to retrieve this EventType by [queryable][sortable][required]
PhoenixIdentity_ResourceIdSystem.Int32Unavailable
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ProjectIdSystem.Int32Unavailable

Operations

CreateEventType
Create a new event type attached to an event logSoapRestC#
ListEventType
Returns a paged list of EventTypes optionally filtered and sortedSoapRestC#

Project

The Phoenix projects referenced from PhoenixIdenity.Project

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 refers to PhoenixSecurity.Project.Id[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

Operations

ActivateModule
Activates the Analytics module for specified project.SoapRestC#
GetModuleSettings
Retrieves the Analytics modules settings for the specified project.SoapRestC#

Task`1

Properties

Name Type Description

Operations

ListEventLogAggregate
Returns a paged list of aggregated EventLogs optionally filtered and sortedSoapRestC#

Trigger

A Trigger is a pattern match on a particular Event. For example a Trigger can be configured to fire when an SMS is recevied on a particular account with a particular message in the body.

Properties

Name Type Description
IdSystem.Int32 the primary identifier[queryable][sortable]
DescriptionSystem.StringA verbose description of this trigger
EventTypeIdSystem.Int32 the type of Event that this Trigger relates to[queryable][required]
ConfigurationSystem.Stringthe configuration XML expressing the parameters needed to understand the Event
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object was modified
StartDateSystem.DateTime the date that this Trigger begins to be effective[queryable]
EndDateSystem.DateTime the date that this Trigger ceases to be effective[queryable]
TriggerTypeIdSystem.Int32 the type of Trigger that this is[queryable][sortable]
ProjectIdSystem.Int32 the ProjectId that this Trigger belongs to.  A null values represents a Global Trigger[queryable]
IsActiveSystem.Boolean whether this Trigger is currently active or not[queryable][required]
HasDependencyErrorSystem.Boolean whether this Trigger has dependency errors[queryable][required]
TargetIdSystem.Int32 an optional Id that this Trigger targets (of type EventTypeId.ResourceTypeId)[queryable]
TargetNameSystem.Stringan optional name of the Target for display purposes
GroupIdSystem.Int32 an optional GrouId that this Trigger is concerned with[queryable]
GroupNameSystem.Stringan optional name of the Group for display purposes
NameSystem.String A short name for this Trigger[queryable]
TriggerTypeTriggerTypeNavigation property to TriggerType [expandable]
EventTypeEventTypeNavigation property to EventType [expandable]
ActionsICollection[]Navigation property to Action [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateTrigger
Creates a new Trigger objectSoapRestC#
GetTrigger
Gets a single Trigger entity by its IdSoapRestC#
ListTrigger
Returns a paged list of Triggers optionally filtered and sortedSoapRestC#
UpdateTrigger
Updates a list of Trigger entitiesSoapRestC#

TriggerType

TriggerTypes outline the required conditional template that Triggers must implement

Properties

Name Type Description
IdSystem.Int32 the primary identifier[queryable][sortable]
NameSystem.String the name of this TriggerType[queryable][sortable][required]
PhraseTemplateSystem.Stringthe template to build  a natural language phrase describing this type of Trigger
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object was modified
TriggerResolverSystem.StringThe Class to instantiate for resolution of the Trigger
ConfigurationModelSystem.StringThe model for configuration of a Trigger of this TriggerType

Operations

ListTriggerType
Returns a paged list of TriggerTypes optionally filtered and sortedSoapRestC#

Widget

Widgets are a variety of charts that visualise the analytics within the platform

Properties

Name Type Description
IdSystem.Int32  the primary identifier[queryable][sortable]
ProjectIdSystem.Int32The project to which the Widget is associated with[required]
WidgetTypeIdWidgetTypeEnumThe type of widget this is
NameSystem.StringThe name of the Widget[required]
ParameterSystem.StringAn optional parameter used to generate the Widget
SortOrderSystem.Int32 the order in which the Widgets should be displayed[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object was modified
WidthSystem.Int32The width of the Widget in units of 1 (default 1).
ProjectProjectNavigation property to Project [expandable]

Operations

CreateWidget
Creates a new Widget objectSoapRestC#
GetWidget
Gets a single Widget entity by its IdSoapRestC#
ListWidget
Returns a paged list of Widgets optionally filtered and sortedSoapRestC#
UpdateWidget
Updates a list of Widget entitiesSoapRestC#