Get a ranked Hover awareness projection

GET https://app.hover.team/api/v1/hover/awareness

Returns either For You (personal relevance) or Team Pulse (shared importance) over the requesting teammate's confirmed Contributor and Subscriber Spaces. Items reference canonical native messages and Hover records; the projection does not copy Review, lineage, Todo, or read state.

Changes: New in Zulip 12.0 (feature level ZF-hover-awareness).

Usage examples

curl -sSX GET -G https://app.hover.team/api/v1/hover/awareness \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'surface="for_you"'

Parameters

Response

Return values

• surface: string

  The surface value. * items: (object)[]

  The items value. * message_id: integer

  The `message_id` value.
  

  • generated_item_id: integer

    The generated_item_id value. * space_id: integer

    The space_id value. * space_name: string

    The space_name value. * stream_id: integer

    The stream_id value. * topic: string

    The topic value. * rendered_content: string

    The rendered_content value. * sender_id: integer

    The sender_id value. * sender_name: string

    The sender_name value. * timestamp: string

    The timestamp value. * is_unread: boolean

    The is_unread value. * rank: integer

    The rank value. * reasons: (string)[]

    The reasons value. * hover_generated_item: object

    Canonical Hover generated-item metadata, including reviewed state, revisions, disputes, evidence, lineage, and Todo when present.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "items": [],
    "msg": "",
    "result": "success",
    "surface": "for_you"
}