KAkareadita
Stream

Returns the layout of the user's dashboard

Changed on
get/api/Stream/dashboard

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Stream/dashboard
  • Auth
    API key in header x-api-key

Query parameters

visibleOnlyboolean

Response

OK

idinteger
namestring nullable required
isProvidedboolean
orderinteger
smartFilterEncodedstring nullable
smartFilterIdinteger nullable
streamType1 | 2 | 3 | 4

Members:

  • 1 — OnDeck
  • 2 — RecentlyUpdated
  • 3 — NewlyAdded
  • 4 — SmartFilter
visibleboolean
entityType0 | 1 | 2 | 3

Members:

  • 0 — Series
  • 1 — Reading List (ReadingList)
  • 2 — Person
  • 3 — Annotation

Changes

  • 58caf8bfeda1Revision changes
    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

  • 3ca5068a5435Revision changes
    • info

      removed the 5.00 enum value from the / response property for the response status (media type: text/plain)

    • info

      removed the 5.00 enum value from the / response property for the response status (media type: application/json)

    • info

      removed the 5.00 enum value from the / response property for the response status (media type: text/json)