Zum Inhalt springen
BenutzerhandbücherSupport Demo anfordern Anmelden
Pushwoosh.com

Segmentierungs (Filter) API

createFilter

Anchor link to

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

Erstellt einen neuen Filter.

Anfragetext

NameErforderlichTypBeschreibung
auth*JastringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
name*JastringFiltername.
filter_expression*Jastring

Ausdruck, der gemäß den Regeln der Segmentierungssprache erstellt wurde.
Beispiel: T(“City”, eq, “Madrid”), um Benutzer zu segmentieren, deren Stadt Madrid ist.

applicationNeinstringPushwoosh-Anwendungscode. Dieser Parameter ist nur mit High-Speed Setup verwendbar; andernfalls weglassen.
expiration_dateNeinstringAblaufdatum des Filters. 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"
  }
}


// creating Filters for Timezones
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "name": "Timezone Filter",
    "filter_expression": "T(\"Timezone\", BETWEEN, [\"UTC-12:00\", \"UTC+14:00\"])"
  }
}

listFilters

Anchor link to

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

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

Anfragetext

NameErforderlichTypBeschreibung
auth*JastringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
application*JastringPushwoosh-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

Anchor link to

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

Löscht einen vorhandenen Filter.

Anfragetext

NameTypBeschreibung
auth*stringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
name*stringFiltername.
{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}
Beispiel
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "name": "filter name"
  }
}

exportSegment

Anchor link to

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
TypBeschreibung
auth*JastringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
filterExpression*JastringFilterbedingungen
exportDataNeinarrayZu exportierende Daten. Mögliche Werte: "hwids", "push_tokens", "users", "tags", "location". Die Angabe 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.
filterCodeNeinstringVorgefertigter Filtercode, kann anstelle von filterExpression verwendet werden. Kann von der /listFilters-API oder aus der Adressleiste Ihres Browsers bezogen werden, wenn Sie den Filter im Control Panel anzeigen.
applicationCodeErforderlich, wenn Sie entweder filterExpression oder filterCode verwenden.stringPushwoosh-Anwendungscode
generateExportNeinbooleanStandardmäß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.
formatNeinstringLegt das Format der exportierten Datei fest: “csv” oder “json_each_line”. Wenn weggelassen, wird die CSV-Datei generiert.
tagsListNeinarrayGibt die zu exportierenden Tags an. Um nur die spezifischen Tags zu erhalten, sollte das “exportData”-Array den Wert “tags” enthalten.
includeWithoutTokensNeinbooleanAuf true setzen, um Benutzer ohne Push-Token in die exportierte Datei aufzunehmen. Standard ist false.
{
  "task_id": "177458"
}
Beispiel
{
  "auth": "yxoPUlwqm…………pIyEX4H",                           // required. API access token from Pushwoosh Control Panel
  "filterExpression": "AT(\"12345-67890\", \"Name\", any)", // filter conditions, refer to the Segmentation Language guide for syntax
  "filterCode": "12345-67890",                              // pre-made filter code, can be used instead of filterExpression
  "applicationCode": "00000-AAAAA",                         // Required if you're using either `filterExpression` or `filterCode`. Pushwoosh app code. Can be obtained from /listFilters API request or address bar of your browser while viewing the filter in Control Panel.
  "generateExport": true,                                   // if false, devices count only will be sent in response; by default, a response contains a link to download the CSV file
  "format": "json_each_line",                               // format of the file to present the data in: "csv" – the .csv file is downloaded; "json" – a JSON file with all expored devices; or "json_each_line" – JSON line for each device. If not specified, CSV is the default format.
  "exportData": ["hwids", "tags"],                          // optional. Data to export. Possible values: "hwids", "push_tokens", "users", "tags", "location", "fcm_keys", "web keys"
  "tagsList": ["Name", "Level"],                            // optional. Specifies tags to export. To obtain the specific tags only, the "tags" value should be sent within the "exportData" array or the "exportData" be empty.
  "includeWithoutTokens": true                              // optional. Set to true to include users without push tokens in the exported file. Default is false.
}

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

{
  "auth": "yxoPUlwqm…………pIyEX4H",            // API access token from Pushwoosh Control Panel
  "filterExpression": "A(\"AAAAA-BBBBB\")",  // Filter expression referencing app segment
  "applicationCode": "AAAAA-BBBBB"           // Required Pushwoosh app code
}

exportSegment-Ergebnisse

Anchor link to

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

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

Anfragetext

NameTypBeschreibung
auth*StringAPI-Zugriffstoken aus dem Pushwoosh Control Panel.
task_id*StringKennung, die Sie in Ihrer /exportSegment-Antwort erhalten haben.
{
  "devicesCount": "24735",
  "filename": "https://static.pushwoosh.com/segment-export/export_segment_XXXXX_XXXXX_xxxxxxxxxxxxxxxxx.csv.zip",
  "status": "completed"
}

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

In der /exportSegment/result-Antwort erhalten Sie den Parameter „filename“. Folgen Sie dem im Wert dieses Parameters 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 zu erhalten.

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 die „exportData“ in Ihrer /exportSegment-Anfrage angeben, enthält die heruntergeladene Datei nur die angeforderten Daten. Standardmäßig enthält die Datei die folgenden Benutzerdaten:

FeldBeschreibungBeispielwert
HwidHardware-ID eines Geräts01D1BA5C-AAAA-0000-BBBB-9B81CD5823C8
User IDBenutzer-ID, die ein Gerät einem bestimmten Benutzer zuordnet. Wenn keine Benutzer-ID zugewiesen ist, wird die HWID verwendet.user8192
Push TokenEindeutige Kennung, die einem Gerät von Cloud-Messaging-Gateways zugewiesen wird. Mehr erfahreneeeb2fd7…0fc3547
TypePlattformtyp (Ganzzahl).1
Type (humanized)Plattformtyp (Zeichenkette).iOS
AgeWert des Standard-Tags Alter.29
ApplicationVersionWert des Standard-Tags Anwendungsversion.1.12.0.0
CityWert des Standard-Tags Stadt.us, boston
TagNameWert eines in Ihrem Konto erstellten Tags.TagValue