Tiles API Reference

​Properties​
​GET /api/tiles/:tileId​
​POST /api/tiles​
​PUT /api/tiles/:tileId​
Tiles
The Tile is defined as any post/comment stored within Visual UGC that has been ingested from an external source (ie. Tweet from Twitter, Post from FB)
Properties
Field
Type
Value
POST
PUT
Definition
_id
objectId
​
​
​
​
Unique identifier for the Tile, in the Stack. This is an object containing a "$id" property, which will expose the ID as a 24-byte string.
​
​
​
​
​
Example Values: 550f9f0e29115c0000bf82cb
| | message | string | published
queue
disabled | | |
post: Required
Message body, normalised from the content source. Will be the Tweet text, Facebook status, Instagram caption, etc. Maximum 32k characters.
Example Values: Wow, this is such an old photo! #tbt
| | title | string | | | |
Tile title to accompany the message, often used for video tiles.
Example Values: Dog on a surfboard
| | html | string | | | |
HTML body, up to 32k characters. This field is mandatory for "html" media type.
Example Values: Dog on a surfboard
| | media | enum | text
image
video
html | | |
The media type of the post.
Example Values: text, image
| | image_url | string | | | |
Full-sized image URL.
Example Values: https://stackla.com/images/buddy_the_dog.jpg
| | image_small_url | string | | | |
Small image URL (ideally under to 300x300px, or 600x600px for retina).
Example Values: https://stackla.com/images/buddy_the_dog-600x600.jpg
| | image_medium_url | string | | | |
Medium image URL (ideally under to 600x600px, or 1200x1200px for retina).
Example Values: https://stackla.com/images/buddy_the_dog-1200x1200.jpg
| | tags | array | | | |
Array of Tag IDs associated with the Tile. Note: May be returned as array of Integers or Strings.
Example Values: ["14001","14562"]
| | share_text | string | | | |
Accompanying text to be used when tile is shared on a Social network (e.g. Twitter, Instagram, Facebook, etc.).
Example Values: Come and see Jimmy's post on the stack!
| | video_url | string | | | |
URL of the video file. Required when media type is "video").
Example Values: https://stackla.com/images/dog_on_a_surfboard.mp4
| | width_ratio | string | | | |
Tile width ratio to be used as a ratio vs width_ratio as width to height. Positive numeric value. Required when media type is "html".
Example Values: 3
| | height_ratio | string | | | |
Tile width ratio to be used as a ratio vs height_ratio as width to height. Positive numeric value. Required when media type is "html".
Example Values: 4
| | status | string | published
queued
disabled | | |
Tile moderation status.
Example Values: published
| | avatar | string | | | |
URL to be used as the post author's avatar.
Example Values: https://stackla.com/images/mascots/buddy.jpg
| | name | string | | | |
Display name to be used for the author.
Example Values: Fred Flintstone
| | guid | string | | | |
Globally unique ID to be used for this post (often referencing external ID). Tiles that have this value set can also be retrived using the guid: operator (see _id). For more info see the POST tiles guid reference.
Example Values: 2019
| | anonymous | bool | | | |
Tiles that originate from networks that allow anonymous posts (including Visual UGC) will have this field set to true. Renderers should not show any attributions the creator of this Tile.
Example Values: false
| | longitude | string | | | |
GPS longitude co-ordinate for geo-location
Example Values: 144.953151388
| | latitude | string | | | |
GPS latitude co-ordinate for geo-location
Example Values: -37.816644361
| | source | string | twitter
facebook
instagram
youtube
gplus
flickr
pinterest
tumblr
rss
ecal
sta_feed
weibo | | |
The source of the post, often a social network. This field is also referred to as "network" in the filter context
Example Values: twitter
|
GET tiles/:tileId
Retrieves a specific Tile available in the Stack by its ID or GUID.
Resource URL
https://api.stackla.com/api/tiles/:tileId
Resource Details
Rate limited
Yes
Access scope
User
Request Parameters
Name
Mandatory
Request type
Description
tileId
Yes
endpoint
​
ID of the Tile, or its Globally Unique ID (GUID, prefixed with "guid:").
​
​
​
Example Values: 550f9f0e29115c0000bf82cb, guid:12345
|
​Back to Top​
POST tiles
Creates a new Tile in the Stack.
Resource URL
https://api.stackla.com/api/tiles?term_id=:termId
Resource Details
Rate limited
Yes
Access scope
User, Stack
Request Parameters
Field
Mandatory
Request type
Description
termId
No
query
​
ID of the Visual UGC Post Feed term that this content will be ingested by.
​
​
​
Example Values: 9999
|
​Back to Top​
PUT tiles/:tileId
Updates a specific Tile available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/tiles/:tileId
Resource Details
Rate limited
Yes
Access scope
User, Stack
Request Parameters
Name
Mandatory
Request type
Description
tileId
Yes
endpoint
​
ID of the Tile, or its Globally Unique ID (GUID, prefixed with "guid:").
​
​
​
Example Values: 550f9f0e29115c0000bf82cb, guid:12345
|
​Back to Top​

Name	Mandatory	Request type	Description
tileId	Yes	endpoint
ID of the Tile, or its Globally Unique ID (GUID, prefixed with "guid:").

Field	Mandatory	Request type	Description
termId	No	query
ID of the Visual UGC Post Feed term that this content will be ingested by.

Name	Mandatory	Request type	Description
tileId	Yes	endpoint
ID of the Tile, or its Globally Unique ID (GUID, prefixed with "guid:").

Terms API Reference

Users API Reference

Last modified 2mo ago

Field	Type	Value	POST	PUT	Definition
_id	objectId
Unique identifier for the Tile, in the Stack. This is an object containing a "$id" property, which will expose the ID as a 24-byte string.