surveygizmo/surveygizmo-api

Official PHP library for SurveyGizmo API

Official PHP library for SurveyGizmo API

, _(*1)

Summary

The library is intended to make integrating with SurveyGizmo easier and quicker than using the API directly. The following objects are supported via this library and are all namespaced under SurveyGizmo (e.g. \SurveyGizmo\Resources\Survey)., _(*2)

Requirements

• PHP 5.3+
• cURL
• Active SurveyGizmo Account

Recommended Installation

This library is now available in packagist, and you can include surveygizmo/surveygizmo-api in your composer configuration files to autoload it:, _(*3)

$ composer require surveygizmo/surveygizmo-api
Using version ^1.0 for surveygizmo/surveygizmo-api
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
  - Installing surveygizmo/surveygizmo-api (v1.0.3-stable): Loading from cache
Writing lock file
Generating autoload files

Manual Installation

1. Download the library and add it to your project.
2. Include the SurveyGizmoAutoLoader.php file, replacing <LIBRARY_PATH> with the appropriate path.

require_once "<LIBRARY_PATH>/SurveyGizmoAutoLoader.php";

Configuration

1. If you are not using our US data center, you will need to choose the appropriate region (US, CA, or EU). If you are not sure if you are using the US, EU, or CA API, see: https://apihelp.surveygizmo.com/help/us-eu-or-ca-api

try {
    \SurveyGizmo\SurveyGizmoAPI::setRegion('EU');
} catch (Exception $e) {
    die('Region not available');
}

1. Authenticate using your SurveyGizmo API Key and Secret.

try {
    \SurveyGizmo\SurveyGizmoAPI::auth("<YOUR API_KEY>", "<YOUR API_SECRET>");
} catch (Exception $e) {
    die("Error Authenticating");
}

1. If needed, configure rate limiting.

//set max retries of requests to 10, when request is rate limited it will be retried after 5 seconds.
\SurveyGizmo\ApiRequest::setRepeatRateLimitedRequest(10);

1. If needed, configure the request timeout duration (in seconds, defaults to 35 if not specified)

//this is the maximum wait period before aborting requests, you may need to
//increase this from the default of 35 seconds if working with oversize surveys
\SurveyGizmo\ApiRequest::setRequestTimeout(60);

Code Samples

Please refer to the Samples folder for more thorough example use cases., _(*4)

To use these samples, copy the example file and then supply your own credentials:, _(*5)

$ cd Samples
$ cp .credentials.example .credentials
$ vi .credentials # then supply your credentials accordingly
$ php new_survey.php # run once prior to running manipulate_survey.php
$ php manipulate_survey.php

Supported Objects

• Survey
  • Responses
  • Questions
  • Pages
  • Statistics
  • Reports
  • Campaigns
  • EmailMessages
• Account
  • Users
  • Teams
• Contacts
• ContactLists
  • Contacts

API Object Reference

This Library uses the version 5 SurveyGizmo API, please refer to our API Documentation for more information., _(*6)

All objects use the following standard functions:

<OBJECT>::fetch(<FILTERS>,<OPTIONS>);

Returns an array of objects based on filter and paging options., _(*7)

<OBJECT>::get($id);

Returns a single object based on id, _(*8)

<OBJECT>->save();

Saves a newly created or updated instance of an object, _(*9)

<OBJECT>->delete();

Deletes an instance of an object, _(*10)

Surveys

Fetching Surveys

See filter and paging below., _(*11)

$surveys = \SurveyGizmo\Resources\Survey::fetch(<FILTER>,<OPTIONS>);

Getting a Single Survey

$survey_id = <SURVEY_ID>;
$survey = \SurveyGizmo\Resources\Survey::get(survey_id);

Updating a Survey

$survey->title = "TEST UPDATE FROM API LIBRARY";
$survey->save();

Creating a Survey

$survey = new \SurveyGizmo\Resources\Survey();
$survey->title = "NEW SURVEY";
$results = $survey->save();

Deleting a Survey

$survey = $survey->delete();

Survey Helper Functions

The Survey object provides a few help functions to easily access related collections and objects., _(*12)

    //get questions
    $survey->getQuestions(<FILTER>,<PAGE>);
    $survey->getQuestion($question_id);
    //get responses
    $survey->getResponses(<FILTER>,<PAGE>);
    $survey->getResponse($id);
    //get reports
    $survey->getReports(<FILTER>,<PAGE>);
    $survey->getReport($id);
    //get statistics
    $survey->getStatistics();
    $survey->getStatisticsByID($question_id);
    //get campaigns
    $survey->getCampaigns();
    $survey->getCampaign($id);
    //get email messages
    $survey->getCampaign($id)->getEmailMessages();
    $survey->getCampaign($id)->getEmailMessage($email_id);

Questions

To access the questions on a survey you'll need an instance of a \SurveyGizmo\Resources\Survey object., _(*13)

Get all Survey Questions

$questions = $survey->getQuestions();

Getting and Updating a Survey Question

$question = $survey->getQuestion(<QUESTION question_id>);
$question->title->English = "LIBRARY TEST";
$ret = $question->save();

Responses

To access the responses for a survey you'll need an instance of a \SurveyGizmo\Resources\Survey object. See filter and paging below., _(*14)

Get all Survey Responses

$responses = $survey->getResponses(<FILTER>,<OPTIONS>);

Get a Single Responses

$responses = $survey->getResponse(<RESPONSE_ID);

Update a Responses

$response->survey_data[$question_id]['answer'] = 'YES';
$ret = $response->save();

Filtering & Paging Objects

All fetch methods take both optional $filter and $options arguments., _(*15)

Filtering

$filter = new \SurveyGizmo\Helpers\Filter();
$filter_item = new \SurveyGizmo\Helpers\FilterItem();
$filter_item->setField('title');
$filter_item->setOperator('=');
$filter_item->setCondition('TEST from API');
$filter->addFilterItem($filter_item);
$surveys = \SurveyGizmo\Resources\Survey::fetch($filter);

Paging Collections

Sometimes you will need to page through collections of objects. To accommodate this use the optional $options argument on any fetch method;, _(*16)

$options = array( 'page' => 3, 'limit' => 100 );
$surveys = \SurveyGizmo\Resources\Survey::fetch($filter,$options);

Error Messages & Responses

In the case of an error we will return the following responses and status codes:, _(*17)

Method not implemented (404)
Method not supported (405)
Not Authorized (401)

Simple API request

To perform a API call without going through a specific resource class, use \SurveyGizmo\ApiRequest::call., _(*18)

$response = \SurveyGizmo\ApiRequest::call('contactlist', null, null, null);

Tests

Unit tests are included under the /Tests directory. They can be run by calling PHPUnit within the Tests folder:, _(*19)

$ phpunit

Contributors

The library was developed and is maintained by the SurveyGizmo Development Team., _(*20)

License

This project is licensed under the terms of the MIT license., _(*21)