Segmentierungs- (Filter-) API

createFilter

POST https://api.pushwoosh.com/json/1.3/createFilter

Erstellt einen neuen Filter.

Anfragetext

Name	Erforderlich	Typ	Beschreibung
auth*	Ja	string	API-Zugriffstoken aus dem Pushwoosh Control Panel.
name*	Ja	string	Filtername.
filter_expression*	Ja	string	Ausdruck, der gemäß den Regeln der Segmentierungssprache erstellt wurde. Beispiel: T(“City”, eq, “Madrid”) um Benutzer zu segmentieren, deren Stadt Madrid ist.
application	Nein	string	Pushwoosh-Anwendungscode. Dieser Parameter ist nur mit High-Speed Setup verwendbar; andernfalls weglassen.
expiration_date	Nein	string	Filter-Ablaufdatum. Der Filter wird an einem bestimmten Datum automatisch gelöscht, es sei denn, er wird in einem Preset oder einem RSS-Feed verwendet.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "name": "filter name"
  }
}

Beispiel

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",
    "name": "City = Madrid",
    "filter_expression": "T(\"City\", eq, \"Madrid\")",
    "application": "B18XX-XXXXX",
    "expiration_date": "2025-01-01"
  }
}

// Erstellen von Filtern für Zeitzonen
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // API-Zugriffstoken aus dem Pushwoosh Control Panel
    "name": "Timezone Filter",
    "filter_expression": "T(\"Timezone\", BETWEEN, [\"UTC-12:00\", \"UTC+14:00\"])"
  }
}

listFilters

POST https://api.pushwoosh.com/json/1.3/listFilters

Gibt eine Liste der verfügbaren Segmente (Filter) mit ihren Bedingungen zurück.

Anfragetext

Name	Erforderlich	Typ	Beschreibung
auth*	Ja	string	API-Zugriffstoken aus dem Pushwoosh Control Panel.
application*	Ja	string	Pushwoosh-Anwendungscode

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "filters": [{
      "code": "52551-F2F42",
      "name": "City = Madrid",
      "filter_expression": "T(\"City\", eq, \"madrid\")",
      "expiration_date": "2025-01-01",
      "application": "B18XX-XXXXX"
    }]
  }
}

Beispiel

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",
    "application": "B18XX-XXXXX"
  }
}

deleteFilter

POST https://api.pushwoosh.com/json/1.3/deleteFilter

Löscht einen vorhandenen Filter.

Anfragetext

Name	Typ	Beschreibung
auth*	string	API-Zugriffstoken aus dem Pushwoosh Control Panel.
name*	string	Filtername.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

Beispiel

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // API-Zugriffstoken aus dem Pushwoosh Control Panel
    "name": "filter name"
  }
}

exportSegment

POST https://api.pushwoosh.com/api/v2/audience/exportSegment

Eine geplante Anfrage. Exportiert die Liste der Abonnenten, die unter die angegebenen Filterbedingungen fallen.

Anfragetext

Name	Erforderlich	Typ	Beschreibung
auth*	Ja	string	API-Zugriffstoken aus dem Pushwoosh Control Panel.
filterExpression*	Ja	string	Filterbedingungen
exportData	Nein	array	Zu exportierende Daten. Mögliche Werte: "hwids", "push_tokens", "users", "tags", "location". Das Einschließen von "location" fügt die Spalten Latitude und Longitude zur exportierten CSV-Datei hinzu. Wenn exportData weggelassen wird, sind Latitude und Longitude standardmäßig im Export enthalten.
filterCode	Nein	string	Vorgefertigter Filtercode, kann anstelle von filterExpression verwendet werden. Kann von der /listFilters-API oder der Adressleiste Ihres Browsers beim Anzeigen des Filters im Control Panel abgerufen werden.
applicationCode	Erforderlich, wenn Sie entweder filterExpression oder filterCode verwenden.	string	Pushwoosh-Anwendungscode
generateExport	Nein	boolean	Standardmäßig auf true gesetzt, und eine Antwort enthält einen Link zum Herunterladen der Datei. Wenn false, wird nur die Anzahl der Geräte in der Antwort gesendet.
format	Nein	string	Legt das Format der exportierten Datei fest: “csv” oder “json_each_line”. Wenn weggelassen, wird die CSV-Datei generiert.
tagsList	Nein	array	Gibt die zu exportierenden Tags an. Um nur die spezifischen Tags zu erhalten, sollte das “exportData”-Array den Wert “tags” enthalten.
includeWithoutTokens	Nein	boolean	Auf true setzen, um Benutzer ohne Push-Token in die exportierte Datei aufzunehmen. Standard ist false.

200 Erfolgreich

{
  "task_id": "177458"
}

Beispiel

