Centro

Un recurso de encuesta contiene información sobre una solicitud específica de datos. Una vez que se crea una encuesta, se activará la creación de una o más tareas para completar la solicitud.
Atributos
nombre | escribe | descripción |
---|---|---|
id |
poll ID | Resource identifier. |
resource |
string, always poll |
Resource type specifier. |
organisation |
organisation ID | The organisation associated with this resource. |
key |
key ID | The key associated with this resource. |
user |
user ID | The user associated with this resource. |
source |
source ID | The source the poll is targeting. This can be a child source of the session's source. |
session |
session ID | The session the poll is using. |
subscription |
optional subscription ID | The associated subscription object ID, if applicable. |
tasks_pending |
list of task IDs | The tasks associated with the poll that are awaiting processing. |
tasks_processing |
list of task IDs | The tasks associated with the poll that are being processed. |
tasks_succeeded |
list of task IDs | The tasks associated with the poll that have succeeded. |
tasks_failed |
list of task IDs | The tasks associated with the poll that have failed. |
tasks_suspended |
list of task IDs | The tasks associated with the poll that are suspended. |
results |
list object containing result objects | List of result objects generated by the poll's tasks. |
errors |
list object containing error objects | List of error objects generated by the poll's tasks. |
state |
string | One of: pending , processing , completed . |
date_created |
datetime | When the resource was created. |
date_started |
optional datetime | When processing of the poll began. |
date_completed |
optional datetime | When processing of the poll finished. |
Tareas
El papel más importante del recurso de la encuesta es reflejar el progreso de sus tareas asociadas y permitir que el usuario final comience a obtener resultados de estas tan pronto como estén disponibles. Por lo tanto, el recurso de sondeo expone atributos relacionados con la tarea en los que las tareas asociadas se clasifican por su estado.
Resultados
Los resultados publicados por las tareas que se ejecutan dentro de la encuesta aparecen en el atributo de results
la encuesta. Esto permite el consumo de resultados antes de que se complete la encuesta.
Los errores
Cualquier error generado por las tareas que se ejecutan dentro de la encuesta aparecerá en el atributo de errors
la encuesta.
Estados
El estado de un sondeo refleja solo si el sondeo está en espera de inicialización ( pending
), está en progreso ( processing
) o si todas las tareas han finalizado su ejecución ( completed
).
Una encuesta no refleja ningún estado de error que no sea a través de sus tareas asociadas.
Carga útil
La carga útil de la encuesta indica qué tipos de información, tipos de datos y archivos debería funcionar para recuperar. El esquema del atributo de carga útil de la encuesta se describe a continuación.
nombre | escribe | descripción |
---|---|---|
info_types |
list of info_type objects |
Specifies which info types should be retrieved. Supports wildcard * . |
data_types |
list of data_type objects |
Specifies which data types should be retrieved. |
files |
list of file IDs. |
Specifies which files to retrieve. |
filters |
nested filters object |
Specifies which filters to apply to retrieved data. |
Por ejemplo, la carga útil de la encuesta para recuperar todo tipo de información en una fuente de cuenta de iCloud sería:
{ "info_types": ["*"] }
Para recuperar una variedad de datos de mensajería de una fuente de copia de seguridad de iCloud o Reincubate Relay, pero solo desde una fecha determinada:
{ "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"], "filters": { "since": "2019-09-15T22:04:12Z", "until": "2021-06-02T12:00:00Z" } }
Para recuperar datos de archivo para imágenes a las que se hace referencia en un resultado de iCloud Photo Library:
{ "files": ["icpl://xyz123", "icpl://abc321"] }
Los diferentes atributos también se pueden usar simultáneamente:
{ "info_types": ["*"], "data_types": ["ios_phone.calls"] }
Filters
Filters allow the client to reduce the amount of data returned to only that which is likely to be of interest. For example, you might filter a poll for SMS data to only the last month of data.
name | type | description |
---|---|---|
since |
optional datetime | Filter to only data that was created after this datetime. |
until |
optional datetime | Filter to only data that was created before this datetime. |
Filters in subscription poll payloads
When using subscriptions to generate regular polls, any filters set in the poll payload will only be used on the initial poll of the subscription. Thereafter, the API will do the following:
- Any value for
until
is ignored as to avoid simply re-polling the same interval repeatedly - If
until
was set, the next poll will fetch data from that point in time forward - If
until
was not set, the next poll will fetch data from the time of the initial poll forward (i.e. the API will poll progressively as normal)
Crear POST /polls
Crear una encuesta para los datos contra una sesión específica.
El parámetro source
solo debe usarse cuando se dirige a una fuente secundaria de la fuente primaria de la sesión. Por ejemplo, si recupera datos de un rirelay.source
el parámetro source
debe ser el ID de esa fuente.
nombre | escribe | descripción |
---|---|---|
key |
optional, key ID | Optionally override the key used for this poll. This is useful when letting users trial new functionality. |
source |
optional, source ID | Optionally target a child source of the session-linked source. |
session |
session ID | The session to be used to authenticate data retrieval. |
subscription |
subscription ID | The subscription to use to perform the poll. If this is provided, source and session can be omitted. |
payload |
nested poll payload | The poll payload used to specify poll |
Usando cURL
curl https://ricloud-api.reincubate.com/polls \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "session": "<session ID>", "payload": { "info_types": ["*"] } }'
Utilizando ricloud-py
import ricloud poll_payload = { 'info_types': ['*'], } poll = ricloud.Poll.create( session='<session ID or ricloud.Session instance>', payload=poll_payload, )
Respuesta de muestra
{ "id": "54554389-5f1a-4ccf-9bb8-024a031cf948", "resource": "poll", "organisation": 1, "key": 1, "user": 1, "source": 1, "session": "f5a7a7ef-ff21-47fe-9aa6-7ebd08123623", "subscription": null, "tasks_pending": [], "tasks_processing": [], "tasks_succeeded": [], "tasks_failed": [], "tasks_suspended": [], "results": { "data": [], "has_more": false, "total_count": 0, "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/results" }, "errors": { "data": [], "has_more": false, "total_count": 0, "url": "/polls/54554389-5f1a-4ccf-9bb8-024a031cf948/errors" }, "state": "pending", "date_created": "2020-02-20T11:59:14.694337Z", "date_started": null, "date_completed": null }
Recuperar GET /polls/{poll ID}
Usando cURL
curl https://ricloud-api.reincubate.com/polls/<poll ID> \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud poll = ricloud.Poll.retrieve(<poll ID>)
Lista GET /polls
nombre | escribe | descripción |
---|---|---|
key |
key ID | Filter by associated key. This is the key used by the user at the time. |
user |
user ID | Filter by associated user. |
source |
source ID | Filter by the target source. |
session |
session ID | Filter by the target session. |
subscription |
subscription ID | Filter by the associated subscription. |
state |
string | Filter by session state. |
date_created |
datetime filter | Filter by when the resource was created. |
date_started |
datetime filter | Filter by when the poll started. |
date_completed |
datetime filter | Filter by when the poll was finished. |
Usando cURL
curl https://ricloud-api.reincubate.com/polls \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud polls = ricloud.Poll.list()
Registro de cambios
2022-07-08
- Support for the
until
filter in poll payloads was added for SMS extraction. This complements thesince
filter to allow clients to specify an exact datetime range to retrieve data from.
2020-05-05
- El atributo de
errors
se agregó al objeto de encuesta. Este es un objeto de lista anidada que contiene objetos de error asociados con la encuesta.
2020-02-20
- Mayor : el atributo de
results
del objeto de encuesta ahora es un objeto de lista anidada, en lugar de un simple atributo de lista. Esto hace posible paginar resultados cuando una encuesta publica una gran cantidad de resultados.
2019-10-16
- Agrega el atributo de
subscription
al objeto de encuesta para indicar si la encuesta fue activada por una suscripción.
2019-06-01
- El atributo de
payload
objeto de encuesta ahora puede estar compuesto por múltiples tipos de operaciones. Esto significa que se puede crear una encuesta con cualquiera o todosinfo-types
deinfo-types
data-types
yfiles
en la carga útil. - Mayor El atributo de
type
en el objeto de encuesta está en desuso a favor de las cargas útiles de encuesta componibles.