List top comments within an entire spot
Retrieve the top comments for a Spot ID in a given time period
Request
- Base URLhttps://api.openweb.com/engagement-api
- URLhttps://api.openweb.com/engagement-api/top-comments-spot
- Authnone declared. Required headers: x-api-key, x-spot-id
Headers
Unique OpenWeb engagement token<br /><br />Follow these steps to obtain the engagement token:<ol><li>From your OpenWeb Admin Dashboard, click <strong>Settings</strong>.</li><li>Under <strong>Authentication Tokens</strong>, copy the <strong>Engagement</strong> value.</li></ol><strong>NOTE:</strong> This value <strong>must not</strong> be exposed to users.
Spot ID of the partner
Number of comments to return
Period of time to return comments
Number of the month within the x-year in which comments were posted
The x-month and x-interval values determines the duration of comments returned:
- If x-month = 3 and x-interval = one-month, the API returns comments posted in March (month 3 of the year).
- If x-month = 3 and x-interval = two-months (default), the API returns comments posted in March (month 3 of the year) and February (the previous month).
Default Value: The month number of the current month.
Number of the week within the x-month of the x-year in which comments were posted
The x-weeks and x-interval values determine the duration of comments returned:
- If x-weeks = 3 and x-interval = one-week, the API returns comments posted in week 3 of the month of the year.
- If x-weeks = 3,4 and x-interval = two-weeks, the API returns comments posted in weeks 3 and 4 of the month of the year.
NOTES:
- If x-interval = two-weeks, the x-weeks value must be defined as two consecutive weeks separated by a comma, 3,4.
- If x-interval = one-month or two-months, the x-weeks value is ignored.
Year of the time range<br /><br />The current year is the default value.
Response
Example response
Changes
No recorded changes to this operation across all 1 revision of this API.