In order to target specific posts for API customization, users have had to rely on using content icons or pinned posts to flag posts; neither which was actually created for this filtering purpose and each with their own limitation. From now on users are able to add tags to all posts (before or after publishing) and then developers can retrieve and filter these posts using the API.
Why is this useful? It allows you to have more flexibility when filtering and visualizing your published content. Not only will tagging improve the content management workflow, it will also enable the creation of more innovative and flexible API experiences. All while still allowing editors to curate, manage and produce content using Content Studio.
Use Case Examples:
- Urgent Posts / Breaking News: During breaking news coverage editors can add a tag called "urgent" to all posts that meet this criteria. This tag can easily be added using Content Studio to posts in the Moderation Hub, to a newly created post or to a previously published post. Once the post is published the tag would then be passed with the post as metadata via the API so your development team could customize the display of all "urgent" posts. Urgent posts could be marked with special styling or could be filtered into a separate display. This makes it easy for readers to identify breaking news or urgent posts.
- Key Events: In order to offer readers a summary of key posts from an in-depth live blog, you could tag posts "KeyEvents" in Content Studio, and then use the Key Events template (already created by the ScribbleLive Implementation Team) to visualize these posts into a key event summary. (The implementation team is currently working on updating the Key Events Template to support tagging).
- Filtering by Content Type or Theme: Users creating a live centre often use text commentary, images, and videos. Using tagging editors could tag all video content with a "Video" tag and then use the API to reuse the Video only content (published via Content Studio) in a separate Live Video center. Similarly if an editor was covering a football game they could tag team related content by the team name (e.g. "Juventus" or "Italy") and allow viewers to filter the published content according to their preferred team.
- Replay Content: During live TV events users publish content very rapidly for an engaging second screen experience. After the game or show is over editors add a "Replay" tag to those pieces of content that viewers would want to have access to as part of the summary. You can then filter the content via API by those custom tags into a separate visualization. This allows you to effectively reuse your "live" published content to create a compelling recap experience.
If you need assistance or have questions around the new API tagging system, please feel free to reach out anytime. Our implementation team can provide further documentation.
How does this work?
Adding Tags to RTE Posts / Published Posts
- Users can add tags to RTE posts or to Published posts by clicking the new Tag icon and entering in single or multiple tags.
- Tags on published content will not appear on the front-end posts nor are they available out of the box, but they can be leveraged via the API (as described above and below)
Retrieve / Add / Manage / Filter Tags via API
API users can add and manage tags published via the API. This ensures API developers have the flexibility to add tags when creating new posts, or to add / delete tags on published posts.
In addition API users can filter published content using tags. Single or multiple tags can be applied or included in the filter.
Good to know:
- Multiple Tags are treated as "OR" (If you would also like an option to include "AND" please let us know)
- We do not currently offer a way to return all posts with any tags
API Content target to Mod Hub
In addition to the tagging enhancements we also added another important API update. You can now target your API content into the Content Studio Moderation Hub, instead of directly publishing it. This allows users who create posts via the API, to add another level of moderation to their workflow.
Sending content into the Moderation Hub:
- Marking content to go directly into the Moderation Hub can be done by adding a send to moderation parameter to current calls that add content to events.
Once sent into the Moderation Hub:
- API Content then appears in Moderation Hub without requiring refresh
- In the Mod Hub a user can apply a filter (e.g. "API Content") to view only those posts added via API
- API content targeted to Mod Hub is visible from Moderation Hub by all users with access. Users can direct publish (approve), add tags, drag to RTE, delete.
Previously if content was created with HTML it could not be edited directly via API. The same applied for image posts. Using our new API endpoint the ability to edit image posts (image and caption) and edit HTML posts via API is now available: https://api.scribblelive.com/