# app.zeens.getEngagement

> Published by [zeens.app](https://lexicon.garden/identity/did:plc:pwpuqwge6g7xrjmfbw73uycw)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getEngagement)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getEngagement/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getEngagement/examples)

## Definitions

### `app.zeens.getEngagement#engagement`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `likeCount` | `integer` | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `viewer` | `ref` → `#viewerState` | No |  |

### `app.zeens.getEngagement`

**Type**: `query`

Like count and the viewer's own like for any record URI, one or a batch. Subject-agnostic: post_engagement is keyed by subject URI and the like hook counts likes on anything, so this serves zeens, events, articles and posts without a branch per lexicon. Pass `uris` to ask about a whole listing in one call -- the profile and studio Zeens tabs list from the author's repo, which carries no engagement, so without a batch each card would need its own round trip.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | No | A single record. Returns the bare object shape (uri/likeCount/viewer), which LikeButton and the zeen page depend on. |
| `uris` | `string` | No | Comma-separated AT-URIs, up to 100. Returns an `engagements` array instead of the single-record fields, with one entry per requested uri -- including subjects with no engagement row, which come back as a known 0 rather than being omitted (the caller draws nothing for "unknown" and a 0 for "none yet", and those differ). |
| `viewer` | `string` (did) | No | When given, the response carries this viewer's own like record. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `engagements` | `array` | No | Present for a `uris` request. One entry per requested uri, in request order. |
| `likeCount` | `integer` | No |  |
| `uri` | `string` (at-uri) | No |  |
| `viewer` | `ref` → `#viewerState` | No |  |

### `app.zeens.getEngagement#viewerState`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `like` | `string` (at-uri) | No | AT-URI of the viewer's like record, absent when they have not liked it. The record uri rather than a boolean, because unliking deletes it and a boolean would force a second lookup at the moment the user taps. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "engagement": {
      "properties": {
        "likeCount": {
          "type": "integer"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        },
        "viewer": {
          "ref": "#viewerState",
          "type": "ref"
        }
      },
      "required": [
        "uri",
        "likeCount"
      ],
      "type": "object"
    },
    "main": {
      "description": "Like count and the viewer's own like for any record URI, one or a batch. Subject-agnostic: post_engagement is keyed by subject URI and the like hook counts likes on anything, so this serves zeens, events, articles and posts without a branch per lexicon. Pass `uris` to ask about a whole listing in one call -- the profile and studio Zeens tabs list from the author's repo, which carries no engagement, so without a batch each card would need its own round trip.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "engagements": {
              "description": "Present for a `uris` request. One entry per requested uri, in request order.",
              "items": {
                "ref": "#engagement",
                "type": "ref"
              },
              "type": "array"
            },
            "likeCount": {
              "type": "integer"
            },
            "uri": {
              "format": "at-uri",
              "type": "string"
            },
            "viewer": {
              "ref": "#viewerState",
              "type": "ref"
            }
          },
          "required": [],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "uri": {
            "description": "A single record. Returns the bare object shape (uri/likeCount/viewer), which LikeButton and the zeen page depend on.",
            "format": "at-uri",
            "type": "string"
          },
          "uris": {
            "description": "Comma-separated AT-URIs, up to 100. Returns an `engagements` array instead of the single-record fields, with one entry per requested uri -- including subjects with no engagement row, which come back as a known 0 rather than being omitted (the caller draws nothing for \"unknown\" and a 0 for \"none yet\", and those differ).",
            "type": "string"
          },
          "viewer": {
            "description": "When given, the response carries this viewer's own like record.",
            "format": "did",
            "type": "string"
          }
        },
        "required": [],
        "type": "params"
      },
      "type": "query"
    },
    "viewerState": {
      "properties": {
        "like": {
          "description": "AT-URI of the viewer's like record, absent when they have not liked it. The record uri rather than a boolean, because unliking deletes it and a boolean would force a second lookup at the moment the user taps.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "id": "app.zeens.getEngagement",
  "lexicon": 1
}
```