Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 24 Next »

BLADE offers simplified data retrieval contained within a single URL. The BLADE module provides you access to all of your TweetOut data in XML, RSS, or JSON formats so that you can use the same dynamic broadcast TweetOut content on any platform.  
 
You assemble direct query URL access to your data for formatted results using the Reports > BLADE option.

Tweet URL Generator

  Use the Tweet URL Generator to assemble the direct query URL for Twitter content.

  1. Specify URL parameters, as defined in the following table.
  2. Click Generate to produce the query string in the specified format based on the parameters you set.
  3. Click Test to generate data in the specified format in a new browser tab based on the parameters you set. Use the Test function to ensure that the topic or playlist returns appropriate results and to view the format of the output.
  4. Copy and paste the Query String generated in your platforms as needed.   

URL ParameterDescription
FormatSelect the data format. Select from: XML, JSON, or RSS.
Topic or PlaylistSelect a topic or playlist.
Limit

Specify the maximum number of Tweets returned in results. Overrides the Broadcast Count and Play Count values set in Flow for the topic or playlist.

Note: When left blank, the Broadcast Count or Play Count value set in Flow for the topic or playlist is applied.

Max Plays

Specify the maximum number of times that a Tweet can be output. For example, if you set Max Plays to 3, then only Tweets played less than 3 times (0, 1, or 2) are returned for future output.

Note: You must also enable the Mark Played option for this to be effective. If the Tweet’s individual play counts are not being set then the Max Plays option cannot be effective.

Mark PlayedSpecify whether Tweets will be marked as played.
  • When selected, the play count is incremented for all Tweets in the results, which affects the Max Plays value above.
  • When cleared, play count is not incremented, which does not affect the Max Plays value above.

This option can be useful when testing before broadcast. While testing, clear this option to prevent Tweets from being marked as played. When you are ready for broadcast, select this option if you are using the Max Plays option to count and control the number of times a single Tweet is retrieved for play out.

Avatar ImagesSpecify whether avatar images are included in the BLADE output as a Base64 string (when they are available with the Tweets).
  • When selected, avatars are included in the output.
  • When cleared, avatars are not included in the output. 

Note: The results always include the available avatar image URLs regardless of this setting. Only enable this option if your platform can convert a Base64 string to an image and cannot effectively use the URL to access the image.

Facebook Post URL Generator

Use the Facebook Post URL Generator to assemble the direct query URL for Facebook post content.

  1. Specify URL parameters, as defined in the following table.
  2. Click Generate to produce the query string in the specified format based on the parameters you set.
  3. Click Test to generate data in the specified format in a new browser tab based on the parameters you set. Use the Test function to ensure that the topic or playlist returns appropriate results and to view the format of the output.
  4. Copy and paste the Query String generated in your platforms as needed.  

 

URL ParameterDescription
FormatSelect the data format. Select from: XML, JSON, or RSS.
Topic or PlaylistSelect a topic or playlist.
Limit

Specify the maximum number of posts returned in results. Overrides the Broadcast Count or Play Count value set in Flow for the topic or playlist.

Note: When left blank, the Broadcast Count value set in Flow for the topic or playlist is applied.

Max Plays

Specify the maximum number of times that a post can be output. For example, if you set Max Plays to 3, then only posts played less than 3 times (0, 1, or 2) are returned for future output.

Note: You must also enable the Mark Played option for this to be effective. If the Tweet’s individual play counts are not being set then the Max Plays option cannot be effective.

Mark PlayedSpecify whether posts will be marked as played. This option can be useful when testing before broadcast.
  • When selected, the play count is incremented for all posts in the results, which affects the Max Plays value above.
  • When cleared, play count is not incremented, which does not affect the Max Plays value above.
RSS ImagesWhen Facebook posts include images, select this option to include a link to the image in the RSS results.
Clear the option to prevent the image links from being included with post content. 

Story URL Generator

Use the Story URL Generator to assemble the direct query URL for story content.

  1. Specify URL parameters, as defined in the following table.
  2. Click Generate to produce the query string in the specified format based on the parameters you set.
  3. Click Test to generate data in the specified format in a new browser tab based on the parameters you set. Use the Test function to ensure that the topic returns appropriate results and to view the format of the output.
  4. Copy and paste the Query String generated in your platforms as needed.

URL ParameterDescription
FormatSelect the data format. Select from: XML, JSON, or RSS.
TopicSelect a topic from the list.
LimitSpecify the maximum number of stories returned in results.


Implementing a JSON Fetch

For code examples on consuming the JSON data from BLADE, see Using JSONP from BLADE

In this section:

Unable to render {include} The included page could not be found.

Unable to render {include} The included page could not be found.

 

  • No labels