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

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.

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"]
}

Filtros

Los filtros permiten al cliente reducir la cantidad de datos devueltos a aquellos que probablemente sean de su interés. Por ejemplo, puede filtrar una encuesta de datos de SMS solo para el último mes de datos.

Filtros en cargas útiles de encuestas de suscripción

Cuando se utilizan suscripciones para generar encuestas periódicas, los filtros establecidos en la carga útil de la encuesta solo se utilizarán en la encuesta inicial de la suscripción. A partir de entonces, la API hará lo siguiente:

• Cualquier valor de until se ignora para evitar simplemente volver a sondear el mismo intervalo repetidamente
• Si se configuró until , la siguiente encuesta obtendrá datos desde ese momento en adelante
• Si no se configuró until , la siguiente encuesta obtendrá datos desde el momento de la encuesta inicial en adelante (es decir, la API sondeará progresivamente como de costumbre)

Filtros de nivel de datos

Los filtros a nivel de datos, como phone_numbers y email_addresses , son útiles para reducir los datos procesados solo a los elementos que son relevantes para usted. Estos incluyen filtros que eliminan cualquier elemento de datos que no coincida o no se relacione con otro elemento que coincida con uno de los valores de la lista del filtro. Tome la carga útil a continuación, por ejemplo:

{
  "data_types": ["ios_messages.messages"],
  "filters": {
    "phone_numbers": ["0123456789"],
    "email_addresses": ["test@example.com"]
  }
}

Esto devolvería cualquier mensaje de Mensajes de iOS que se relacione con una conversación que involucre el número de teléfono o la dirección de correo electrónico especificada, incluidas las conversaciones grupales. Puede resultar útil especificar varios valores para filtrar, ya que muchos contactos tendrán una combinación de números de teléfono y cuentas identificadas por correo electrónico, como las cuentas de iCloud de Mensajes.

Exclusion-based filters, like exclude_phone_numbers and exclude_email_addresses, do the opposite: removing any data that relates to the values provided. If both inclusion- and exclusion-based filters are provided, and an item relates to both, then the exclusion-based filter wins. For example, a group conversation that contains one contact with an included email address but also another contact with an excluded phone number will get filtered out of the data.

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.

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

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

09-12-2024

• Agregue soporte para excluir datos relacionados con direcciones de correo electrónico y números de teléfono de contacto específicos, a través de los parámetros de carga útil de la encuesta exclude_phone_numbers y exclude_emails .

2023-11-28

• Agregue soporte para filtrar datos usando direcciones de correo electrónico y números de teléfono de contacto a través de los parámetros de carga útil de la encuesta phone_numbers y emails .

2022-07-08

• Se agregó soporte para el filtro until en las cargas útiles de la encuesta para la extracción de SMS. Esto complementa el filtro since para permitir a los clientes especificar un rango de fecha y hora exacto para recuperar datos.

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 todos info-types de info-types data-types y files 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.