BackofficeApi

<back to all web services

GetInsightsRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/insights

export module BackofficeApi
{
    // @ts-nocheck

}

TypeScript GetInsightsRequest DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}