Use Topsy as a data source

Resources

Data Source Type: REST/URL
Authentication: API Key Authentication

Find your API Key
Sample Query:

Returns past 30 days worth of tweets for @Klipfolio.

https://otter.topsy.com/search.json?q=klipfolio&type=tweet&window=d30&apikey=APIKEY

Replace APIKEY with your API Key (see link above)
API Documentation: Topsy API Documentation

Step-by-Step

Creating a data source using Topsy

To create a data source using Topsy data, you need to accomplish 3 tasks:

  • Start the data source creation process
  • Craft a query and enter it in Klipfolio 
  • Add query parameters to the URL

Step 1: Start the data source creation process

To create a data source using Topsy, go to the New Data Source page in Klipfolio and select the REST/URL connector option.

Step 2: Craft the query and enter it in Klipfolio 

Refer to the Topsy API Docs to learn more about crafting a query. To help get you started, here are some examples of typical API calls:

  • https://otter.topsy.com/authorinfo.json?url=https://twitter.com/example
  • https://otter.topsy.com/linkposts.json?url=https://twitter.com/example
  • https://otter.topsy.com/urlinfo.json?url=https://twitter.com/example
  • https://otter.topsy.com/search.json?q=search-value

When you have crafted a query, enter it into Klipfolio.

Step 3: Add query parameters

Each type of API call will have required parameters associated with it. For instance, the search call requires you to fill out the q=search-term parameter. Klipfolio lets you add query parameters to the URL using the Query Parameters builder. This builder will automatically add the parameters to the URL using the correct syntax.

At the minimum, you will need to add your API Key to the query. These procedures will detail how to do that; however, you can apply these steps to other, optional, parameters.

  1. Click the Query Parameter link.
  2. In the Name field, type apikey.
  3. In the Value field, type your API Key.
  4. Select Query from the Type Menu

To learn what query parameters you can add to your URL, please refer to the Topsy API Docs.

Commonly used query parameters

You can use a variety of optional query parameters to further refine the data that you retrieve from Topsy. It's important to note that not every optional parameter will work with each type of call, so please refer to the Topsy API Docs. The following is a list of query parameters along with an example of a value you can use.

Name

Value

Type

perpage 50 Query
window d30 Query
type tweet Query
tracktype self__tweet Query

Learn More

Now that you have your data, here are some ideas on how to use it:

Did you have trouble with the material in this article?

These articles may help: