Segmentation (Filters) API
API methods to manage Filters
Last updated
API methods to manage Filters
Last updated
POST
https://api.pushwoosh.com/json/1.3/createFilter
Creates a new segment (filter).
Name | Required | Type | Description |
---|---|---|---|
POST
https://api.pushwoosh.com/json/1.3/listFilters
Returns a list of available segments (filters) with their conditions.
POST
https://api.pushwoosh.com/json/1.3/deleteFilter
Deletes an existing segment (filter).
POST
https://api.pushwoosh.com/api/v2/audience/exportSegment
A scheduled request. Exports the list of subscribers that fall under specified segment (filter) conditions.
Please find Segmentation Language reference for writing filter expressions here.
For example, to export all subscribers of a particular app, use the following Filter conditions:
In the response, you'll get the task_id
to get the resulting file. Then, call /exportSegment/result with that task_id
in the request body to retrieve the resulting file.
POST
https://api.pushwoosh.com/api/v2/audience/exportSegment/result
Retrieves the link to the CSV with the the /exportSegment results.
Pass the "task_id" received in your /exportSegment
response in the /exportSegment/result
request body.
In /exportSegment/resul
t response, you'll get the "filename" parameter; go to the link specified as that param value. A ZIP archive will be downloaded automatically. Unpack the archive to get the CSV or JSON (depending on what "format" you've sent in the request) file with the devices' data.
If you specify the "exportData" in your /exportSegment
request, the file downloaded will contain the data requested only. By default, the file contains the following user data:
Name | Required | Type | Description |
---|---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
auth*
Yes
string
API access token from Pushwoosh Control Panel.
name*
Yes
string
Filter name.
filter_expression*
Yes
string
Expression constructed according to the rules of the Segmentation language.
Example: T("City", eq, "Madrid")
to segment users whose city is Madrid.
application
No
string
Pushwoosh application code. This parameter is usable only with High-Speed Setup; omit otherwise.
expiration_date
No
string
Filter expiry. The filter will be automatically deleted on a date specified, unless it's used in a Preset or an RSS Feed.
auth*
Yes
string
API access token from Pushwoosh Control Panel.
application*
Yes
string
Pushwoosh application code.
auth*
string
API access token from Pushwoosh Control Panel.
name*
string
Filter name.
auth*
string
API access token from Pushwoosh Control Panel.
filterExpression*
string