# pub.chive.admin.getSearchAnalytics

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.admin.getSearchAnalytics)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.admin.getSearchAnalytics/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.admin.getSearchAnalytics/examples)

## Definitions

### `pub.chive.admin.getSearchAnalytics`

**Type**: `query`

Get search usage analytics

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `timestamp` | `string` (datetime) | Yes | Analytics snapshot timestamp |
| `totalClicks` | `integer` | Yes | Total number of search result clicks |
| `totalSearches` | `integer` | Yes | Total number of search queries |

#### Errors

- **AuthenticationRequired**
- **AdminRequired**

## Raw Schema

```json
{
  "id": "pub.chive.admin.getSearchAnalytics",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "AdminRequired"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "totalSearches",
            "totalClicks",
            "timestamp"
          ],
          "properties": {
            "timestamp": {
              "type": "string",
              "format": "datetime",
              "description": "Analytics snapshot timestamp"
            },
            "totalClicks": {
              "type": "integer",
              "description": "Total number of search result clicks"
            },
            "totalSearches": {
              "type": "integer",
              "description": "Total number of search queries"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {}
      },
      "description": "Get search usage analytics"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```