Umfragen

Aktualisierte
Cover image for: Umfragen

Eine Umfrageressource enthält Informationen zu einer bestimmten Datenanforderung. Sobald eine Umfrage erstellt wurde, werden eine oder mehrere Aufgaben erstellt, um die Anforderung abzuschließen.

Attribute

Name Typ Bezeichnung
id Umfrage-ID Ressourcenbezeichner.
resource Zeichenfolge, immer poll Ressourcentypspezifizierer.
organisation Organisations-ID Die mit dieser Ressource verknüpfte Organisation.
key Schlüssel-ID Der dieser Ressource zugeordnete Schlüssel.
user Benutzer-ID Der mit dieser Ressource verknüpfte Benutzer.
source Quell-ID Die Quelle, auf die die Umfrage abzielt. Dies kann eine untergeordnete Quelle der Sitzungsquelle sein.
session Session-ID Die Sitzung, die die Umfrage verwendet.
subscription optionale Abonnement-ID Die zugehörige Abonnementobjekt-ID, falls zutreffend.
tasks_pending Liste der Aufgaben-IDs Die mit der Umfrage verbundenen Aufgaben, die auf ihre Verarbeitung warten.
tasks_processing Liste der Aufgaben-IDs Die mit der Umfrage verbundenen Aufgaben, die verarbeitet werden.
tasks_succeeded Liste der Aufgaben-IDs Die mit der Umfrage verbundenen Aufgaben, die erfolgreich waren.
tasks_failed Liste der Aufgaben-IDs Die Aufgaben im Zusammenhang mit der fehlgeschlagenen Umfrage.
tasks_suspended Liste der Aufgaben-IDs Die mit der Umfrage verbundenen Aufgaben, die ausgesetzt wurden.
results Listenobjekt, das Ergebnisobjekte enthält Liste der Ergebnisobjekte, die von den Aufgaben der Umfrage generiert wurden.
errors Listenobjekt, das Fehlerobjekte enthält Liste der Fehlerobjekte, die von den Aufgaben der Umfrage generiert wurden.
state Zeichenfolge Einer von: pending , processing , completed .
date_created Terminzeit Wann die Ressource erstellt wurde.
date_started optionales Datum/Uhrzeit Als die Bearbeitung der Umfrage begann.
date_completed optionales Datum/Uhrzeit Wenn die Bearbeitung der Umfrage abgeschlossen ist.

Aufgaben

Die wichtigste Aufgabe der Abfrageressource besteht darin, den Fortschritt der zugeordneten Aufgaben wiederzugeben und es dem Endbenutzer zu ermöglichen, Ergebnisse von diesen abzurufen, sobald sie verfügbar sind. Daher macht die Abfrageressource aufgabenbezogene Attribute verfügbar, bei denen zugeordnete Aufgaben nach ihrem Status kategorisiert werden.

Ergebnisse

Alle Ergebnisse, die von Aufgaben veröffentlicht wurden, die in der Umfrage ausgeführt werden, werden im results der Umfrage angezeigt. Dies ermöglicht den Verbrauch von Ergebnissen, bevor die Umfrage abgeschlossen ist.

Fehler

Alle Fehler, die durch Aufgaben ausgelöst werden, die in der Umfrage ausgeführt werden, werden im Fehlerattribut der Umfrage errors .

Zustände

Der Status einer Umfrage gibt nur an, ob die Umfrage auf die Initialisierung wartet ( pending ), in Bearbeitung ist ( processing ) oder alle Aufgaben die Ausführung beendet haben ( completed ).

Eine Umfrage spiegelt keine anderen Fehlerzustände als die zugehörigen Aufgaben wider.

Nutzlast

Die Poll-Payload gibt an, welche Arten von Informationen, Datentypen und Dateien abgerufen werden sollen. Das Poll-Payload-Attributschema wird unten beschrieben.

Name Typ Bezeichnung
info_types Liste der info_type Objekte Gibt an, welche Informationstypen abgerufen werden sollen. Unterstützt Platzhalter * .
data_types Liste der data_type Objekte Gibt an, welche Datentypen abgerufen werden sollen.
files Liste der file IDs. Gibt an, welche Dateien abgerufen werden sollen.
filters verschachteltes filters Gibt an, welche Filter auf die abgerufenen Daten angewendet werden sollen.
skip_files boolean If set to true the poll will skip looking up and publishing attachments files, which includes any assets from photos or video feeds.

