pub.chive.admin.getSearchAnalytics Documentation (EN)

main query

Get search usage analytics

Output

Encodingapplication/json

clicks integer Required

Results clicked.

impressions integer Required

Results shown.

positionDistribution array Required

No description available.

relevanceGradeDistribution array Required

No description available.

timestamp stringdatetime Required

An RFC 3339 formatted timestamp.

topQueries array Required

No description available.

totalClicks integer Required

Result clicks recorded.

totalQueries integer Required

Distinct search queries recorded.

zeroResultCount integer Required

Searches that returned nothing.

Errors

AuthenticationRequired

AdminRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "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 object

Impressions at one result position.

Properties

count integer Required

No description available.

position integer Required

No description available.

View raw schema

{
  "description": "Impressions at one result position.",
  "properties": {
    "count": {
      "type": "integer"
    },
    "position": {
      "type": "integer"
    }
  },
  "required": [
    "position",
    "count"
  ],
  "type": "object"
}

relevanceGradeCount object

Judgements at one relevance grade.

Properties

count integer Required

No description available.

relevanceGrade integer Required

No description available.

View raw schema

{
  "description": "Judgements at one relevance grade.",
  "properties": {
    "count": {
      "type": "integer"
    },
    "relevanceGrade": {
      "type": "integer"
    }
  },
  "required": [
    "relevanceGrade",
    "count"
  ],
  "type": "object"
}

topQuery object

A query with its impression and click counts.

Properties

clickCount integer Required

No description available.

impressionCount integer Required

No description available.

query string Required

No description available.

View raw schema

{
  "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"
}