Filters API

Filters

A Filter is a query for 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.

Properties

FieldTypeSupported ValuesPOSTPUTDefinition

id

integer

-

X

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

Back to Top

GET filters

Retrieves all filters available in the Stack.

Resource URL

https://api.stackla.com/api/filters

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

NameMandatoryRequest typeDescription

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.

Back to Top

POST filters

Creates a new Filter in the Stack.

Resource URL

https://api.stackla.com/api/filters

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

No additional request parameters are available.

Back to Top

GET filters/:filterId

Retrieves a specific Filter available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/filters/:filterId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

NameMandatoryRequest typeDescription

filterId

Yes

Request type

ID of the Filter

Back to Top

GET filters/:filterId/content

Retrieves tile content of a specific Filter by its ID.

Resource URL

https://api.stackla.com/api/filters/:filterId/content

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

NameMandatoryRequest typeDescription

filterId

Yes

endpoint

ID of the Filter

since_id

No

query

Return results with an ID greater than (more recent than) the specified ID

status

No

query

Returns tiles with a moderation status. By default, is field is not set only Published tiles are returned

Example Values: published, queued, disabled

Back to Top

GET filters/:filterId/summaries

Retrieves aggregated data of a specific Filter by its ID.

Resource URL

https://api.stackla.com/api/filters/:filterId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

NameMandatoryRequest typeDescription

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.

Back to Top

PUT filters/:filterId

Updates a specific Filter available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/filters/:filterId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

NameMandatoryRequest typeDescription

filterId

Yes

endpoint

ID of the Filter

Back to Top

DELETE filters/:filterId

Deletes a specific Filter available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/filters/:filterId

Resource Details

Rate limited: Yes

Access scope: User

Request Parameters

NameMandatoryRequest typeDescription

filterId

Yes

endpoint

ID of the Filter

Back to Top