Heratio Framework API Reference

SearchIntelligenceService
in package

Search Intelligence Service.

Analyzes search patterns and provides insights.

Table of Contents

Methods

getConversionAnalysis()  : array<string|int, mixed>
Get search-to-click conversion analysis.
getPopularQueries()  : Collection
Get popular search queries.
getSearchPatternsByTime()  : array<string|int, mixed>
Get search patterns by time.
getTrendingQueries()  : Collection
Get trending queries (increased search volume).
getZeroResultQueries()  : Collection
Get zero-result queries.
updateDailyAggregates()  : void
Update daily search analytics aggregates.

Methods

getConversionAnalysis()

Get search-to-click conversion analysis.

public getConversionAnalysis([int|null $institutionId = null ][, int $days = 30 ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
$days : int = 30
Return values
array<string|int, mixed>

getPopularQueries()

Get popular search queries.

public getPopularQueries([int|null $institutionId = null ][, int $days = 30 ][, int $limit = 20 ]) : Collection
Parameters
$institutionId : int|null = null
$days : int = 30
$limit : int = 20
Return values
Collection

getSearchPatternsByTime()

Get search patterns by time.

public getSearchPatternsByTime([int|null $institutionId = null ][, int $days = 30 ]) : array<string|int, mixed>
Parameters
$institutionId : int|null = null
$days : int = 30
Return values
array<string|int, mixed>

getTrendingQueries()

Get trending queries (increased search volume).

public getTrendingQueries([int|null $institutionId = null ][, int $limit = 10 ]) : Collection
Parameters
$institutionId : int|null = null
$limit : int = 10
Return values
Collection

getZeroResultQueries()

Get zero-result queries.

public getZeroResultQueries([int|null $institutionId = null ][, int $days = 30 ][, int $limit = 20 ]) : Collection
Parameters
$institutionId : int|null = null
$days : int = 30
$limit : int = 20
Return values
Collection

updateDailyAggregates()

Update daily search analytics aggregates.

public updateDailyAggregates([string|null $date = null ]) : void
Parameters
$date : string|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results