Die Poll-Payload zum Abrufen aller Arten von Informationen in einer iCloud-Kontoquelle lautet beispielsweise:

{
  "info_types": ["*"]
}

So rufen Sie eine Vielzahl von Messaging-Daten von einer iCloud-Sicherung oder einer Reincubate-Relay-Quelle ab, jedoch nur von einem bestimmten Datum:

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

So rufen Sie Dateidaten für Bilder ab, auf die in einem iCloud Photo Library-Ergebnis verwiesen wird:

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

Die verschiedenen Attribute können auch gleichzeitig verwendet werden:

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

Filter

Mithilfe von Filtern kann der Client die Menge der zurückgegebenen Daten auf das reduzieren, was wahrscheinlich von Interesse ist. Beispielsweise könnten Sie eine Umfrage für SMS-Daten nur auf die Daten des letzten Monats filtern.

Name Typ Beschreibung
since optionales Datum/Uhrzeit Filtern Sie nur auf Daten, die nach diesem Datum/Uhrzeit erstellt wurden.
until optionales Datum/Uhrzeit Filtern Sie nur auf Daten, die vor diesem Datum/Uhrzeit erstellt wurden.
phone_numbers optionales Array Filtern Sie nur auf Daten, die sich auf Telefonnummern in dieser Liste beziehen.
email_addresses optionales Array Filtern Sie nur auf Daten, die sich auf die E-Mail-Adressen in dieser Liste beziehen.

Filtert in Abonnementumfrage-Payloads

Wenn Sie Abonnements zum Generieren regelmäßiger Umfragen verwenden, werden alle in der Umfrage-Nutzlast festgelegten Filter nur bei der ersten Umfrage des Abonnements verwendet. Danach führt die API Folgendes aus:

  • Jeder Wert für until wird ignoriert, um zu vermeiden, dass dasselbe Intervall wiederholt wiederholt abgefragt wird
  • Wenn until festgelegt wurde, werden bei der nächsten Umfrage Daten ab diesem Zeitpunkt abgerufen
  • Wenn until nicht festgelegt wurde, ruft die nächste Abfrage die Daten ab dem Zeitpunkt der ersten Abfrage ab (d. h. die API fragt nach und nach wie gewohnt ab).

Filter auf Datenebene

Filter auf Datenebene, wie z. phone_numbers und email_addresses , sind hilfreich, um die verarbeiteten Daten auf die für Sie relevanten Elemente zu reduzieren. Hierbei handelt es sich um Einschlussfilter, die alle Datenelemente löschen, die nicht mit einem anderen Element übereinstimmen oder sich auf dieses beziehen, das mit einem der Werte in der Filterliste übereinstimmt. Nehmen Sie zum Beispiel die folgende Nutzlast:

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

Dies würde alle Nachrichten von iOS-Nachrichten zurückgeben, die sich auf eine Konversation beziehen, an der entweder die angegebene Telefonnummer oder E-Mail-Adresse beteiligt ist, einschließlich aller Gruppenkonversationen. Es kann hilfreich sein, mehrere Werte zum Filtern anzugeben, da viele Kontakte eine Mischung aus Telefonnummern und E-Mail-identifizierten Konten haben, wie z. B. die iCloud-Konten von Nachrichten.

Beachten Sie, dass bei Telefonnummern alle Sonderzeichen beim Filtervergleich ignoriert werden, z. B. (415) 555‑0132 entspricht 4155550132 und es können auch Teilzeichenfolgen verwendet werden, z. B. 4155550132 entspricht (415) 555‑0132 und +1 (415) 555‑0132 . Normalerweise führt die Verwendung eines etwas weniger spezifischen Filterwerts – beispielsweise durch die Vermeidung internationaler Vorwahlen – zu konsistenteren Ergebnissen.

Erstellen Sie POST /polls

Erstellen Sie eine Datenabfrage für eine bestimmte Sitzung.

Die source - Parameter sollten nur verwendet werden , wenn ein Kind Quelle der Sitzung des Hauptquelle Targeting. Wenn beispielsweise das Abrufen von Daten aus einer rirelay.source die source sollte die ID dieser Quelle sein.

