[BETA] Reporting Object

The following API calls are currently available for the reporting object:

GET LIST - Get a list of all of your Standard Reports. 

https://restapi.surveygizmo.com/v5/survey/[id]/reporting
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Response Example (.json format)

At times, the data_ready parameter will return as false. This indicates that SurveyGizmo is still processing responses and as such all submitted data is not yet available. If this is the case, you will need to retry the call at a later time.


{ 
 "result_ok":true,
 "total_count":3,
 "results_per_page":3,
 "data":[ 
 { 
 "report_id":[id],
 "survey_id":[id],
 "report_name":"Q1 Report",
 "status":"Active",
 "data_ready":true,
 "data_progress":100,
 "public_url":"https://data.surveygizmo.com/r/33333_56f2ca1b9faea9.76039338"
 },
 { 
 "report_id":[id],
 "survey_id":[id],
 "report_name":"Q2 Report",
 "status":"Active",
 "data_ready":true,
 "data_progress":100,
 "public_url":"https://data.surveygizmo.com/r/33333_582b7bd51c0c66.38737074"
 },
 { 
 "report_id":[id],
 "survey_id":[id],
 "report_name":"Q3 Report",
 "status":"Active",
 "data_ready":true,
 "data_progress":100,
 "public_url":"https://data.surveygizmo.com/r/33333_58af4ccdd7ee39.23664743"
 },

 ]
}

]

GET REPORT - Get information about a specified Standard Report.

https://restapi.surveygizmo.com/v5/survey/[id]/reporting/[id]
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Response Example (.json format)

At times, the data_ready parameter will return as false. This indicates that SurveyGizmo is still processing responses and as such all submitted data is not yet available. If this is the case, you will need to retry the call at a later time.

{ 
 "result_ok":true,
 "result":{ 
 "report_id":[id],
 "survey_id":[id],
 "report_name":"new report",
 "status":"Active",
 "data_ready":true,
 "data_progress":100,
 "public_url":"https://data.surveygizmo.com/r/33333_58af5372391623.01198414",
 "element_options":[ 

 ],
 "elements_ready":[ 

 ]
 }
}

CREATE REPORT - Create a new Standard Report.

https://restapi.surveygizmo.com/v5/survey/[id]/reporting?_method=PUT
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
options[name]My New ReportFalse

Response Example (.json format)

At times, the data_ready parameter will return as false. This indicates that SurveyGizmo is still processing responses and as such all submitted data is not yet available. If this is the case, you will need to retry the call at a later time.

{ 
 "result_ok":true,
 "result":{ 
 "report_id":[id],
 "survey_id":[id],
 "report_name":"new report",
 "status":"Active",
 "data_ready":true,
 "data_progress":100,
 "public_url":"https://data.surveygizmo.com/r/33333_58af5372391623.01198414",
 "element_options":[ 

 ],
 "elements_ready":[ 

 ]
 }
}

UPDATE REPORT - Update and/or copy a specified Standard.

https://restapi.surveygizmo.com/v5/survey/[id]/reporting/[ida]?_method=POST
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
options[name]My New ReportFalse

Response Example (.json format)

At times, the data_ready parameter will return as false. This indicates that SurveyGizmo is still processing responses and as such all submitted data is not yet available. If this is the case, you will need to retry the call at a later time.

{ 
 "result_ok":true,
 "result":{ 
 "report_id":[id],
 "survey_id":[id],
 "report_name":"new report",
 "status":"Active",
 "data_ready":true,
 "data_progress":100,
 "public_url":"https://data.surveygizmo.com/r/33333_58af5372391623.01198414",
 "element_options":[ 

 ],
 "elements_ready":[ 

 ]
 }
}

DELETE REPORT- Delete a specified Standard Report.

https://restapi.surveygizmo.com/v5/survey/[id]/reporting/[id]?_method=DELETE
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
{
"result_ok": true,
"status": "ok"
}