BackofficeApi

GetInsightsRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

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

"use strict";

JavaScript GetInsightsRequest DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInsightsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <ActiveUsersSeries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsTimeBucket>
      <d2p1:Bucket xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:Bucket>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:InsightsTimeBucket>
  </ActiveUsersSeries>
  <ActiveUsersTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:ChangePercent>0</d2p1:ChangePercent>
    <d2p1:Total>0</d2p1:Total>
  </ActiveUsersTotals>
  <ChurnSeries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsTimeBucket>
      <d2p1:Bucket xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:Bucket>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:InsightsTimeBucket>
  </ChurnSeries>
  <ChurnTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:ChangePercent>0</d2p1:ChangePercent>
    <d2p1:Total>0</d2p1:Total>
  </ChurnTotals>
  <Demographics xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsAgeBucket>
      <d2p1:AgeGroup>String</d2p1:AgeGroup>
      <d2p1:Count>0</d2p1:Count>
      <d2p1:Sex>String</d2p1:Sex>
    </d2p1:InsightsAgeBucket>
  </Demographics>
  <DemographicsTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:FemaleCount>0</d2p1:FemaleCount>
    <d2p1:MaleCount>0</d2p1:MaleCount>
    <d2p1:TotalUsers>0</d2p1:TotalUsers>
    <d2p1:UnspecifiedCount>0</d2p1:UnspecifiedCount>
  </DemographicsTotals>
  <InviteAcceptedSeries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsTimeBucket>
      <d2p1:Bucket xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:Bucket>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:InsightsTimeBucket>
  </InviteAcceptedSeries>
  <InviteAcceptedTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:ChangePercent>0</d2p1:ChangePercent>
    <d2p1:Total>0</d2p1:Total>
  </InviteAcceptedTotals>
  <InviteFriendsSeries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsTimeBucket>
      <d2p1:Bucket xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:Bucket>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:InsightsTimeBucket>
  </InviteFriendsSeries>
  <InviteFriendsTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:ChangePercent>0</d2p1:ChangePercent>
    <d2p1:Total>0</d2p1:Total>
  </InviteFriendsTotals>
  <LotteryTotalPoints>0</LotteryTotalPoints>
  <LotteryUniqueParticipants>0</LotteryUniqueParticipants>
  <OptOutsSeries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsTimeBucket>
      <d2p1:Bucket xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:Bucket>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:InsightsTimeBucket>
  </OptOutsSeries>
  <OptOutsTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:ChangePercent>0</d2p1:ChangePercent>
    <d2p1:Total>0</d2p1:Total>
  </OptOutsTotals>
  <Overview xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InvitesClicked>0</d2p1:InvitesClicked>
    <d2p1:InvitesSent>0</d2p1:InvitesSent>
    <d2p1:SignIns>0</d2p1:SignIns>
    <d2p1:SignUps>0</d2p1:SignUps>
    <d2p1:UniqueUsers>0</d2p1:UniqueUsers>
  </Overview>
  <RewardPointsBreakdown xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:PointsBreakdown>
      <d2p1:Source>String</d2p1:Source>
      <d2p1:TotalPoints>0</d2p1:TotalPoints>
      <d2p1:UniqueUsers>0</d2p1:UniqueUsers>
    </d2p1:PointsBreakdown>
  </RewardPointsBreakdown>
  <RewardPointsTotalAll>0</RewardPointsTotalAll>
  <RewardPointsUniqueUsersAll>0</RewardPointsUniqueUsersAll>
  <SignUpsSeries xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:InsightsTimeBucket>
      <d2p1:Bucket xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:Bucket>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:InsightsTimeBucket>
  </SignUpsSeries>
  <SignUpsTotals xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Repository">
    <d2p1:ChangePercent>0</d2p1:ChangePercent>
    <d2p1:Total>0</d2p1:Total>
  </SignUpsTotals>
</GetInsightsResponse>