Tags API
Tags
Tags allow content to be categorized and filtered for better curation. They are more like blog tags or product swing tags and are not to be confused with hashtags. It is a form of profiling Social Tiles for grouping/association purposes.
Properties
| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
id | integer | X | X | Unique identifier for the Tag. Example Values: | |
tag | tag | ✔ | ✔ | post: Required Name and display title on the Tag. Example Values: | |
slug | string | ✔ | ✔ | post: Required if Simplified and class-name-fiendly Tag identifier, most often auto-generated. On output this value is often used to set the class. Example Values: | |
custom_slug | bool |
| ✔ | ✔ | This value specifies if the Example Values: |
type | enum |
| ✔ | ✔ | post: Required Specifies the type of the Tag Example Values: |
publicly_visible | bool |
| ✔ | ✔ | post: Required This value specifies if display renderers should display this Tag in display context Example Values: |
target | enum |
| ✔ | ✔ | When rendered as a link, this will indicate the target attribute for the anchor tag when used with custom_url Example Values: |
system_tag | bool |
| X | X | Indicates whether this Tag is a read-only tag created and managed by the system. Example Values: |
priority | integer | 1 (highest) - 5 (lowest) | ✔ | ✔ | Specifies the sequential sort order in which this Tag should be displayed when being rendered for display. Default values is 3 Example Values: |
custom_url | string | ✔ | ✔ | 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: | |
price | string | ✔ | ✔ | User provided price for Tags of type Example Values: | |
ext_product_id | string | ✔ | ✔ | User provided reference to external product for Tags of type Example Values: | |
description | string | ✔ | ✔ | User provided description for Tags of type product. Maximum length: 512 characters Example Values: | |
image_small_url | string | ✔ | ✔ | 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: | |
image_small_width | integer | ✔ | ✔ | Width of the small image being used as the image_small_url, in pixels Example Values: | |
image_small_height | integer | ✔ | ✔ | Height of the small image being used as the image_small_url, in pixels Example Values: | |
image_medium_url | string | ✔ | ✔ | 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: | |
image_medium_width | integer | ✔ | ✔ | Width of the small image being used as the image_medium_url, in pixels Example Values: | |
image_medium_height | integer | ✔ | ✔ | Height of the small image being used as the image_medium_url, in pixels Example Values: | |
created_at | timestamp | X | X | UTC timestamp of when this Tag was created Example Values: |
GET tags
Retrieves all tags available in the Stack.
Resource URL
https://api.stackla.com/api/tags
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
keyword | No | query | Keyword to search Tag ID, Name, Slug, External URL and External Product ID (prefixed with "ext:"). Example Values: |
type | No | query | Comma-separated of type of tags to be derived. One or more of content, product, competition, system. Example Values: |
page | No | query | Page number. Default value is 1 |
limit | No | query | Return limit define how many Tags will be return for each request. Default is 25. Maximum limit is 100. |
POST tags
Creates a new Tag in the Stack.
Resource URL
https://api.stackla.com/api/tags
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
No additional request parameters are available.
GET tags/:tagId
Retrieves a specific Tag available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/tags/:tagId
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
tagId | Yes | endpoint | ID of the Tag, or its External Product ID (prefixed with "ext:"). Example Values: |
GET tags/:tagId/summaries
Retrieves aggregated data of a specific Tags by its ID.
Resource URL
https://api.stackla.com/api/tags/:tagId/summaries
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
tagId | Yes | endpoint | ID of the Tag, or its External Product ID (prefixed with "ext:"). Example Values: |
PUT tags/:tagId
Updates a specific Tag available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/tags/:tagId
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
tagId | Yes | endpoint | ID of the Tag, or its External Product ID (prefixed with "ext:"). Example Values: |
DELETE tags/:tagId
Deletes a specific Tag available in the Stack by its ID.
Resource URL
https://api.stackla.com/api/tags/:tagId
Resource Details
Rate limited: Yes
Access scope: User
Request Parameters
| Name | Mandatory | Request type | Description |
|---|---|---|---|
tagId | Yes | endpoint | ID of the Tag, or its External Product ID (prefixed with "ext:"). Example Values: |