SEO & Prefetch API Reference

The Prefetch API is not part of the default Tickaroo PRO plan. Please contact our support if you want to use it.

General Search Engine Visibility

While using a pure Javascript is very convenient, it has several drawbacks when it comes to visibility of content to search engines. Search engines are get better at evaluating Javascript but most are not able to index content loaded by Javascript. The only exception here is Google, which is able to read the first page of a liveblog integrated via EmbedJS. If this is enough for your business needs, you don’t have to take any further steps!

Increasing Visibility

If however this is not enough, we provide an API to prefetch content from Tickaroo as plain HTML from our Servers. Your CMS can then include the prefetched Content into the delivered HTML. On the client side you still need to include our script to provide the user experience including pagination, view tracking, auto refresh, etc.

Fetching a Ticker

To call backend APIs you need to supply your Client ID and Client Secret. You need to make sure to protect your Client Secret from end users. Never use a Client Secret in your frontend!

You can fetch the HTML of a ticker using the following URL:

https://www.tickaroo.com/embed/ticker.html

Required parameters:

  • id (String) ID of the liveblog (required)
  • client_id (String) Your Client ID supplied by Tickaroo (required)
  • client_secret (String) Your Client Secret supplied by Tickaroo (required)
  • limit (Integer) The number of items to fetch (default: 15, set to 0 for maximum)
  • show_event_meta (String) enables reporter info in event. must be one of: ‘off’, ‘ticker’, ‘reporter’ or ‘all’ (default: off)
  • style (‘v1’, ‘v2’, ‘imagegrid’) Load a predefined liveblog HTML style. Usually “v2” for new implementations

Combining Prefetch and Javascript

To combine Prefetch and Javascript you need to use the same HTML Container for both. To avoid problems you should also set the same parameters in both calls.

Example:

<div id="ticker">
  <!-- Insert prefetch content from 
   https://www.tickaroo.com/embed/ticker.html?id=540433f6a0b3a0c594d85420&limit=50&style=v2 -->
</div>
<script>
  Tickaroo.embedTicker({
    container: "#ticker",
    id: "540433f6a0b3a0c594d85420",
    style: 'v2',
    limit: 50
  });
</script>