List top comments within an entire spot

get

https://api.openweb.com/engagement-api/top-comments-spot

Retrieve the top comments for a Spot ID in a given time period

Headers

x-api-key

string

required

Unique OpenWeb engagement token

Follow these steps to obtain the engagement token:

NOTE: This value must not be exposed to users.

x-spot-id

string

required

Spot ID of the partner

x-count

integer

Defaults to 10

Number of comments to return

x-interval

string

enum

Defaults to two-months

Period of time to return comments

Allowed:

x-month

integer

1 to 12

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.

x-weeks

string

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.

x-year

integer

Year of the time range

The current year is the default value.

Response

200Example response