{
  "auth": "yxoPUlwqm…………pIyEX4H",                           // erforderlich. API-Zugriffstoken aus dem Pushwoosh Control Panel
  "filterExpression": "AT(\"12345-67890\", \"Name\", any)", // Filterbedingungen, siehe Anleitung zur Segmentierungssprache für die Syntax
  "filterCode": "12345-67890",                              // vorgefertigter Filtercode, kann anstelle von filterExpression verwendet werden
  "applicationCode": "00000-AAAAA",                         // Erforderlich, wenn Sie entweder `filterExpression` oder `filterCode` verwenden. Pushwoosh-App-Code. Kann von der /listFilters-API-Anfrage oder der Adressleiste Ihres Browsers beim Anzeigen des Filters im Control Panel abgerufen werden.
  "generateExport": true,                                   // wenn false, wird nur die Geräteanzahl in der Antwort gesendet; standardmäßig enthält eine Antwort einen Link zum Herunterladen der CSV-Datei
  "format": "json_each_line",                               // Format der Datei zur Darstellung der Daten: "csv" – die .csv-Datei wird heruntergeladen; "json" – eine JSON-Datei mit allen exportierten Geräten; oder "json_each_line" – eine JSON-Zeile für jedes Gerät. Wenn nicht angegeben, ist CSV das Standardformat.
  "exportData": ["hwids", "tags"],                          // optional. Zu exportierende Daten. Mögliche Werte: "hwids", "push_tokens", "users", "tags", "location", "fcm_keys", "web keys"
  "tagsList": ["Name", "Level"],                            // optional. Gibt die zu exportierenden Tags an. Um nur die spezifischen Tags zu erhalten, sollte der Wert "tags" innerhalb des "exportData"-Arrays gesendet werden oder "exportData" leer sein.
  "includeWithoutTokens": true                              // optional. Auf true setzen, um Benutzer ohne Push-Token in die exportierte Datei aufzunehmen. Standard ist false.
}

Hinweis

Eine Referenz zur Segmentierungssprache zum Schreiben von Filterausdrücken finden Sie hier.

Um beispielsweise alle Abonnenten einer bestimmten App zu exportieren, verwenden Sie die folgenden Filterbedingungen:

{
  "auth": "yxoPUlwqm…………pIyEX4H",            // API-Zugriffstoken aus dem Pushwoosh Control Panel
  "filterExpression": "A(\"AAAAA-BBBBB\")",  // Filterausdruck, der auf das App-Segment verweist
  "applicationCode": "AAAAA-BBBBB"           // Erforderlicher Pushwoosh-App-Code
}

Vorsicht

In der Antwort erhalten Sie die task_id, um die Ergebnisdatei zu erhalten. Rufen Sie dann /exportSegment/result mit dieser task_id im Anfragetext auf, um die Ergebnisdatei abzurufen.

exportSegment-Ergebnisse

POST https://api.pushwoosh.com/api/v2/audience/exportSegment/result

Ruft den Link zur CSV-Datei mit den /exportSegment-Ergebnissen ab.

Anfragetext

Name	Typ	Beschreibung
auth*	String	API-Zugriffstoken aus dem Pushwoosh Control Panel.
task_id*	String	Kennung, die Sie in Ihrer /exportSegment-Antwort erhalten haben.

200: OK

{
  "devicesCount": "24735",
  "csvFilename": "https://static.pushwoosh.com/segment-export/export_segment_XXXXX_XXXXX_xxxxxxxxxxxxxxxxx.csv.zip",
  "status": "completed"
}

Übergeben Sie die “task_id”, die Sie in Ihrer /exportSegment-Antwort erhalten haben, im Anfragetext von /exportSegment/result.

In der /exportSegment/result-Antwort erhalten Sie den Parameter “filename”. Folgen Sie dem in diesem Parameterwert angegebenen Link, um automatisch ein ZIP-Archiv herunterzuladen. Entpacken Sie das Archiv, um die CSV- oder JSON-Datei (abhängig vom in Ihrer Anfrage angegebenen “format”) mit den Gerätedaten abzurufen.

Ab dem 3. April 2025 ist eine Autorisierung zum Herunterladen der Datei erforderlich:

• Wenn Sie über einen Browser herunterladen, melden Sie sich einfach im Pushwoosh Control Panel an, um Zugriff zu erhalten.
• Wenn Sie über eine Server-Software herunterladen, fügen Sie den folgenden Header in Ihre Anfrage ein: Authorization: Token YOUR_API_TOKEN

Wenn Sie “exportData” in Ihrer /exportSegment-Anfrage angeben, enthält die heruntergeladene Datei nur die angeforderten Daten. Standardmäßig enthält die Datei die folgenden Benutzerdaten:

Feld	Beschreibung	Beispielwert
Hwid	Hardware-ID eines Geräts	01D1BA5C-AAAA-0000-BBBB-9B81CD5823C8
User ID	Benutzer-ID, die ein Gerät einem bestimmten Benutzer zuordnet. Wenn keine Benutzer-ID zugewiesen ist, wird die HWID verwendet.	user8192
Push Token	Eindeutige Kennung, die einem Gerät von Cloud-Messaging-Gateways zugewiesen wird. Mehr erfahren	eeeb2fd7…0fc3547
Type	Plattformtyp (Ganzzahl).	1
Type (humanized)	Plattformtyp (Zeichenkette).	iOS
Age	Wert des Standard-Tags Alter.	29
ApplicationVersion	Wert des Standard-Tags Anwendungsversion.	1.12.0.0
City	Wert des Standard-Tags Stadt.	us, boston
TagName	Wert eines in Ihrem Konto erstellten Tags.	TagValue