{"info":{"_postman_id":"c121a883-a0bb-40fc-b469-930badd4996f","name":"Yet Another Stars Rating Rest API","description":"

Yet Another Stars Rating (YASR) 2.5.0+ is fully integrated with the WordPress REST API.

Requirements

YASR 2.5.0+
Wordpress 5.0+
Pretty permalinks in Settings > Permalinks so that the custom endpoints are supported. Default permalinks will not work.
You may access the API over either HTTP or HTTPS, but HTTPS is recommended where possible.

Request/Response Format

The default response format is JSON.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29387224","collectionId":"c121a883-a0bb-40fc-b469-930badd4996f","publishedId":"2s9Y5bNzsu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-30T07:02:28.000Z"},"item":[{"name":"Overall Rating","id":"49708fc6-f034-4337-8660-17204a9fb102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}wp-json/wp/v2/posts/?_fields=meta.yasr_overall_rating","description":"

Get the overall_rating post meta simply adding yasr_overall_rating to the meta value.

\n","urlObject":{"path":["wp","v2","posts",""],"host":["{{host}}wp-json"],"query":[{"description":{"content":"

(string) required

Returning values

(int)  overall rating\n

","type":"text/plain"},"key":"_fields","value":"meta.yasr_overall_rating"}],"variable":[]}},"response":[],"_postman_id":"49708fc6-f034-4337-8660-17204a9fb102"},{"name":"Visitor Votes","id":"9a92b647-8e8d-46d2-8ca2-679fee5c130c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}wp-json/wp/v2/posts/?_fields=yasr_visitor_votes","description":"

YASR adds a new custom field called yasr_visitor_votes to the standard endpoint wp-json/wp/v2/POSTTYPE/<POSTID>

\n","urlObject":{"path":["wp","v2","posts",""],"host":["{{host}}wp-json"],"query":[{"description":{"content":"

(string) required

Returning values

(int)  number_of_votes  \n(int)  sum_votes  \n(array) stars attribute {  \n   (bool) read_only  \n   (bool | string) span_bottom  \n}\n

","type":"text/plain"},"key":"_fields","value":"yasr_visitor_votes"}],"variable":[]}},"response":[],"_postman_id":"9a92b647-8e8d-46d2-8ca2-679fee5c130c"},{"name":"MultiSet","id":"ec76bb5f-ed58-40da-8c5d-7b6e848c59a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/wp-json/yet-another-stars-rating/v1/yasr-multiset/","description":"

Get Multi Set ratings

Yasr Multi Set endpoint.

Get ratings for a specified Multi Set used into a post, page, CPT or comment.

\n","urlObject":{"path":["wp-json","yet-another-stars-rating","v1","yasr-multiset",""],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"

(int) Required

The set ID

\n","type":"text/plain"},"key":"set_id","value":""},{"disabled":true,"description":{"content":"

(int) Optional if comment_id is provided, required otherwise

post, page or CPT id

\n","type":"text/plain"},"key":"post_id","value":""},{"disabled":true,"description":{"content":"

(int) Optional

get data from yasr_visitor_multiset instead of yasr_multiset

\n","type":"text/plain"},"key":"visitor","value":""},{"disabled":true,"description":{"content":"

(int) Optional

If pro version is used, get multiset data from a comment_id

\n","type":"text/plain"},"key":"comment_id","value":""}],"variable":[]}},"response":[],"_postman_id":"ec76bb5f-ed58-40da-8c5d-7b6e848c59a6"},{"name":"Rankings","id":"862e771b-7b27-4bff-9c35-39594489df34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/wp-json/yet-another-stars-rating/v1/yasr-rankings/","description":"

Yasr Ranking endpoint.

source is the only required params

\n","urlObject":{"path":["wp-json","yet-another-stars-rating","v1","yasr-rankings",""],"host":["{{host}}"],"query":[{"disabled":true,"description":{"content":"

(string) Required

Accepted values

overall_rating
visitor_votes
visitor_multi
comments

\n","type":"text/plain"},"key":"source","value":""},{"disabled":true,"description":{"content":"

(int) optional\nWorks only if source === 'visitor_multi' or === 'author_multi'\nThe set ID. Optional if only one Multi Set is used or if you want to show the first Multi Set.\ndefault: lower ID.

\n","type":"text/plain"},"key":"setid","value":""},{"disabled":true,"description":{"content":"

(string) Optional.
The ranking to return, ordered by MOST rated or HIGHEST rated

Accepted values (case insensitive)

most
highet

default: 'most'

Doesn't work if source === 'overall_rating'

\n","type":"text/plain"},"key":"show","value":""},{"disabled":true,"description":{"content":"

PRO ONLY

(string) Optional\n Accepted values (case insensitive):

ASC
DESC.

Default: DESC

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

PRO ONLY

(int) Optional\n INT between 1 and 100

Default: 10

\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"

PRO ONLY

Optional\nAccepted values: comma separated value of ints (e.g. INT, INT, INT).

Default: false

\n","type":"text/plain"},"key":"ctg","value":""},{"disabled":true,"description":{"content":"

PRO ONLY

(string) Optional

If set, must be a (single) valid CPT\n.\nDefault:

\n","type":"text/plain"},"key":"cpt","value":""},{"disabled":true,"description":{"content":"

PRO ONLY

(int) Optional

Set the minimum number of votes (e.g. show only posts with number of votes > 10)

\n","type":"text/plain"},"key":"required_votes","value":""},{"disabled":true,"description":{"content":"

PRO ONLY

(date YYYY-mm-dd) Optional\n start date\n.

Default: ''

\n","type":"text/plain"},"key":"start_date","value":null},{"disabled":true,"description":{"content":"

PRO ONLY

(date YYYY-mm-dd) Optional\n start date

.\nDefault: ''

\n","type":"text/plain"},"key":"end_date","value":null}],"variable":[]}},"response":[],"_postman_id":"862e771b-7b27-4bff-9c35-39594489df34"}]}