PurrOSDocs

Team Displays

Live display metrics and recognition shout-outs for team displays.

For how this area works day to day, see the Team displays guide.

Webhook events: recognition.posted. See Webhooks.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

  • GET/display-metrics

    Live display metrics

    Keyreports:read
    Peopleanyone
    Featuredisplays
  • POST/display-metrics

    Push live numbers to team displays

    Keyreports:write
    Peoplenot allowed
    Featuredisplays
  • GET/recognitions

    Recent shout-outs (newest first)

    Keycommunication:read
    Peopleanyone
    Featuredisplays.gamification
  • POST/recognitions

    Post a shout-out

    Keycommunication:write
    Peoplerecognition.give
    Featuredisplays.gamification