The Comments API

On this Page

  1. Introduction
  2. The Request Format
  3. Sample Response
  4. The <Comment> Element

Other APIs

  1. API Introduction
  2. Forms GET
  3. Fields GET
  4. Entries GET / POST
  5. Users GET
  6. Reports GET
  7. Widgets GET
  8. Comments GET
  9. Web Hooks PUT / DELETE
  10. Login POST
  11. Examples
  12. The Wufoo REST Principles


Introduction

The Comments API is used to gather details about comments you’ve made on forms you have permission to view.

Example Comments API Call

If you are unsure how to get started with our API’s, please read our intro page for information on authenticating, sending and processing your request.

Request Format

This API accepts GET requests in the following two formats:

https://{subdomain}.wufoo.com/api/v3/forms/{formIdentifier}/comments.{xml|json}?[pretty=true]&[entryId={entryId}]&[pageStart={pageStart}]&[pageSize={pageSize}]

and

https://{subdomain}.wufoo.com/api/v3/forms/{formIdentifier}/comments/count.{xml|json}?[pretty=true]&[entryId={entryId}]

The expected parameters for this request are:

  • {subdomain} - This must be replaced with your Wufoo account subdomain.

  • {xml|json} - Choose xml or json as your output type.

  • {formIdentifier} - Adding the {formIdentifier} will give you information about just one form. The call without the {formIdentifier} will return all forms.

  • pretty=true - The optional pretty=true get parameter formats your output as HTML for debugging through the browser.

  • entryId={entryId} - If you add this parameter and specify a numeric {entryId}, the call will be filtered to return only the entry specified in the {entryId} placeholder. If this parameter is omitted, no filter will be applied and all comments for the form (within the pageSize) will be displayed instead.

  • pageSize={pageSize} - If you add this parameter and specify a numeric {pageSize}, the API will respond with a page of comments up to the value specified in the {pageSize} placeholder. In other words, if you have 10 comments and you specified a {pageSize} of 5, you’d receive 5 comments.

  • pageStart={pageStart} - If you add this parameter and specify a numeric {pageStart}, the API will respond with a page of comments, beginning from the {pageStart}. So, if you have 10 comments and you specify a {pageSize} of 5 and a {pageStart} of 5, you’ll be returned comments 6 through 10.

Sample Response

Below is a sample response from a fictional call to the Comments API.

<Comments>
    <Comment>
        <CommentId>4</CommentId>
        <CommentedBy>Timmy</Name>
        <DateCreated>2010-06-15 14:43:03</Date>
        <EntryId>125</EntryId>
        <Text>Hi there, I'm a comment!</Text>
    </Comment>
</Comments>

The Element

The <Comment> element lives inside the parent. Zero to many <Comment> elements can exist for each Entry Id on your system. This means that each entry can have an unlimited number of comments.

Values for the <Comment> element are defined below.

  • CommentId - A unique ID for this comment.

  • CommentedBy - The name of the person who commented on this entry.

  • DateCreated - The date on which the comment was made.

  • EntryId - Is the unique ID of the entry to which this comment is associated.

  • Text - The comment itself.

Updated : October 21st, 2010