Bitrix API

UStat

Table of Contents

Constants

ADMIN_GROUP_ID  = 1
CACHE_ID  = 'pulse_company_active_user_count'
CACHE_TTL  = 3600
INVOLVEMENT_SERVICE_COUNT  = 4
USER_LIMIT  = 1000

Methods

checkAvailableCompanyPulse()  : bool
checkAvailableCompanyPulseAndNotifyAdmin()  : bool
disableEventHandler()  : mixed
enableEventHandler()  : mixed
getCurrentActivity()  : mixed
getDepartmentAverageGraphData()  : mixed
getDepartmentGraphData()  : array<string|int, mixed>
getDepartmentSummaryInvolvement()  : int
getFormattedNumber()  : mixed
getHeadsOfDepartments()  : mixed
getMaxUserActivity()  : array<string|int, mixed>|bool
getSectionInvolvement()  : array<string|int, mixed>
getSectionsSummaryInvolvement()  : array<string|int, mixed>|bool
getStatusInformation()  : mixed
getUserRatingApi()  : mixed
getUsersDepartments()  : mixed
getUsersGraphData()  : array<string|int, mixed>
getUsersTop()  : mixed
incrementCounter()  : mixed
recount()  : mixed
Recounts daily statistics: active users, activity and involvement for today and previous active day
recountHourlyCompanyActivity()  : mixed
Recounts hourly company activity
sendAdminNotification()  : void
sendNotificationIfLimitExceeded()  : bool

Constants

ADMIN_GROUP_ID

public mixed ADMIN_GROUP_ID = 1

CACHE_ID

public mixed CACHE_ID = 'pulse_company_active_user_count'

CACHE_TTL

public mixed CACHE_TTL = 3600

INVOLVEMENT_SERVICE_COUNT

public mixed INVOLVEMENT_SERVICE_COUNT = 4

USER_LIMIT

public mixed USER_LIMIT = 1000

Methods

checkAvailableCompanyPulse()

public static checkAvailableCompanyPulse() : bool
Return values
bool

checkAvailableCompanyPulseAndNotifyAdmin()

public static checkAvailableCompanyPulseAndNotifyAdmin() : bool
Return values
bool

disableEventHandler()

public static disableEventHandler() : mixed

enableEventHandler()

public static enableEventHandler() : mixed

getCurrentActivity()

public static getCurrentActivity([mixed $departmentId = 0 ][, mixed $section = null ]) : mixed
Parameters
$departmentId : mixed = 0
$section : mixed = null

getDepartmentAverageGraphData()

public static getDepartmentAverageGraphData(mixed $deptId, DateTime $dateFrom, DateTime $dateTo, mixed $interval[, mixed $section = null ]) : mixed
Parameters
$deptId : mixed
$dateFrom : DateTime
$dateTo : DateTime
$interval : mixed
$section : mixed = null

getDepartmentGraphData()

public static getDepartmentGraphData(int $departmentId, DateTime $dateFrom, DateTime $dateTo, string $interval) : array<string|int, mixed>
Parameters
$departmentId : int
$dateFrom : DateTime
$dateTo : DateTime
$interval : string

hour | day | month

Tags
throws
ArgumentException
Return values
array<string|int, mixed>

getDepartmentSummaryInvolvement()

public static getDepartmentSummaryInvolvement(int $departmentId, DateTime $dateFrom, DateTime $dateTo, string $interval) : int
Parameters
$departmentId : int
$dateFrom : DateTime
$dateTo : DateTime
$interval : string

hour | day | month

Tags
throws
ArgumentException
Return values
int

getFormattedNumber()

public static getFormattedNumber(mixed $number) : mixed
Parameters
$number : mixed

getHeadsOfDepartments()

public static getHeadsOfDepartments() : mixed

getMaxUserActivity()

public static getMaxUserActivity(DateTime $dateFrom, DateTime $dateTo, mixed $interval) : array<string|int, mixed>|bool
Parameters
$dateFrom : DateTime
$dateTo : DateTime
$interval : mixed
Tags
throws
ArgumentException
Return values
array<string|int, mixed>|bool

getSectionInvolvement()

public static getSectionInvolvement(int $departmentId, string $section, DateTime $dateFrom, DateTime $dateTo, string $interval) : array<string|int, mixed>
Parameters
$departmentId : int
$section : string
$dateFrom : DateTime
$dateTo : DateTime
$interval : string
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

getSectionsSummaryInvolvement()

public static getSectionsSummaryInvolvement(DateTime $dateFrom, DateTime $dateTo, string $interval) : array<string|int, mixed>|bool
Parameters
$dateFrom : DateTime
$dateTo : DateTime
$interval : string

hour | day | month

Tags
throws
ArgumentException
Return values
array<string|int, mixed>|bool

getStatusInformation()

public static getStatusInformation() : mixed

getUserRatingApi()

public static getUserRatingApi([string $period = '' ][, int $limit = 5 ]) : mixed
Parameters
$period : string = ''
$limit : int = 5

getUsersDepartments()

public static getUsersDepartments() : mixed

getUsersGraphData()

public static getUsersGraphData(string $userId, DateTime $dateFrom, DateTime $dateTo, string $interval[, string|null $section = null ]) : array<string|int, mixed>
Parameters
$userId : string
$dateFrom : DateTime
$dateTo : DateTime
$interval : string

hour | day | month

$section : string|null = null
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

getUsersTop()

public static getUsersTop(mixed $userId, mixed $departmentId, DateTime $dateFrom, DateTime $dateTo, mixed $interval[, mixed $section = null ][, mixed $nonInvolvedOnly = false ][, mixed $from = 0 ][, mixed $limit = 100 ]) : mixed
Parameters
$userId : mixed
$departmentId : mixed
$dateFrom : DateTime
$dateTo : DateTime
$interval : mixed
$section : mixed = null
$nonInvolvedOnly : mixed = false
$from : mixed = 0
$limit : mixed = 100

incrementCounter()

public static incrementCounter(mixed $section[, mixed $userId = null ]) : mixed
Parameters
$section : mixed
$userId : mixed = null

recount()

Recounts daily statistics: active users, activity and involvement for today and previous active day

public static recount() : mixed

recountHourlyCompanyActivity()

Recounts hourly company activity

public static recountHourlyCompanyActivity() : mixed

sendAdminNotification()

public static sendAdminNotification() : void

sendNotificationIfLimitExceeded()

public static sendNotificationIfLimitExceeded() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results