Опросы

Ресурс опроса содержит информацию о конкретном запросе данных. После создания опроса он инициирует создание одной или нескольких задач для выполнения запроса.

Атрибуты

Задачи

Самая важная роль ресурса опроса состоит в том, чтобы отразить ход выполнения связанных с ним задач и позволить конечному пользователю начать получать результаты из них, как только они станут доступны. Поэтому ресурс опроса предоставляет атрибуты, связанные с задачей, в которых связанные задачи классифицируются по их состоянию.

Результаты

Все результаты, опубликованные задачами, запущенными в опросе, отображаются в атрибуте results опроса. Это позволяет использовать результаты до завершения опроса.

ошибки

Любые ошибки, вызванные задачами, запущенными в опросе, появятся в атрибуте errors опроса.

состояния

Состояние опроса отражает только то, ожидает ли инициализация ( pending ), находится в процессе ( processing ) или все задачи завершены ( completed ).

Опрос не отражает никаких состояний ошибок, кроме как через связанные с ним задачи.

полезная нагрузка

Полезная нагрузка опроса указывает, какие типы информации, типы данных и файлы должны работать для извлечения. Схема атрибута полезной нагрузки опроса описана ниже.

Например, полезная нагрузка опроса для извлечения всех типов информации из источника учетной записи iCloud будет выглядеть так:

{
  "info_types": ["*"]
}

Чтобы получить различные данные для обмена сообщениями из резервной копии iCloud или источника Reincubate Relay, но только с определенной даты:

{
  "data_types": ["ios_messages.messages", "whatsapp.messages", "viber.messages"],
  "filters": {
    "since": "2019-09-15T22:04:12Z",
    "until": "2021-06-02T12:00:00Z"
  }
}

Чтобы получить данные файла для изображений, на которые есть ссылки в библиотеке фотографий iCloud:

{
  "files": ["icpl://xyz123", "icpl://abc321"]
}

Различные атрибуты также могут использоваться одновременно:

{
  "info_types": ["*"],
  "data_types": ["ios_phone.calls"]
}

Фильтры

Фильтры позволяют клиенту сократить объем возвращаемых данных до тех, которые могут представлять интерес. Например, вы можете отфильтровать опрос по данным SMS, указав только данные за последний месяц.

Фильтры в полезных данных опроса подписки

При использовании подписок для создания регулярных опросов любые фильтры, установленные в полезных данных опроса, будут использоваться только при начальном опросе подписки. После этого API выполнит следующие действия:

• Любое значение until игнорируется, чтобы избежать простого повторного опроса одного и того же интервала.
• Если until не установлен, следующий опрос будет извлекать данные с этого момента времени вперед.
• Если until не установлен, следующий опрос будет извлекать данные с момента первоначального опроса вперед (т. е. API будет опрашивать постепенно, как обычно).

Фильтры уровня данных

Фильтры уровня данных, такие как phone_numbers и email_addresses , помогают сократить количество обработанных данных до тех элементов, которые имеют для вас отношение. Это фильтры включения, которые удаляют любые элементы данных, которые не совпадают или не относятся к другому элементу, который соответствует одному из значений в списке фильтра. Возьмем, к примеру, полезную нагрузку ниже:

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

Это вернет все сообщения из сообщений iOS, которые относятся к разговору, включающему указанный номер телефона или адрес электронной почты, включая любые групповые разговоры. Может быть полезно указать несколько значений для фильтрации, поскольку многие контакты будут иметь сочетание номеров телефонов и учетных записей, идентифицируемых по электронной почте, например учетные записи iCloud в Сообщениях.

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.

Создать POST /polls

Создайте опрос для данных против определенного сеанса.

Параметр source следует использовать только при нацеливании на дочерний источник первичного источника сеанса. Например, при получении данных из rirelay.source параметр source должен быть идентификатором этого источника.

Использование 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": ["*"]
  }
}'

Использование ricloud-py

import ricloud

poll_payload = {
  'info_types': ['*'],
}

poll = ricloud.Poll.create(
  session='<session ID or ricloud.Session instance>',
  payload=poll_payload,
)

Образец ответа

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

Получить GET /polls/{poll ID}

Использование cURL

curl https://ricloud-api.reincubate.com/polls/<poll ID> \
  -H 'Authorization: Token <your key_token>'

Использование ricloud-py

import ricloud

poll = ricloud.Poll.retrieve(<poll ID>)

Список GET /polls

Использование cURL

curl https://ricloud-api.reincubate.com/polls \
  -H 'Authorization: Token <your key_token>'

Использование ricloud-py

import ricloud

polls = ricloud.Poll.list()

Изменения

2024-12-09

• Добавьте поддержку исключения данных, связанных с определенными контактными адресами электронной почты и номерами телефонов, с помощью параметров полезной нагрузки опроса exclude_phone_numbers и exclude_emails .

2023-11-28

• Добавить поддержку фильтрации данных с использованием контактных адресов электронной почты и номеров телефонов с помощью параметров полезной нагрузки опроса phone_numbers и emails .

2022-07-08

• Для извлечения SMS была добавлена поддержка фильтра until в полезных нагрузках опроса. Это дополняет фильтр since , позволяющий клиентам указывать точный диапазон дат и времени для получения данных.

2020-05-05

• Атрибут errors был добавлен в объект опроса. Это объект вложенного списка, содержащий объекты ошибок, связанные с опросом.

2020-02-20

• Важнейший : атрибут results объекта опроса теперь является вложенным списком, а не простым списком. Это позволяет разбивать результаты на страницы, когда опрос публикует большое количество результатов.

2019-10-16

• Добавляет атрибут subscription в объект опроса, чтобы указать, был ли опрос инициирован подпиской.

2019-06-01

• Атрибут payload объекта опроса теперь может состоять из нескольких типов операций. Это означает, что опрос может быть создан с любым или всеми info-types data-types и files в полезной нагрузке.
• Major Атрибут type в объекте poll устарел в пользу составных полезных нагрузок опроса.