API documentation

Feedback

index

List all feedback for a site.

Resource URL

GET https://feedleback.com/api/v1/sites/site_id/feedbacks

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

search
Optional
Search the URL (not just the path) for a keyword
vote
Optional
"yes" or "no"
show_hidden
Optional
When set to 1, the response will include hidden feedback only
page
Optional
Specifies the offset when paginating results
limit
Optional
Specifies the number of results per page

store

Create new feedback

Resource URL

POST https://feedleback.com/api/v1/sites/site_id/feedbacks

Resource information

Response formats
JSON
Must authenticate?
No
Rate limited?
No

Parameters

fields
Required
A JSON object with the following properties:
fields.vote
Required
"yes" or "no"
fields.comment
Optional
A text string
fields.url
Required
The URL that the feedback belongs to

show

Get a single piece of feedback

Resource URL

GET https://feedleback.com/api/v1/sites/site_id/feedbacks/feedback_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

update

Update a piece of feedback

Resource URL

PUT https://feedleback.com/api/v1/sites/site_id/feedbacks/feedback_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

fields
Required
A JSON object with the following properties:
fields.vote
Optional
"yes" or "no"
fields.comment
Optional
A text string
fields.url
Optional
The URL that the feedback belongs to
fields.hide
Optional
Specifies if the feedback should be hidden or visible. Set to true or false.

destroy

Delete a piece of feedback

Resource URL

DELETE https://feedleback.com/api/v1/sites/site_id/feedbacks/feedback_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

Site

index

List all sites you have access to.

Resource URL

GET https://feedleback.com/api/v1/sites

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

page
Optional
Specifies the offset when paginating results
limit
Optional
Specifies the number of results per page

store

Create new site

Resource URL

POST https://feedleback.com/api/v1/sites

Resource information

Response formats
JSON
Must authenticate?
No
Rate limited?
No

Parameters

name
Required
What to call the site
comments_expire
Number of days before deleting comments while otherwise keeping the feedback

show

Show information about a site

Resource URL

GET https://feedleback.com/api/v1/sites/site_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

update

Update a site

Resource URL

PUT https://feedleback.com/api/v1/sites/site_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

name
What to call the site
comments_expire
Number of days before deleting comments while otherwise keeping the feedback

destroy

Delete a site

Resource URL

DELETE https://feedleback.com/api/v1/sites/site_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

User

index

List all users for a site

Resource URL

GET https://feedleback.com/api/v1/sites/site_id/users

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

page
Optional
Specifies the offset when paginating results
limit
Optional
Specifies the number of results per page

store

Give a user access to a site

Resource URL

POST https://feedleback.com/api/v1/sites/site_id/users

Resource information

Response formats
JSON
Must authenticate?
No
Rate limited?
No

Parameters

email
Required
The e-mail address you want to give access to
notify
Whether to notify the user by e-mail or not (true or false)

show

Get information about a user

Resource URL

GET https://feedleback.com/api/v1/sites/site_id/users/user_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

destroy

Remove a user from a site

Resource URL

DELETE https://feedleback.com/api/v1/sites/site_id/users/user_id

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

Statistics

paths

Show statistics for each page (the path part of URL).

Resource URL

GET https://feedleback.com/api/v1/sites/site_id/statistics/paths

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

search
Optional
Search the URL (not just the path) for a keyword
from_date
Optional
Include feedback starting from this date
to_date
Optional
Include feedback up until this date
page
Optional
Specifies the offset when paginating results
limit
Optional
Specifies the number of results per page

summary

Show a summary of statistics for the site.

Resource URL

GET https://feedleback.com/api/v1/sites/site_id/statistics/summary

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

search
Optional
Search the URL (not just the path) for a keyword
from_date
Optional
Include feedback starting from this date
to_date
Optional
Include feedback up until this date

Account

show

Show information about your own account.

Resource URL

GET https://feedleback.com/api/v1/account

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

token

Generate a new API token.

Resource URL

GET https://feedleback.com/api/v1/account/token

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None

destroy

Delete your account.

Resource URL

DELETE https://feedleback.com/api/v1/account

Resource information

Response formats
JSON
Must authenticate?
Yes
Rate limited?
Yes
Requests / minute
60

Parameters

None


Updated