# fm.teal.stats.getTopReleases

> Published by [teal.fm](https://lexicon.garden/identity/did:plc:iwhuynr6mm6xxuh25o4do2tx)

✓ This is the authoritative definition for this NSID.

## Description

Get top releases/albums by play count

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:iwhuynr6mm6xxuh25o4do2tx/fm.teal.stats.getTopReleases)
- [Documentation](https://lexicon.garden/lexicon/did:plc:iwhuynr6mm6xxuh25o4do2tx/fm.teal.stats.getTopReleases/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:iwhuynr6mm6xxuh25o4do2tx/fm.teal.stats.getTopReleases/examples)

## Definitions

### `fm.teal.stats.getTopReleases`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Number of releases to return |
| `cursor` | `string` | No | Pagination cursor |
| `period` | `string` | No | Time period for top releases |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Next page cursor |
| `releases` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "fm.teal.stats.getTopReleases",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "releases"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "Next page cursor"
            },
            "releases": {
              "type": "array",
              "items": {
                "ref": "fm.teal.stats.defs#releaseView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "description": "Number of releases to return"
          },
          "cursor": {
            "type": "string",
            "description": "Pagination cursor"
          },
          "period": {
            "enum": [
              "all",
              "30days",
              "7days"
            ],
            "type": "string",
            "default": "all",
            "description": "Time period for top releases"
          }
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Get top releases/albums by play count"
}
```