Add documentation about play endpoints.

martindale · Apr 5, 2015 · ee4f53e · ee4f53e
1 parent cc911e8
commit ee4f53e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -58,6 +58,15 @@ Chat messages for a specific room.
 `:roomSlug\.yourdomain\.tld/chat`
 `GET` retrives a list of the most recent messages, `POST` to create a message.
 
+## Play
+Moments when a track has been "played" in a Room; there are special rules for when it's considered a play, following last.fm's scrobbling rules.  Only if more than 30s of a track has been listened to, and counting as a play when 2 minutes or half the track has been played, whichever happens first.
+
+`:roomSlug\.yourdomain\.tld/plays`
+`GET` retrieves a list of all plays for a room.
+
+`/:usernameSlug/plays`
+`GET` to retrieve a list of all plays by a specific user.
+
 ## Source
 Audio sources and their appropriate metadata.  Not yet functional.