club.foryou.getStats Documentation (EN)

main query

Authenticated, read-only view of a user's own For You (foryou.club) stats. Requires an atproto service-auth JWT (Authorization: Bearer) with aud=did:web:foryou.club and lxm=club.foryou.getStats; the token's iss identifies the user whose stats are returned.

Parameters

days integer Optional

Number of days to aggregate over. Defaults to the server's configured window.

Output

Encodingapplication/json

activity ref#activity Required

No description available.

author ref#author Required

No description available.

curator ref#curator Required

No description available.

daysAnalyzed integer Required

No description available.

did stringdid Required

DID of the user these stats belong to.

displayName string Optional

No description available.

generatedAt stringdatetime Required

An RFC 3339 formatted timestamp.

handle stringhandle Optional

An AT Protocol handle (e.g., alice.bsky.social).

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)

Parameters

days Number of days to aggregate over. Defaults to the server's configured window.

View raw schema

{
  "description": "Authenticated, read-only view of a user's own For You (foryou.club) stats. Requires an atproto service-auth JWT (Authorization: Bearer) with aud=did:web:foryou.club and lxm=club.foryou.getStats; the token's iss identifies the user whose stats are returned.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "activity": {
          "ref": "#activity",
          "type": "ref"
        },
        "author": {
          "ref": "#author",
          "type": "ref"
        },
        "curator": {
          "ref": "#curator",
          "type": "ref"
        },
        "daysAnalyzed": {
          "type": "integer"
        },
        "did": {
          "description": "DID of the user these stats belong to.",
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "generatedAt": {
          "format": "datetime",
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        }
      },
      "required": [
        "did",
        "daysAnalyzed",
        "generatedAt",
        "activity",
        "curator",
        "author"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "days": {
        "description": "Number of days to aggregate over. Defaults to the server's configured window.",
        "maximum": 365,
        "minimum": 1,
        "type": "integer"
      }
    },
    "type": "params"
  },
  "type": "query"
}

activity object

The user's own usage of the For You feed.

Properties

likesGiven integer Required

No description available.

postsViewed integer Required

No description available.

showLess integer Required

No description available.

showMore integer Required

No description available.

totalRequests integer Required

No description available.

View raw schema

{
  "description": "The user's own usage of the For You feed.",
  "properties": {
    "likesGiven": {
      "type": "integer"
    },
    "postsViewed": {
      "type": "integer"
    },
    "showLess": {
      "type": "integer"
    },
    "showMore": {
      "type": "integer"
    },
    "totalRequests": {
      "type": "integer"
    }
  },
  "required": [
    "totalRequests",
    "postsViewed",
    "likesGiven",
    "showMore",
    "showLess"
  ],
  "type": "object"
}

author object

How the user's own posts performed in the feed.

Properties

topPosts array of ref#post Required

No description available.

totalLikes integer Required

No description available.

totalViews integer Required

No description available.

View raw schema

{
  "description": "How the user's own posts performed in the feed.",
  "properties": {
    "topPosts": {
      "items": {
        "ref": "#post",
        "type": "ref"
      },
      "type": "array"
    },
    "totalLikes": {
      "type": "integer"
    },
    "totalViews": {
      "type": "integer"
    }
  },
  "required": [
    "totalViews",
    "totalLikes",
    "topPosts"
  ],
  "type": "object"
}

curator object

How the user's likes helped others: people who liked the same posts were shown what else the user liked.

Properties

likesCreated integer Required

No description available.

topPosts array of ref#post Required

No description available.

usersHelped integer Required

No description available.

viewsCreated integer Required

No description available.

View raw schema

{
  "description": "How the user's likes helped others: people who liked the same posts were shown what else the user liked.",
  "properties": {
    "likesCreated": {
      "type": "integer"
    },
    "topPosts": {
      "items": {
        "ref": "#post",
        "type": "ref"
      },
      "type": "array"
    },
    "usersHelped": {
      "type": "integer"
    },
    "viewsCreated": {
      "type": "integer"
    }
  },
  "required": [
    "usersHelped",
    "viewsCreated",
    "likesCreated",
    "topPosts"
  ],
  "type": "object"
}

post object

No description available.

Properties

likes integer Required

No description available.

uniqueViewers integer Optional

No description available.

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

url string uri Required

A valid URI.

View raw schema

{
  "properties": {
    "likes": {
      "type": "integer"
    },
    "uniqueViewers": {
      "type": "integer"
    },
    "uri": {
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "url",
    "likes"
  ],
  "type": "object"
}