Filters API Reference
A Filter is a query for Visual UGC Tile content that was ingested from a particular Network, contains a particular Tag and/or is of a particular Medium. To retrieve a stream of content you can do so using the Filters endpoint.
Field | Type | Value | POST | PUT | Definition |
---|---|---|---|---|---|
id | integer | | | | Unique id for filter |
name | string | | | | |
post: Required | | | | | |
Filter name
| | sort | string |
source_created_at_desc
score_desc
votes
| | | Sorting type | | networks | array | twitter
facebook
instagram
youtube
gplus
flickr
pinterest
tumblr
rss
ecal
sta_feed
weibo
| | | array of network(s) for filtering rule | | tags | array | | | | Array of tags' id for filtering rule | | media | array | text
image
video
html
| | | Array of media(s) for filtering rule |Retrieves all filters available in the Stack.
https://api.stackla.com/api/filters
Rate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
---|---|---|---|
page | No | query | |
Page number. Default value is 1 | | | |
| | limit | No | query |
Return limit define how many Filters will be return for each request. Default is 25. Maximum limit is 100.
|
Creates a new Filter in the Stack.
https://api.stackla.com/api/filters
Rate limited
Yes
Access scope
User
No additional request parameters are available.
Retrieves a specific Filter available in the Stack by its ID.
https://api.stackla.com/api/filters/:filterId
Rate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
---|---|---|---|
filterId | Yes | Request type | |
ID of the Filter | | | |
|
Retrieves tile content of a specific Filter by its ID.
https://api.stackla.com/api/filters/:filterId
Rate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
---|---|---|---|
filterId | Yes | endpoint | |
ID of the Filter | | | |
| | since_id | No | query |
Return results with an ID greter than (more recent than) the specified ID
|
Retrieves aggregated data of a specific Filter by its ID.
https://api.stackla.com/api/filters/:filterId
Rate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
---|---|---|---|
filterId | Yes | endpoint | |
ID of the Filter | | | |
| | aggregated_by | No | query |
Default or geohash (beta), geohash returns aggregated data grouped by geohashes for geotagged tiles.
|
Updates a specific Filter available in the Stack by its ID.
https://api.stackla.com/api/filters/:filterId
Rate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
---|---|---|---|
filterId | Yes | endpoint | |
ID of the Filter | | | |
|
Deletes a specific Filter available in the Stack by its ID.
https://api.stackla.com/api/filters/:filterId
Rate limited
Yes
Access scope
User
Name | Mandatory | Request type | Description |
---|---|---|---|
filterId | Yes | endpoint | |
ID of the Filter | | | |
|
Last modified 2mo ago