Tiles API Reference
Tiles
The Tile is defined as any post/comment stored within Stackla 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: |
|||
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: |
||
title | string |
Tile title to accompany the message, often used for video tiles.
Example Values: |
|||
html | string |
HTML body, up to 32k characters. This field is mandatory for “html” media type.
Example Values: |
|||
media | enum | text image video html |
The media type of the post.
Example Values: |
||
image_url | string |
Full-sized image URL.
Example Values: |
|||
image_small_url | string |
Small image URL (ideally under to 300x300px, or 600x600px for retina).
Example Values: |
|||
image_medium_url | string |
Medium image URL (ideally under to 600x600px, or 1200x1200px for retina).
Example Values: |
|||
tags | array |
Array of Tag IDs associated with the Tile. Note: May be returned as array of Integers or Strings.
Example Values: |
|||
share_text | string |
Accompanying text to be used when tile is shared on a Social network (e.g. Twitter, Instagram, Facebook, etc.).
Example Values: |
|||
video_url | string |
URL of the video file. Required when media type is “video”).
Example Values: |
|||
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: |
|||
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: |
|||
status | string | published queued disabled |
Tile moderation status.
Example Values: |
||
avatar | string |
URL to be used as the post author’s avatar.
Example Values: |
|||
name | string |
Display name to be used for the author.
Example Values: |
|||
guid | string |
Globally unique ID to be used for this post (often referencing external ID). Tiles that have
Example Values: |
|||
anonymous | bool |
Tiles that originate from networks that allow anonymous posts (including Stackla) will have this field set to
Example Values: |
|||
longitude | string |
GPS longitude co-ordinate for geo-location
Example Values: |
|||
latitude | string |
GPS latitude co-ordinate for geo-location
Example Values: |
|||
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: |
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
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: |
POST tiles
Creates a new Tile in the Stack.
Resource URL
https://api.stackla.com/api/tiles?term_id=:termId
Resource Details
Request Parameters
Field | Mandatory | Request type | Description |
---|---|---|---|
termId | No | query |
ID of the Stackla Post Feed term that this content will be ingested by.
Example Values: |
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
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: |