Name Typ Bezeichnung
key optional, Schlüssel-ID Überschreiben Sie optional den für diese Umfrage verwendeten Schlüssel. Dies ist nützlich, wenn Benutzer neue Funktionen testen können.
source optional, Quell-ID Zielen Sie optional auf eine untergeordnete Quelle der sitzungsverknüpften Quelle.
session Session-ID Die Sitzung, die zur Authentifizierung des Datenabrufs verwendet werden soll.
subscription Abonnement-ID Das Abonnement, das zum Durchführen der Umfrage verwendet werden soll. Wenn dies angegeben ist, können source und session weggelassen werden.
payload verschachtelte Umfragenutzlast Die Umfragenutzlast, die zur Angabe der Umfrage verwendet wird

CURL verwenden

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": ["*"]
  }
}'

Mit Ricloud-Py

import ricloud

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

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

Beispielantwort

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

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

Mit Ricloud-Py

import ricloud

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

Liste GET /polls

Name Typ Bezeichnung
key Schlüssel-ID Filtern Sie nach dem zugehörigen Schlüssel. Dies ist der Schlüssel, den der Benutzer zu diesem Zeitpunkt verwendet.
user Benutzer-ID Filtern Sie nach zugeordnetem Benutzer.
source Quell-ID Filtern Sie nach der Zielquelle.
session Session-ID Filtern Sie nach der Zielsitzung.
subscription Abonnement-ID Filtern Sie nach dem zugehörigen Abonnement.
state Zeichenfolge Filtern Sie nach Sitzungsstatus.
date_created Datum/Uhrzeit-Filter Filtern Sie nach dem Zeitpunkt, an dem die Ressource erstellt wurde.
date_started Datum/Uhrzeit-Filter Filtern Sie nach dem Start der Umfrage.
date_completed Datum/Uhrzeit-Filter Filtern Sie nach dem Ende der Umfrage.

CURL verwenden

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

Mit Ricloud-Py

import ricloud

polls = ricloud.Poll.list()

Änderungsprotokoll

28.11.2023

  • Es wurde Unterstützung für die Filter email_addresses und phone_numbers hinzugefügt, die den Abruf von Daten nur für bestimmte Kontakte ermöglichen.

08.07.2022

  • Für die SMS-Extraktion wurde Unterstützung für den Filter until in Umfrage-Nutzlasten hinzugefügt. Dies ergänzt den Filter since und ermöglicht es Clients, einen genauen Datums-/Uhrzeitbereich anzugeben, aus dem Daten abgerufen werden sollen.

2020-05-05

  • Das Attribut errors wurde dem Umfrageobjekt hinzugefügt. Dies ist ein verschachteltes Listenobjekt, das Fehlerobjekte enthält, die der Abfrage zugeordnet sind.

2020-02-20

  • Major : Das results des Abfrageobjekts ist jetzt ein verschachteltes Listenobjekt und kein einfaches Listenattribut mehr. Dies ermöglicht es, Ergebnisse zu paginieren, wenn eine Umfrage eine große Anzahl von Ergebnissen veröffentlicht.

2019-10-16

  • Fügt dem Umfrageobjekt das subscription , um anzugeben, ob die Umfrage durch ein Abonnement ausgelöst wurde.

2019-06-01

  • Das payload Abfrageobjekts kann jetzt aus mehreren Operationstypen bestehen. Dies bedeutet, dass eine Umfrage mit einem oder allen info-types , data-types und files in der Nutzlast erstellt werden kann.
  • Major Das type Attribut für das Poll-Objekt ist zugunsten komponierbarer Poll-Nutzdaten veraltet.

Wie können wir helfen?

Unser Support-Team hilft Ihnen gerne weiter!

Unsere Bürozeiten sind Montag bis Freitag von 9 bis 17 Uhr GMT. Die Zeit ist aktuell 12:29 nachm. GMT.

Wir bemühen uns, auf alle Mitteilungen innerhalb eines Arbeitstages zu antworten.

Unser großartiges Supportteam

© 2008 - 2024 Reincubate Ltd. Alle Rechte vorbehalten. Registriert in England und Wales #5189175, VAT GB151788978. Reincubate® und Camo® sind eingetragene Marken. Datenschutz-Bestimmungen & Begriffe.