Sitefinity Insight API data types

AuthenticationServiceUserData

Name	Data type
`Id`	String
`Email`	String
`FirstName`	String
`LastName`	String
`IsRoaming`	Boolean
`HasPassword`	Boolean
`Active`	Boolean
`Status`	String

AuthenticationServiceResponse

Name	Data type	Description
`access_token`	String	The authorization token, which is needed to authenticate in Sitefinity Insight secured endpoints.
`token_type`	String	The type of the authorization token. Sitefinity Insight uses and returns only bearer tokens.
`expires_in`	String	Expiration time of the token (in seconds).
`user_info`	AuthenticationServiceUserData	Contact details and status of the user in the authentication service records.

AccessKeyLoginReponse

Name	Data type	Description
`access_token`	String	The authorization token from the access key, which is needed to authenticate in Sitefinity Insight secured endpoints.
`token_type`	String	The type of the authorization token. Sitefinity Insight uses and returns only bearer tokens.
`expires_in`	String	Expiration time of the token (in seconds).
`Access_key_info`	AccessKeyInfo	Contains information about the access key.

AccessKeyInfo

Name	Data type	Description
`id`	String	The ID of the access key.
`name`	String	The name of the access key

User

Name	Data type	Description
`Id`	String	The Id of the authorized user in Sitefinity Insight.
`UserType`	String	The type of the user in Sitefinity Insight. Can be either `AccessKey` or `ApplicationRelyingParty`.
`Username`	String	The login name of the authorized user.
`Email`	String	User's email
`FirstName`	String	User's first name
`LastName`	String	User's last name
`IsActive`	Integer	`0` - User has never interacted with any of the Sitefinity Insight API server endpoints or Web App. `1` – User has interacted with Sitefinity Insight.
`TermsAndCondsState`	Integer	The state of terms and conditions acceptance: `0` – Terms and conditions are not accepted `1` – Terms and conditions altered since last acceptance `2` – Latest terms and conditions are accepted
`ReacceptTerms`	Integer	Flag to show if the user needs to re-accept the updated terms and conditions.
`LatestDismissedMessageId`	Integer	The identifier of last dismissed message from what's new notifications.
`TermsAndCondsAccptedOn`	Datetime	The date on which the latest terms and conditions were accepted.

DataCenter

Name	Data type	Description
`Id`	Guid	The primary key and unique identified of the data center.
`ApiKey`	Guid	The key used to identify the data center in the API calls to the Sitefinity Insight endpoints.
`Name`	String	The name of the data center as defined by the user who created it.
`Description`	String	Тhe description of the data center as set by the user who created it.
`State`	Integer	Indicates the current state of the data center: `1` Scheduled for creation `2` Being Created `3` Created `5` Paused
`PersonasCount`	Integer	The number of personas defined in the data center.
`LeadsCount`	Integer	The number of lead scoring types defined in the data center.
`GoalsCount`	Integer	The number of goals and conversion defined in the data center
`PersonalizationReportsCount`	Integer	The number of personalization reports defined in the data center.
`TouchpointsCount`	Integer	The number of touchpoints defined in the data center
`DataSourcesCount`	Integer	The number of data sources reported to the data center.
`CreatedByUserId`	Guid	The unique identifier of the user who created the data center.
`CreatedOn`	Datetime	The date and time of the creation of the data center in UTC.
`ContactsOperationsStatus`	Integer	Indicates if contact's maintenance is being executed `Null` No maintenance `1` Processing
`DataCenterType`	String	The type of the data center. Can be one of the following: `Standard` `Demo`
`OperationalStatus`	String	Indicates the current operational status of the data center.
`AverageLoad`	Integer	The average unique visitors in the data center for last 30 days.
`Settings`	DatacenterSettings	The settings which will be used by the datacenter.
`ABTestsCount`	Integer	The number of A/B tests in the data center.
`AccountId`	Guid	The unique identifier of the Sitefinity Insight account the data center is created in.
`StorageSettingsId`	Guid	The unique identifier of the storage settings of the data center.

DatacenterSettings

Name	Data type	Descrition
`Id`	Guid	The unique identifier of the data center.
`StatisticsRecalculationHour`	Datetime	The time for new statistics to be recalculated.
`GoalRecalculationHour`	Datetime	The time for goals to be recalculated.

Key-value pair

Name	Data type	Required	Description
`K`	String	Yes	The key of the metadata, for example, Email, Last Name, and so on.
`V`	String	Yes	The value of the metadata, for example, sample.user@progress.com, Smith, and so on.

Personalization context

Name	Data type	Required	Description
`Properties`	Object	No	Contains the values of all `ContactProperties`. Each object property contains the ID of the respective `ContactProperty`.
`InPersonas`	Array of `PersContextPersona` objects	No	The IDs of all personas to which a given visitor belongs.
`PassedLeads`	Array of `PersContextLead` objects	No	The IDs of all lead scorings, where a given visitor interactions count with their levels.

Personalization context - Persona

