Checkbox Survey Software Checkbox Survey Software
  • Features
    • Survey Creation
      Survey question types, logic, merging, and action options.
    • Survey Look & Feel
      Survey customization, branding, and mobile responsiveness.
    • Survey Distribution
      Email invitations, reminders, embed options, and custom links.
    • Security & Permissions
      Survey permissions, sharing options, SSO, and data security.
    • Results & Reporting
      Data export formats, charts & graphs, report filtering and API.
    • Automation & Integration
      Automatic emails & URL redirects, API, and JavaScript.
    • On-Premises Features
      Overview of on-premises version features and architecture.
    • Full Feature List
      Compare all features and limits for hosted and on-premises plans.
  • Pricing
    • Hosted Plans
      Individual, team and enterprise cloud-hosted plans.
    • On-Premises Software
      Perpetual software licenses, installed on your own servers.
    • White Label & OEM
      Learn about integrating Checkbox into your software for resale.
    • Discounts Programs
      Discounts for academic, government and non-profits.
  • About
    • Clients
      View a sampling of our global customers by industry.
    • Blog
      Company news, announcements, and industry articles.
    • Case Studies
      Learn how some of our clients use Checkbox to streamline operations.
  • Contact Us
  • Support
    • Version 7 Help Guides
      Searchable knowledge base for Checkbox Version 7.
    • Legacy (V6) Help Guides
      Searchable knowledge base for Checkbox Version 6.
    • API Docs
      Documentation for working with the Checkbox Version 7 API.
    • Technical Requirements
      Technical requirements for installing Checkbox on-premises.
    • Support Info & Policies
      Customer support hours, holidays, access information, and terms.
    • Support Login
      Login form for Checkbox on-premises support users.
  • 
  • 
    • Sales/General
      +1 (617) 231-8890
    • Support
      +1 (617) 231-8899
  • Sign In
    • US-hosted
      Sign in page for accounts hosted in the US.
    • Canada-hosted
      Sign in page for accounts hosted in Canada.
    • EU-hosted
      Sign in page for accounts hosted in the EU.
    • UK-hosted
      Sign in page for accounts hosted in the UK.
    • Australia-hosted
      Sign in page for accounts hosted in Australia.
    • Support Login
      Login for on-premises support customers.
  • Try it Free
    • Hosted Trial
      Create a 14-day cloud-hosted trial account. US, Canada, EU, UK, & Australia hosting options.
    • On-Premises Trial
      Download a 30-day on-premises trial to install on your own servers (not for PC/laptop installation).
    • Learn More
      Not sure which option to choose? Learn more about our versions.
Homepage / Doc / Export Responses

Export Responses

The ExportReponsesTabular method will return filtered or unfiltered response data in the format of an IEnumerable SimpleNameValueCollection format which is easy to write to CSV files or insert into databases. The Name will always be the question or property, and the value will always be the answer or value of the field.

As of the 2017 Q2 release, this method will always return at least one response even if there are no responses that match the filter. If no response data matches the filters Checkbox will return a blank response with an id of 0. This is being done to keep the return of the method uniform.
class Test
{
    static void Main()
    {
        var client = new ResponseDataServiceClient();
        var responseData = client.ExportResponsesTabular(authToken, 2297, 1, 3, "UniqueIdentifier", "admin", "",
            true, 1, DateTime.Now.AddYears(-1), DateTime.Now.AddYears(1), false, false, false, false, false, false,
            false, false, false, false);

        if (!responseData.CallSuccess)
        {
            Console.WriteLine(responseData.FailureMessage);
            return;
        }

        foreach (var responses in responseData.ResultData.ResultPage.Responses)
        {
            foreach (var response in responses.NameValueList)
            {
                var output = string.Format("Question  : {0} Answer  : {1}", response.Name, response.Value);
                Console.WriteLine(output);
            }
        }
        // Always close the client.
        client.Close();
    }
}

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
surveyId int Survey Identifier this is either a 4 or 5 digit number
pageNumber int Page number to pull from responses supplying 0 will pull all pages at once
resultsPerpage int Number of results to pull into a single page of responses
filterField string Field to filter response data on. Valid values are : UniqueIdentifier, Invitee, ResponseID, Guid, RespondentGuid
filterValue string Value to filter the FilterField on
sortField string Field to sort the data returned on. Valid values are : UniqueIdentifier, Invitee, ResponseID, Guid, RespondentGuid, StartDate. This value cannot be “null”
sortAscending bool True will sort the data ascending, false will sort the data descending
period int Value should be equal to 1 (Field is used internally)
dtStart DateTime DateTime to be used as the response Start date
dtEnd DateTime DateTime to be used as the response End Date
DetailedReponseInfo bool True will pull detailed response information which includes response meta data
DetailedUserInfo bool True will pull detailed user information such as the entire user profile of the respondents
IncludeOpenEndedResults bool True will pull open ended responses. False will not include any single line or multi line questions / answers
IncludeAliases bool True will replace Questions / Answers with alias values. If no alias value is present for a question it will pull the full question / answer text
IncludeHiddenItems bool True will pull hidden item data collected from the “Hidden Item Page” of the survey
IncludeIncompleteResponses bool True will pull all incomplete responses. Incomplete responses cannot be filtered on by EndDate. This means that if this is set to true, all responses will be pulled regardless of start date.
StripHTMLTagsFromAnswers bool True will remove all styling and HTML code from response answers
StripHTMLTagsFromQuestions bool True will remove all styling and HTML code from survey questions
MergeAnswersForSelectMany bool True will return checkbox item answers in the format of A,B,C where A B C are all options for the question. False will return checkbox item answers in seperate key-value pairs.
includeScoreData bool True will return detailed scoring information such as total score, score per page, and possible score per page
This section is currently under construction. Any documents that appear blank will be populated as soon as possible. If you have any questions or need assistance with something that is not currently documented please feel free to submit a support ticket and we will be glad to assist you.
May 9, 2017

Web Services

  • Getting Started
    • Checking if API Is Live
    • Adding a service reference
  • Authentication
    • Login
  • Responses
    • Export Responses
  • Surveys
    • List Available Surveys
    • List Surveys and Folders
  • Users
    • Get User Data
    • Create User
    • Create User Group
    • Get Users
    • Lock User
    • Unlock User
  • Invitations
    • Create Invitation
    • Update Invitation
    • Add Scheduled Invitation Activity
    • Send Invitation to Filtered Recipient List
    • Create Email List Panel
    • Add Email Address To Email List Panel
    • Add Email List Panels to Invitation
  • Security
  • Styles

 

Checkbox develops affordable, feature-rich survey software for organizations, teams, and individuals. Available as a cloud-hosted subscription or installable software. API, source code and integration options available.

Checkbox Survey Inc.
65 Chapel Street, Newton, MA 02458  USA
General: 1-617-231-8890
Sales: 1-617-231-8891
Support: 1-617-231-8899
info@checkbox.com

  • Features
  • Pricing
  • On-Premises Software
  • Blog
  • Contact Us
  • Pay a Quote/Invoice
  • Support
  • Release Notes
  • API Documentation
  • Hosted SLA
  • Software License Agreement
  • Privacy Policy
©  2002 - Checkbox Survey, Inc.