{"__v":6,"_id":"572cbaa07c8eff0e00aaa296","category":{"project":"54343170fa5527080064f449","version":"54343531bfaa3d0800c4d4af","_id":"572cba2fc310640e008f63d5","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-06T15:37:19.128Z","from_sync":false,"order":10,"slug":"ratings","title":"Ratings"},"parentDoc":null,"project":"54343170fa5527080064f449","user":"54b5782696fe3c0b00d38d82","version":{"__v":27,"_id":"54343531bfaa3d0800c4d4af","forked_from":"54343170fa5527080064f44c","project":"54343170fa5527080064f449","createdAt":"2014-10-07T18:47:13.086Z","releaseDate":"2014-10-07T18:47:13.086Z","categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-06T15:39:12.671Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"MediaSilo contains the ability for users to rate assets that they have access to.\n\nRatings are on an integer scale from 1-5 inclusive. Authenticated users can submit their rating of an asset and see all ratings that other users have submitted.\n\nMediaSilo automatically computes the average rating on an asset, which appears in the \"averageRating\" on the [asset object](http://docs.mediasilo.com/docs/assets-overview). All ratings are weighted equally in this average.\n\nAll users who can view an asset are able to see the average rating, but a user is required to have a role with COLLABORATION/RATE [permission](http://docs.mediasilo.com/docs/overview-7) to submit a rating or view individual ratings for assets within a project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"owner\\\": {\\n      \\\"id\\\": \\\"11E2F04C-FF3C-56DA-59F43029C949095A\\\",\\n      \\\"firstName\\\": \\\"Jared\\\",\\n      \\\"lastName\\\": \\\"User\\\",\\n      \\\"userName\\\": \\\"jared\\\",\\n      \\\"tags\\\": [],\\n      \\\"email\\\": \\\"email:::at:::domain.com\\\",\\n    },\\n    \\\"dateCreated\\\": 1462545946000,\\n    \\\"rating\\\": 4\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nRating Endpoint Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Data Point\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**owner**\",\n    \"1-0\": \"**dateCreated**\",\n    \"2-0\": \"**rating**\",\n    \"2-1\": \"The user's rating, on a scale of 1-5, integers only\",\n    \"1-1\": \"The date the user submitted a rating\",\n    \"0-1\": \"User info for the person who submitted the rating\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"approvalStatus\\\": \\\"pending\\\",\\n    \\\"archiveStatus\\\": \\\"n/a\\\",\\n    \\\"averageRating\\\": 4,\\n    \\\"commentCount\\\": 2,\\n    \\\"dateCreated\\\": 1410902367000,\\n    \\\"dateModified\\\": 1412880990000,\\n    \\\"derivatives\\\": [\\n      {\\n        \\\"duration\\\": 21890,\\n        \\\"fileSize\\\": 4977,\\n        \\\"height\\\": 1080,\\n        \\\"type\\\": \\\"source\\\",\\n        \\\"url\\\": \\\"https://d123mqjywc428u.cloudfront.net/...\\\",\\n        \\\"width\\\": 1920\\n      },\\n      {\\n        \\\"duration\\\": 21890,\\n        \\\"fileSize\\\": 4977,\\n        \\\"height\\\": 1080,\\n        \\\"posterFrame\\\": \\\"https://s3.amazonaws.com/...\\\",\\n        \\\"strategies\\\": [\\n          {\\n            \\\"streamer\\\": \\\"rtmp://s37758y8jcblwg.cloudfront.net/cfx/st\\\",\\n            \\\"type\\\": \\\"rtmp\\\",\\n            \\\"url\\\": \\\"709352581VSEJ/...\\\"\\n          },\\n          {\\n            \\\"streamer\\\": \\\"rtmpt://s37758y8jcblwg.cloudfront.net/cfx/st\\\",\\n            \\\"type\\\": \\\"rtmpt\\\",\\n            \\\"url\\\": \\\"709352581VSEJ...\\\"\\n          }\\n        ],\\n        \\\"thumbnail\\\": \\\"https://s3.amazonaws.com...\\\",\\n        \\\"type\\\": \\\"proxy\\\",\\n        \\\"url\\\": \\\"https://d123mqjywc428u.cloudfront.net/...\\\",\\n        \\\"width\\\": 1920\\n      }\\n    ],\\n    \\\"description\\\": \\\"\\\",\\n    \\\"duration\\\": 21890,\\n    \\\"external\\\": false,\\n    \\\"fileName\\\": \\\"A033_C381_0705QE_4K169.mp4\\\",\\n    \\\"folderId\\\": null,\\n    \\\"id\\\": \\\"80559D7F-F3B5-06D6-78A4434B69BAA8FF\\\",\\n    \\\"myRating\\\": null,\\n    \\\"permissions\\\": [\\n      \\\"collaboration.requestapproval\\\",\\n      \\\"collaboration.comment\\\",\\n      \\\"collaboration.rate\\\",\\n      \\\"asset.create\\\",\\n      \\\"asset.update\\\",\\n      \\\"asset.delete\\\",\\n      \\\"asset.read\\\",\\n      \\\"asset.source\\\",\\n      \\\"sharing.internal\\\",\\n      \\\"sharing.external\\\",\\n      \\\"service.transcript\\\",\\n      \\\"reporting.export\\\"\\n    ],\\n    \\\"posterFrame\\\": \\\"https://s3.amazonaws.com...\\\",\\n    \\\"private\\\": false,\\n    \\\"progress\\\": 100,\\n    \\\"projectId\\\": \\\"A3C149F7-C48A-F55F-A5060AAFDE60233D\\\",\\n    \\\"tags\\\": [\\n    ],\\n    \\\"title\\\": \\\"A033_C381_0705QE_4K169.mp4\\\",\\n    \\\"transcriptStatus\\\": \\\"N/A\\\",\\n    \\\"type\\\": \\\"video\\\",\\n    \\\"uploadedBy\\\": \\\"demo\\\"\\n  }\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nAsset Endpoint Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Data Point\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**averageRating**\",\n    \"0-1\": \"The average rating from all users who have submitted ratings for the asset\",\n    \"1-0\": \"**myRating**\",\n    \"1-1\": \"Not currently used. Use the /ratings endpoint to query for individual user ratings.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"How Ratings work in MediaSilo","slug":"overview-9","type":"basic","title":"Overview"}

Overview

How Ratings work in MediaSilo

MediaSilo contains the ability for users to rate assets that they have access to. Ratings are on an integer scale from 1-5 inclusive. Authenticated users can submit their rating of an asset and see all ratings that other users have submitted. MediaSilo automatically computes the average rating on an asset, which appears in the "averageRating" on the [asset object](http://docs.mediasilo.com/docs/assets-overview). All ratings are weighted equally in this average. All users who can view an asset are able to see the average rating, but a user is required to have a role with COLLABORATION/RATE [permission](http://docs.mediasilo.com/docs/overview-7) to submit a rating or view individual ratings for assets within a project. [block:code] { "codes": [ { "code": "{\n \"owner\": {\n \"id\": \"11E2F04C-FF3C-56DA-59F43029C949095A\",\n \"firstName\": \"Jared\",\n \"lastName\": \"User\",\n \"userName\": \"jared\",\n \"tags\": [],\n \"email\": \"email@domain.com\",\n },\n \"dateCreated\": 1462545946000,\n \"rating\": 4\n }", "language": "json" } ] } [/block] Rating Endpoint Response [block:parameters] { "data": { "h-0": "Data Point", "h-1": "Description", "0-0": "**owner**", "1-0": "**dateCreated**", "2-0": "**rating**", "2-1": "The user's rating, on a scale of 1-5, integers only", "1-1": "The date the user submitted a rating", "0-1": "User info for the person who submitted the rating" }, "cols": 2, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "[\n {\n \"approvalStatus\": \"pending\",\n \"archiveStatus\": \"n/a\",\n \"averageRating\": 4,\n \"commentCount\": 2,\n \"dateCreated\": 1410902367000,\n \"dateModified\": 1412880990000,\n \"derivatives\": [\n {\n \"duration\": 21890,\n \"fileSize\": 4977,\n \"height\": 1080,\n \"type\": \"source\",\n \"url\": \"https://d123mqjywc428u.cloudfront.net/...\",\n \"width\": 1920\n },\n {\n \"duration\": 21890,\n \"fileSize\": 4977,\n \"height\": 1080,\n \"posterFrame\": \"https://s3.amazonaws.com/...\",\n \"strategies\": [\n {\n \"streamer\": \"rtmp://s37758y8jcblwg.cloudfront.net/cfx/st\",\n \"type\": \"rtmp\",\n \"url\": \"709352581VSEJ/...\"\n },\n {\n \"streamer\": \"rtmpt://s37758y8jcblwg.cloudfront.net/cfx/st\",\n \"type\": \"rtmpt\",\n \"url\": \"709352581VSEJ...\"\n }\n ],\n \"thumbnail\": \"https://s3.amazonaws.com...\",\n \"type\": \"proxy\",\n \"url\": \"https://d123mqjywc428u.cloudfront.net/...\",\n \"width\": 1920\n }\n ],\n \"description\": \"\",\n \"duration\": 21890,\n \"external\": false,\n \"fileName\": \"A033_C381_0705QE_4K169.mp4\",\n \"folderId\": null,\n \"id\": \"80559D7F-F3B5-06D6-78A4434B69BAA8FF\",\n \"myRating\": null,\n \"permissions\": [\n \"collaboration.requestapproval\",\n \"collaboration.comment\",\n \"collaboration.rate\",\n \"asset.create\",\n \"asset.update\",\n \"asset.delete\",\n \"asset.read\",\n \"asset.source\",\n \"sharing.internal\",\n \"sharing.external\",\n \"service.transcript\",\n \"reporting.export\"\n ],\n \"posterFrame\": \"https://s3.amazonaws.com...\",\n \"private\": false,\n \"progress\": 100,\n \"projectId\": \"A3C149F7-C48A-F55F-A5060AAFDE60233D\",\n \"tags\": [\n ],\n \"title\": \"A033_C381_0705QE_4K169.mp4\",\n \"transcriptStatus\": \"N/A\",\n \"type\": \"video\",\n \"uploadedBy\": \"demo\"\n }\n]", "language": "json" } ] } [/block] Asset Endpoint Response [block:parameters] { "data": { "h-0": "Data Point", "h-1": "Description", "0-0": "**averageRating**", "0-1": "The average rating from all users who have submitted ratings for the asset", "1-0": "**myRating**", "1-1": "Not currently used. Use the /ratings endpoint to query for individual user ratings." }, "cols": 2, "rows": 2 } [/block]