{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Get search usage analytics",
"errors": [
{
"name": "AuthenticationRequired"
},
{
"name": "AdminRequired"
}
],
"output": {
"encoding": "application/json",
"schema": {
"description": "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": {
"description": "Results clicked.",
"type": "integer"
},
"impressions": {
"description": "Results shown.",
"type": "integer"
},
"positionDistribution": {
"items": {
"ref": "#positionCount",
"type": "ref"
},
"type": "array"
},
"relevanceGradeDistribution": {
"items": {
"ref": "#relevanceGradeCount",
"type": "ref"
},
"type": "array"
},
"timestamp": {
"format": "datetime",
"type": "string"
},
"topQueries": {
"items": {
"ref": "#topQuery",
"type": "ref"
},
"type": "array"
},
"totalClicks": {
"description": "Result clicks recorded.",
"type": "integer"
},
"totalQueries": {
"description": "Distinct search queries recorded.",
"type": "integer"
},
"zeroResultCount": {
"description": "Searches that returned nothing.",
"type": "integer"
}
},
"required": [
"totalQueries",
"totalClicks",
"impressions",
"clicks",
"positionDistribution",
"topQueries",
"zeroResultCount",
"relevanceGradeDistribution",
"timestamp"
],
"type": "object"
}
},
"parameters": {
"properties": {},
"type": "params"
},
"type": "query"
},
"positionCount": {
"description": "Impressions at one result position.",
"properties": {
"count": {
"type": "integer"
},
"position": {
"type": "integer"
}
},
"required": [
"position",
"count"
],
"type": "object"
},
"relevanceGradeCount": {
"description": "Judgements at one relevance grade.",
"properties": {
"count": {
"type": "integer"
},
"relevanceGrade": {
"type": "integer"
}
},
"required": [
"relevanceGrade",
"count"
],
"type": "object"
},
"topQuery": {
"description": "A query with its impression and click counts.",
"properties": {
"clickCount": {
"type": "integer"
},
"impressionCount": {
"type": "integer"
},
"query": {
"type": "string"
}
},
"required": [
"query",
"impressionCount",
"clickCount"
],
"type": "object"
}
},
"id": "pub.chive.admin.getSearchAnalytics",
"lexicon": 1,
"revision": 1
}