SurveyReport Sub-Object v5

The following API calls are currently available for the SurveyReport object. The SurveyReport object only accesses the following report types: Summary, TURF and Profile.

GET LIST - Get a list of all of your survey reports.

https://restapi.surveygizmo.com/v5/survey/123456/surveyreport
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
types summary, profile, turf False
Response Example (.debug format):

Array
(
    [result_ok] => 1
    [total_count] => 3
    [results_per_page] => 3
    [data] => Array
        (
            [0] => Array
                (
                    [id] => 2417084
                    [survey_id] => 1425543
                    [name] => Summary Report - 29 October 2013
                    [type] => summary
                    [status] => Active
                    [last_run] => 2013-10-29 12:47:45
                    [responses] => 401
                    [version] => 3
                    [publish_link] => https://appv3.sgizmo.com/reportsview/?key=160589-2417084-b5b5c6032f894df5d74c5897cdc87980
                )

            [1] => Array
                (
                    [id] => 2416900
                    [survey_id] => 1425543
                    [name] => Profile Report - 29 October 2013
                    [type] => profile
                    [status] => Active
                    [last_run] => N/A
                    [responses] => 0
                    [version] => 3
                    [publish_link] => https://appv3.sgizmo.com/reportsview/?key=160589-2416900-e48a0579c8306c0fd240a229db703941
                )

            [2] => Array
                (
                    [id] => 2416835
                    [survey_id] => 1425543
                    [name] => TURF Report - 29 October 2013
                    [type] => turf
                    [status] => Active
                    [last_run] => N/A
                    [responses] => 0
                    [version] => 3
                    [publish_link] => https://appv3.sgizmo.com/reportsview/?key=160589-2416835-98653d7447ecbe5446ba22f0ca17d2b7
                )

        )

)

GET SURVEYREPORT - Get information about a specified survey report.

https://restapi.surveygizmo.com/v5/survey/123456/surveyreport/1234567
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
Response Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 2417084
            [title] => Summary Report - 29 October 2013
            [type] => report_summary
            [created_on] => 2013-10-29 12:47:35
            [modified_on] => 2013-10-29 13:20:04
            [created_by] => 183830
            [modified_by] => 183830
            [last_run] => 2013-10-29 13:19:13
            [published] => True
            [password_protected] => 0
            [filters] => Array
                (
                    [filter] => SGLogicUnit Object
                        (
                            [atom] => SGLogicAtom Object
                                (
                                    [type] => 3
                                    [value] => 5
                                )

                            [operator] => 5
                            [atom2] => SGLogicAtom Object
                                (
                                    [type] => 17
                                    [value] => Array
                                        (
                                            [0] => 5-10058
                                            [1] => 5-10059
                                        )

                                )

                            [id] => 526fedf023826
                        )

                    [filter_map] => :526fedf02343b,526fedf023826
                )

            [publish_links] => https://appv3.sgizmo.com/reportsview/?key=160589-2417084-b5b5c6032f894df5d74c5897cdc87980
            [scheduled] => Array
                (
                    [type] => 
                    [status] => 
                    [next_run] => 
                    [last_run] => 
                    [recurring] => 
                )

        )

)

UPDATE SURVEYREPORT - Copy and update a specified survey report. At this time you can only copy a report and then filter your report. You cannot add filters to an existing report via a post. The _run parameter will perform the initial run of the copied report.

https://restapi.surveygizmo.com/v5/survey/123456/surveyreport/3?_method=POST
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
copy true True
_run* true False
filter_dates[after]* 5/1/2014 False
filter_dates[before]* 6/1/2014 False

*v4 API only

Response Example (.debug format):

Array
(
    [result_ok] => 1
    [data] => Array
        (
            [id] => 2417248
            [title] => Copy of Summary Report - 29 October 2013
            [type] => report_summary
            [created_on] => 2013-10-29 13:22:42
            [modified_on] => 2013-10-29 13:22:42
            [created_by] => 183830
            [modified_by] => 183830
            [last_run] => 
            [published] => True
            [password_protected] => 0
            [filters] => Array
                (
                    [filter] => SGLogicUnit Object
                        (
                            [atom] => SGLogicAtom Object
                                (
                                    [type] => 3
                                    [value] => 5
                                )

                            [operator] => 5
                            [atom2] => SGLogicAtom Object
                                (
                                    [type] => 17
                                    [value] => Array
                                        (
                                            [0] => 5-10058
                                            [1] => 5-10059
                                        )

                                )

                            [id] => 526fedf023826
                        )

                    [filter_map] => :526fedf02343b,526fedf023826
                )

            [publish_links] => https://appv3.sgizmo.com/reportsview/?key=160589-2417248-b4a9c57e17fd1d18c9771716762d93b1
            [scheduled] => Array
                (
                    [type] => 
                    [status] => 
                    [next_run] => 
                    [last_run] => 
                    [recurring] => 
                )

        )

)

DELETE SURVEYREPORT - Delete a specified survey report.

https://restapi.surveygizmo.com/v5/survey/123456/surveyreport/1234567?_method=DELETE
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
Back to the Top