Tags API Reference

Unique identifier for the Tag.

Example Values:
12345

post: Required

Name and display title on the Tag.

Example Values:
Editor's choice

post: Required if custom_slug is 0

Simplified and class-name-fiendly Tag identifier, most often auto-generated. On output this value is often used to set the class.

Example Values:
editors-choice

This value specifies if the slug field value is being auto-generated or overwritten by the user.

Example Values:
0

post: Required

Specifies the type of the Tag

Example Values:
content

post: Required

This value specifies if display renderers should display this Tag in display context

Example Values:
1

When rendered as a link, this will indicate the target attribute for the anchor tag when used with custom_url

Example Values:
_blank

Indicates whether this Tag is a read-only tag created and managed by the system.

Example Values:
1

Specifies the sequential sort order in which this Tag should be displayed when being rendered for display. Default values is 3

Example Values:
3

URL that clicking on the Tag should take the user to. When type is product, this is the URL that the product click-through should be linked to

Example Values:
https://www.google.com.au/?q=stackla

User provided price for Tags of type product.

Example Values:
$399

User provided reference to external product for Tags of type product. Should be a continous string, best if URL-friendly. When querying for a product by ID, this value can be prefixed with ext: to fetch by it.

Example Values:
PROD-1234

User provided description for Tags of type product. Maximum length: 512 characters

Example Values:
Long sleeve woven swing dress in animal print with roll neck and back zip fastening. 87cm length. 100% Viscose. Machine washable.

URL of the small (optimised for 300px x 300px) image PNG/JPG/JPEG/GIF image to be displayed. This should be a HTTPS URL to so that the Stack or widget can be served over HTTPS completely

Example Values:
https://stackla.com/images/product_small.jpg

Width of the small image being used as the image_small_url, in pixels

Example Values:
250

Height of the small image being used as the image_small_url, in pixels

Example Values:
200

URL of the medium (optimised for 600px x 600px) image PNG/JPG/JPEG/GIF image to be displayed. This should be a HTTPS URL to so that the Stack or widget can be served over HTTPS completely

Example Values:
https://stackla.com/images/product_medium.jpg

Width of the small image being used as the image_medium_url, in pixels

Example Values:
500

Height of the small image being used as the image_medium_url, in pixels

Example Values:
400

UTC timestamp of when this Tag was created

Example Values:
1372057752

Keyword to search Tag ID, Name, Slug, External URL and External Product ID (prefixed with “ext:”).

Example Values:
12345, ext:PROD-1234, my tag

Comma-separated of type of tags to be derived. One or more of content, product, competition, system.

Example Values:
content, product

Page number. Default value is 1

Return limit define how many Tags will be return for each request. Default is 25. Maximum limit is 100.

ID of the Tag, or its External Product ID (prefixed with “ext:”).

Example Values:
12345, ext:PROD-1234

ID of the Tag, or its External Product ID (prefixed with “ext:”).

Example Values:
12345, ext:PROD-1234

ID of the Tag, or its External Product ID (prefixed with “ext:”).

Example Values:
12345, ext:PROD-1234

ID of the Tag, or its External Product ID (prefixed with “ext:”).

Example Values:
12345, ext:PROD-1234