BackofficeApi

GetInsightsRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

The following routes are available for this service:
GET	/insights

**GetInsightsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
TimeFilter	query	InsightTimeFilter	No
CacheVersion	query	long?	No

**InsightTimeFilter** Enum:
Daily
Weekly
Monthly

**GetInsightsResponse** Parameters:
Name	Parameter	Data Type	Required
Overview	form	InsightsOverview	Yes
InviteFriendsSeries	form	List<InsightsTimeBucket>	Yes
InviteFriendsTotals	form	InsightsSeriesTotal	Yes
InviteAcceptedSeries	form	List<InsightsTimeBucket>	Yes
InviteAcceptedTotals	form	InsightsSeriesTotal	Yes
SignUpsSeries	form	List<InsightsTimeBucket>	Yes
SignUpsTotals	form	InsightsSeriesTotal	Yes
OptOutsSeries	form	List<InsightsTimeBucket>	Yes
OptOutsTotals	form	InsightsSeriesTotal	Yes
ChurnSeries	form	List<InsightsTimeBucket>	Yes
ChurnTotals	form	InsightsSeriesTotal	Yes
ActiveUsersSeries	form	List<InsightsTimeBucket>	Yes
ActiveUsersTotals	form	InsightsSeriesTotal	Yes
Demographics	form	List<InsightsAgeBucket>	Yes
DemographicsTotals	form	InsightsDemographicsTotals	Yes
LotteryUniqueParticipants	form	long	No
LotteryTotalPoints	form	long	No
RewardPointsBreakdown	form	List<PointsBreakdown>	Yes
RewardPointsTotalAll	form	long	No
RewardPointsUniqueUsersAll	form	long	No

**InsightsOverview** Parameters:
Name	Parameter	Data Type	Required
UniqueUsers	form	long	No
SignIns	form	long	No
SignUps	form	long	No
InvitesSent	form	long	No
InvitesClicked	form	long	No

**InsightsTimeBucket** Parameters:
Name	Parameter	Data Type	Required	Description
Bucket	form	DateTimeOffset	No
Value	form	long	No

**InsightsSeriesTotal** Parameters:
Name	Parameter	Data Type	Required	Description
Total	form	long	No
ChangePercent	form	double	No

**InsightsAgeBucket** Parameters:
Name	Parameter	Data Type	Required
AgeGroup	form	string	Yes
Sex	form	string	No
Count	form	long	No

**InsightsDemographicsTotals** Parameters:
Name	Parameter	Data Type	Required
TotalUsers	form	long	No
MaleCount	form	long	No
FemaleCount	form	long	No
UnspecifiedCount	form	long	No

**PointsBreakdown** Parameters:
Name	Parameter	Data Type	Required
Source	form	string	Yes
TotalPoints	form	long	No
UniqueUsers	form	long	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /insights HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	overview: 
	{
		uniqueUsers: 0,
		signIns: 0,
		signUps: 0,
		invitesSent: 0,
		invitesClicked: 0
	},
	inviteFriendsSeries: 
	[
		{
			bucket: 0001-01-01T00:00:00.0000000+00:00,
			value: 0
		}
	],
	inviteFriendsTotals: 
	{
		total: 0,
		changePercent: 0
	},
	inviteAcceptedSeries: 
	[
		{
			bucket: 0001-01-01T00:00:00.0000000+00:00,
			value: 0
		}
	],
	inviteAcceptedTotals: 
	{
		total: 0,
		changePercent: 0
	},
	signUpsSeries: 
	[
		{
			bucket: 0001-01-01T00:00:00.0000000+00:00,
			value: 0
		}
	],
	signUpsTotals: 
	{
		total: 0,
		changePercent: 0
	},
	optOutsSeries: 
	[
		{
			bucket: 0001-01-01T00:00:00.0000000+00:00,
			value: 0
		}
	],
	optOutsTotals: 
	{
		total: 0,
		changePercent: 0
	},
	churnSeries: 
	[
		{
			bucket: 0001-01-01T00:00:00.0000000+00:00,
			value: 0
		}
	],
	churnTotals: 
	{
		total: 0,
		changePercent: 0
	},
	activeUsersSeries: 
	[
		{
			bucket: 0001-01-01T00:00:00.0000000+00:00,
			value: 0
		}
	],
	activeUsersTotals: 
	{
		total: 0,
		changePercent: 0
	},
	demographics: 
	[
		{
			ageGroup: String,
			sex: String,
			count: 0
		}
	],
	demographicsTotals: 
	{
		totalUsers: 0,
		maleCount: 0,
		femaleCount: 0,
		unspecifiedCount: 0
	},
	lotteryUniqueParticipants: 0,
	lotteryTotalPoints: 0,
	rewardPointsBreakdown: 
	[
		{
			source: String,
			totalPoints: 0,
			uniqueUsers: 0
		}
	],
	rewardPointsTotalAll: 0,
	rewardPointsUniqueUsersAll: 0
}