social.coves.feed.getFeedSkeleton

Get an ordered page of post URIs from a feed generator. Served by the generator's service and called by the AppView, which hydrates the posts.

Repository @coves.social did:web:coves.social namespace authority
Details · query
Kindquery
Authorityfeed.coves.social
Commit rev3n2v225z25226
Indexed

Query

query · GET

Parameters

query string

community

string · did

DID of the community for scope=community

cursor

string
  • maxLength: 500

feed

requiredstring · at-uri

AT-URI of the social.coves.feed.generator record being requested

limit

integer
  • minimum: 1
  • maximum: 100
  • default: 50

scope

requiredstring

Which feed surface the request is for: all communities, the viewer's home feed, or one community

  • maxLength: 64
  • knownValues: all | home | community

timeframe

string

Timeframe for feeds ranked by top score

  • maxLength: 64
  • default: "day"
  • knownValues: hour | day | week | month | year | all

Output

application/json
Reference

Errors

UnknownFeed

The generator does not serve the requested feed.

UnsupportedFeedScope

The generator does not support the requested scope.

InvalidCursor

The cursor is malformed or expired.

#output

object

A page of post URIs in the generator's order

Properties

cursor

string
  • maxLength: 500

feed

requiredarray

reqId

string

Request ID assigned by the generator. The AppView returns it on the hydrated response, and clients send it back with interactions.

  • maxLength: 100

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Get a page of hydrated posts for a feed surface. Without feed, the AppView's default ordering for the scope is used; with feed, the named generator orders the posts.

  • Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.

  • Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.

  • Get a skeleton of a feed provided by a feed generator. Auth is optional, depending on provider requirements, and provides the DID of the requester. Implemented by Feed Generator Service.

  • A page of a feed's items, newest first by the feed's sort. The caller hydrates them.