# rsvp.atmo.getOverview

> Published by [atmo.rsvp](https://lexicon.garden/identity/did:plc:b63bmauox6z5rbibwrhxrdnw)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:b63bmauox6z5rbibwrhxrdnw/rsvp.atmo.getOverview)
- [Documentation](https://lexicon.garden/lexicon/did:plc:b63bmauox6z5rbibwrhxrdnw/rsvp.atmo.getOverview/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:b63bmauox6z5rbibwrhxrdnw/rsvp.atmo.getOverview/examples)

## Definitions

### `rsvp.atmo.getOverview`

**Type**: `query`

Get an overview of all indexed collections

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `collections` | `array` | Yes |  |
| `total_records` | `integer` | Yes |  |

### `rsvp.atmo.getOverview#collectionStats`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `records` | `integer` | Yes |  |
| `collection` | `string` | Yes |  |
| `unique_users` | `integer` | Yes |  |

## Raw Schema

```json
{
  "id": "rsvp.atmo.getOverview",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "total_records",
            "collections"
          ],
          "properties": {
            "collections": {
              "type": "array",
              "items": {
                "ref": "#collectionStats",
                "type": "ref"
              }
            },
            "total_records": {
              "type": "integer"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Get an overview of all indexed collections"
    },
    "collectionStats": {
      "type": "object",
      "required": [
        "collection",
        "records",
        "unique_users"
      ],
      "properties": {
        "records": {
          "type": "integer"
        },
        "collection": {
          "type": "string"
        },
        "unique_users": {
          "type": "integer"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```