Use the following parameters to efficiently find reviews and comments with specific properties and display them according to your needs. These parameters allow you to customize how the discussion data is presented in API responses.
| Parameter | Default value | Description |
|---|---|---|
page |
1 |
Show all reviews and comments on the output page with the specified number. |
items_per_page |
10 |
The number of reviews and comments displayed on the output page. |
sort_by |
timestamp |
Sort reviews and comments by name, ip_address, timestamp or status. |
sort_order |
desc |
Ascending or descending sorting order: asc or desc. |
status |
desc |
Filter reviews and comments by status. Possible values: A (active) or D (disabled). |
name |
Filter reviews and comments by names. | |
message |
Filter reviews and comments by their content. | |
type |
Filter reviews and comments by type:
C - commentaries
R - reviews
B - both |
|
ip_address |
Filter reviews and comments by IP address. | |
rating_value |
Filter reviews and comments by rating. | |
object_type |
Filter reviews and comments by their object:
P - product
C - category
A - page
O - order
E - home page |
|
object_id |
Filter reviews and comments by object ID. | |
period |
A |
Filter by time period:
A - all the time
D - today
LD - previous day
W - current week
LW - previous week
M - current month
LM - last month
Y - current year
LY - last year
HH - last 24 hours
HW - last 7 days
HM - last 30 days
C - specified time period (use with time_from and time_to) |
time_from |
Filter by the specified time period: beginning of the time period. | |
time_to |
Filter by the specified time period: end of the time period. |
object_type=P with rating_value=5 to find all 5-star product reviews.
https://www.venddor.com.br/api/2.0/discussions?items_per_page=20
Response is an array with 20 reviews and comments from the 1st page.
https://www.venddor.com.br/api/2.0/discussions?page=5&items_per_page=20
Response is an array with 20 reviews from the 5th output page.
https://www.venddor.com.br/api/2.0/products/167/discussions
Response is an array with reviews and comments about the product with product_id=167.