Skip to main content

Interface: OutputSchema

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:22

Search analytics aggregates. The response also carries ctr, the click-through rate as a fraction of impressions, and avgDwellTimeMs, the mean dwell time or null when nothing has been measured. Neither is declared here: Lexicon has no float type, unknown means an object rather than any value, and a declared integer rejects both a fraction and null. Undeclared properties pass validation and reach the client unchanged, so declaring them as integers would break the endpoint rather than describe it.

Properties​

clicks​

clicks: number

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:30

Results clicked.

impressions​

impressions: number

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:28

Results shown.

positionDistribution​

positionDistribution: PositionCount[]

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:31

relevanceGradeDistribution​

relevanceGradeDistribution: RelevanceGradeCount[]

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:35

timestamp​

timestamp: string

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:36

topQueries​

topQueries: TopQuery[]

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:32

totalClicks​

totalClicks: number

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:26

Result clicks recorded.

totalQueries​

totalQueries: number

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:24

Distinct search queries recorded.

zeroResultCount​

zeroResultCount: number

Defined in: web/lib/api/generated/types/pub/chive/admin/getSearchAnalytics.ts:34

Searches that returned nothing.