Bitrix API

Statistics

Table of Contents

Constants

AVERAGE_EFFICIENCY  = 0.15
USER_OPTION_FILTER_NAME  = 'statistics_filter'

Methods

__construct()  : mixed
Constructor.
create()  : static
Create instance.
filter()  : $this
Return filter.
getCacheTtl()  : int
Get cache TTL.
getChainList()  : array<string|int, mixed>
Return chain list.
getClickLinks()  : array<string|int, mixed>
Return click links.
getCounterPostings()  : array<string|int, mixed>
Return subscribers.
getCounters()  : array<string|int, mixed>
Return counters.
getCountersDynamic()  : array<string|int, mixed>
Return dynamic of counters.
getCounterSubscribers()  : array<string|int, mixed>
Return subscribers.
getEfficiency()  : float
Return efficiency.
getFilter()  : Filter
Return filter.
getGlobalFilterData()  : array<string|int, mixed>
Return global filter data.
getReadingByDayTime()  : array<string|int, mixed>
Return read counter data by day time.
getRecommendedSendTime()  : string
Return recommended sending time for mailing.
initFilterFromRequest()  : $this
Init filter from request.
initFromArray()  : mixed
setCacheTtl()  : $this
Set cache TTL.
setUserId()  : $this
Set user Id.

Constants

AVERAGE_EFFICIENCY

public mixed AVERAGE_EFFICIENCY = 0.15

USER_OPTION_FILTER_NAME

public mixed USER_OPTION_FILTER_NAME = 'statistics_filter'

Methods

__construct()

Constructor.

public __construct([Filter $filter = null ]) : mixed
Parameters
$filter : Filter = null

Filter.

create()

Create instance.

public static create([Filter $filter = null ]) : static
Parameters
$filter : Filter = null

Filter.

Return values
static

filter()

Return filter.

public filter(string $name[, string $value = null ]) : $this
Parameters
$name : string

Filter name.

$value : string = null

Filter value.

Return values
$this

getCacheTtl()

Get cache TTL.

public getCacheTtl() : int
Return values
int

getChainList()

Return chain list.

public getChainList([int $limit = 20 ]) : array<string|int, mixed>
Parameters
$limit : int = 20

Limit.

Return values
array<string|int, mixed>

getClickLinks()

Return click links.

public getClickLinks([int $limit = 15 ]) : array<string|int, mixed>
Parameters
$limit : int = 15

Limit.

Return values
array<string|int, mixed>

getCounterPostings()

Return subscribers.

public getCounterPostings() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCounters()

Return counters.

public getCounters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCountersDynamic()

Return dynamic of counters.

public getCountersDynamic() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCounterSubscribers()

Return subscribers.

public getCounterSubscribers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getEfficiency()

Return efficiency.

public getEfficiency() : float
Return values
float

getGlobalFilterData()

Return global filter data.

public getGlobalFilterData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getReadingByDayTime()

Return read counter data by day time.

public getReadingByDayTime([int $step = 2 ]) : array<string|int, mixed>
Parameters
$step : int = 2

Step.

Return values
array<string|int, mixed>

getRecommendedSendTime()

Return recommended sending time for mailing.

public getRecommendedSendTime([int $chainId = null ]) : string
Parameters
$chainId : int = null

Chain Id.

Return values
string

initFilterFromRequest()

Init filter from request.

public initFilterFromRequest() : $this
Return values
$this

initFromArray()

public initFromArray(mixed $postingData) : mixed
Parameters
$postingData : mixed

setCacheTtl()

Set cache TTL.

public setCacheTtl(int $cacheTtl) : $this
Parameters
$cacheTtl : int

Cache ttl.

Return values
$this

setUserId()

Set user Id.

public setUserId(int $userId) : $this
Parameters
$userId : int

User Id.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results