Puedes consultar fácilmente los resultados de tus encuestas y obtenerlos como objetos JSON o XML. Si tienes muchos resultados puedes paginarlos, filtrarlos, etc.
Obteniendo una respuesta
Si quieres solicitar los detalles de una respuesta específica puedes usar la URL
https://api.e-encuesta.com/surveys/:survey_id/responses/:response_id
Donde
- :survey_id es el identificador de la encuesta
- :response_id es el identificador de la respuesta
Recuerda que todas las peticiones deben ser autenticadas, consulta el artículo Autenticación para saber más.
El resultado normalmente estará en formato JSON, y mostrará todos los detalles de la respuesta. Si quieres obtener los resultados en otro formato consulta el artículo Formatos de respuesta para conocer otras opciones. Puedes consultar los detalles de la respuesta en el artículo Objeto: Respuesta a Encuesta.
Obteniendo más respuestas
Si te interesa, también puedes solicitar todas las respuestas de una encuesta usando la siguiente URL
https://api.e-encuesta.com/surveys/:survey_id/responses
Donde :survey_id es el identificador de la encuesta. Los detalles de la respuesta los puedes consultar en el artículo Objeto: Listado de Respuestas a una Encuesta.
Esta solicitud sólo devuelve un máximo de 100 resultados, si quieres obtener más resultados puedes usar los siguientes parámetros:
- pageSize es la cantidad de resultados que se entregarán en una página. Por defecto 100, y un máximo de 200.
- page indica la página que se quiere consultar, siendo la primera página la número 1.
por ejemplo
https://api.e-encuesta.com/surveys/12345/responses?pageSize=50&page=2
Las mayúsculas en los nombres de los parámetros son importantes. De no estar escritos exactamente igual que en el ejemplo, serán ignorados.
Filtrando los resultados
Además se pueden filtrar los resultados para obtener sólo los que tengan determinadas características.
Un filtro está realmente compuesto por tres parámetros separados: el campo, el operador y el valor. Cada uno se accede usando notación con punto:
filters.field
, filters.operator
y filters.value
Como además puedes especificar múltiples filtros para la misma llamada API, hay que indicar un índice para cada parámetro. El primero tendría índice 0, así que estaría compuesto por:
filters[0].field
, filters[0].operator
y filters[0].value
Uniéndolo, terminarías con lo siguiente:
filters[0].field=___&filters[0].operator=___&filters[0].value=___
Si tienes condiciones múltiples puede lucir como:
filters[0].field=___&filters[0].operator=___&filters[0].value=___&filters[1].field=___&filters[1].operator=___&filters[1].value=___filters[2].field=___&filters[2].operator=___&filters[2].value=___
Es importante destacar que sólo se devolverán los resultados que cumplan todos los filtros especificados.
Campos de filtrado
Para filtrar se pueden utilizar cualquiera de los siguientes campos:
- id: el identificador de la respuesta.
- dateModified: la fecha de última modificación de la respuesta. La fecha debe tener el formato
yyyy-MM-dd HH:mm:ss
y estar basada en la zona horaria GMT.
Operadores de filtrado
Los operadores de filtrado disponibles son los siguientes:
Operador | Sintaxis | Valor requerido |
es igual a | = | Sí |
no es igual a | <> o != | Sí |
es mayor que | > | Sí |
es mayor o igual que | >= o => | Sí |
es menor que | < | Sí |
es menor o igual que | <= o =< | Sí |
Comentarios
0 comentarios
El artículo está cerrado para comentarios.