The Reports API

On this Page

  1. Introduction
  2. The Request Format
  3. Sample Response
  4. The <Report> 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 Reports API is used to gather details about the reports you have permission to view.

Example Reports 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 formats:

https://{subdomain}.wufoo.com/api/v3/reports.{xml|json}[?pretty=true]

and

https://{subdomain}.wufoo.com/api/v3/reports/{reportIdentifier}.{xml|json}[?pretty=true]

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

  • {formIdentifier} - This placeholder must be replaced with your URL or hash.

  • {xml|json} - You must choose between xml or json

  • {pretty=true} - This optional parameter formats your output as HTML for debugging through the browser.

  • {reportIdentifier} - Adding this placeholder will give you information about just one report. The call without the {reportIdentifier} will return all reports.

Sample Response

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

<Report>
    <Name>My Awesome Report</Name>
    <IsPublic>0</IsPublic>
    <Url>my-awesome-report</Url>
    <Description>This is my report. View it in all its glory!</Description>
    <DateCreated>2010-03-31 11:59:49</DateCreated>
    <DateUpdated>2010-04-01 10:13:07</DateUpdated>
    <Hash>z5p8w8</Hash>
</Report>

The <Report> Element

The <Report> element lives inside the parent. One <Report> element exists for each form on your system. So, if you have 5 forms in your account and you’re permitted to see the all, you’ll have 5 <Report> elements in the return value from your API call.

Values for the <Report> element are defined below.

  • Name - This is the friendly name you chose when creating this form.

  • IsPublic - Indicates whether or not the report is accessible through the Url by the general public. This value is binary (1 = true, 0 = false).

  • Url - This is the URL for your form. Beware using the URL for API or linking purposes because it changes with the report title.

  • Description - Your description of the report.

  • DateCreated - A timestamp of when the report was created.

  • DateUpdated - A timestamp of when the report was lasted edited in the Wufoo Report Builder.

  • Hash - An unchanging hashed value unique to this report on this user’s account.

Updated : October 21st, 2010