Name	Data type	Required	Description
`PersonaId`	Integer	No	Contains the ID of the persona to which a given visitor belongs.

Personalization context - Leads

Name	Data type	Required	Description
`LeadId`	Integer	No	Contains the ID of the lead scoring for particular visitor.
`LevelId`	Integer	No	Contains the passed level of given lead scoring for a given visitor.

Scoring result

Name	Data type	Required	Description
`Id`	Integer	No	The ID of the persona
`Score`	Integer	No	The score of the subject associated with the persona.
`Threshold`	Integer	No	The threshold score a subject needs to pass to be associated with the persona.
`ThresholdPassedOn`	Datetime	No	The date when the subject passed the threshold.

Levels pass

Name	Data type	Required	Description
`LevelId`	Integer	No	The ID of the lead scoring type that was passed.
`PassedOn`	Datetime	No	The date when the subject scored enough to be associated with this lead scoring type.

Levels pass v2

Name	Data type	Required	Description
`LevelId`	Integer	No	The ID of the lead scoring type that was passed.
`ThresholdPassedOn`	Datetime	No	The date when the subject scored enough to be associated with this lead scoring type.
`Threshold`	Integer	No	The number of points a subject needs to score to be associated with this lead scoring type.

Lead scoring result Data types v1

Name	Data type	Required	Description
`ScoringId`	Integer	No	The ID of the lead scoring type.
`Score`	Integer	No	The points scored by the subject.
`Levels`	LevelsPass[]	No	Array of objects that describes each lead type the subject has passed.

Lead scoring result Data types v2

Name	Data type	Required	Description
`ScoringId`	Integer	No	The ID of the lead scoring type.
`Score`	Integer	No	The points scored by the subject.
`Levels`	LevelsPassV2	No	Array of objects that describes each lead type the subject has passed.

Lead scoring result report

Name	Data type	Required	Description
`Subject`	String	No
`DataSource`	String	No
`Leads`	Lead scoring result Data types v1	No

AbTestStatusUpdate

Name	Data type	Required	Description
`BusinessStatus`	String	Yes	The business status of the A/B test. Supported statuses are: `NotStarted` `Scheduled` `Active` `Stopped` `Ended`
`StartDate`	Date	No	The start date of the A/B test. The date must be in the future.
`StopDate`	Date	No	The stop date of the A/B test. The date must be in the future.

DeleteContactRequestStatusEnum

Pending
Confirmed
ProcessingOperationalData
OperationalDataDone
ProcessingRawData
Done
Failed

DeleteContactsRequest

Name	Data type	Required	Description
`Id`	Integer	No	The ID of the delete contact request.
`TargetSubjectsJson`	String	Yes	Serialized array of subject IDs to be deleted.
`Status`	DeleteContactRequestStatusEnum	No	The status of the request.
`CreatedByUserId`	Guid	No	The ID of the user who created the request.
`CreatedByFirstName`	String	No	The first name of the user who created the request.
`CreatedByLastName`	String	No	The last name of the user who created the request.
`CreatedOn`	Date	No	The date on which the request was created.
`ModifiedOn`	Date	No	The date on which the request was last modified.

ExportContactsRequest

Name	Data type	Required	Description
`Id`	Integer	No	The ID of the export contact request.
`TargetSubjectsJson`	String	Yes	Serialized array of subject IDs to be exported.
`Status`	ExportContactRequestStatusEnum	No	The status of the request.
`CreatedByUserId`	Guid	No	The ID of the user who created the request.
`CreatedByFirstName`	String	No	The first name of the user who created the request.
`CreatedByLastName`	String	No	The last name of the user who created the request.
`CreatedOn`	Date	No	The date on which the request was created.
`ModifiedOn`	Date	No	The date on which the request was last modified.
`ExportedDataExpiresOn`	Date	No	The date on which the exported data will no longer be available for download.
`DownloadUrl`	String	No	The URL from which the exported data is to be downloaded.

ExportedContactDataBehavioralItem

Name	Data type	Required	Description
`Action`	String	Yes	The action (predicate) performed by the visitor, for example, `Visit`, `Download file`, and so on.
`Object`	String	Yes	The `object` of the action performed by the visitor, for example, `http://progress.com` for an action `Visit webpage`.
`Timestamp`	DateTime	Yes	The timestamp of the completed action.

ExportedContactDataDemographicItem

Name	Data type	Required	Description
`Key`	String	Yes	The key of the metadata, for example, `Email`.
`Value`	String	Yes	The value of the reported metadata, for example, `john.smith@progress.com`.

ExportedDataFormat

Name	Data type	Required	Description
`Source`	String	Yes	The source from which data is being extracted. This is always set to `Sitefinity Insight`
`DataExportDateInUtc`	String	Yes	The date on which the report is generated as UTC string.
`DemogrpahicData`	ExportedContactDataDemographicItem[]	Yes	An array containing the metadata reported for the contact.
`BehavioralData`	ExportedContactDataBehavioralItem[]	Yes	An array containing the behavioral data reported for the contact.