SWI Server provides social media monitoring data through its REST API. The API makes integration of social media monitoring with existing enterprise software easy. For example, CRM and Collaboration software can use SWI Server API to automate the data flow from social media monitoring to enterprise platform.  Through API, SWI server automatically categorizes social contents and identifies leads, which are then automatically pulled into company's CRM or other enterprise software for timely actions.

API Calls

api-url = <swi server url>/api

Example: http://localhost/swiserver/api

api call url = <api-url>?appid=&method=[&params]

appid: client application id, issued by the swi server admin.

Method: getTopics

API method getTopics returns all topic lists or a selected list, each list containing all the topics defined for the list. The list and topic has a monitor url that links out to the corresponding monitoring page on the SWI server. This method gives enough information to make the simplest integration between social media monitoring and enterprise collaboration platform.

URL: <api-url>?method=getTopics&appid=[&listid=]

Parameters:

listid

Topic list id. It's optional.

If present, returns topics of the list. If not present, returns all topics for all lists.

XML response format:
XML-encoded parameters: name, sourceId, monitorUrl

Example API calls:

To get all lists and topics:
http://localhost:8080/cis/api?method=gettopics&appid=abc

To get topics for one list: 
http://localhost:8080/cis/api?method=gettopics&listid=123&appid=abc

XML response:

<?xml version="1.0" encoding="UTF-8"?>
<web2express>
<monitor listCount="1" monitorUrl="http://localhost:8080/cis" > 
  <list id="1074" name="competition" topicCount="3" monitorUrl="http://localhost:8080/cis/listtopic?tlid=1074" > 
    <topic id="1076" name="google alert" sourceId="1" probeId="1075" monitorUrl="http://localhost:8080/cis/topic?listid=1074&amp;tid=1076&amp;pid=1075" /> 
    <topic id="1080" name="radian6" sourceId="2" probeId="1079" monitorUrl="http://localhost:8080/cis/topic?listid=1074&amp;tid=1080&amp;pid=1079" /> 
    <topic id="1082" name="web2express" sourceId="3" probeId="1081" monitorUrl="http://localhost:8080/cis/topic?listid=1074&amp;tid=1082&amp;pid=1081" /> 
  </list> 
</monitor> 
</web2express>

Method: getTopicStats

Method getTopicStats returns stats for topic lists or topics, including counts for contents, counts for positive sense or negative sense. 

URL: <api-url>?method=getTopicStats&appid=[&listid=&topicid=&days=]

Parameters:

listid	Topic list id. It's optional.	If present, returns list stats. If not present, returns stats for all lists.
topicid	Topic id. Requiring listid co-present.	If present, return stats for the topic only.
days	Number of days starting from now.	Range=1-30. Default=30.

XML response format for monitor stats:
XML-encoded parameters: name, sourceId, monitorUrl

Example API calls:

To get stats for all lists:
http://localhost:8080/cis/api?method=gettopicstats&appid=abc

Xml response:


To get stats for one list and its topics:
http://localhost:8080/cis/api?method=gettopicstats&appid=abc&listid=1074

XML response:

To get stats for one topic:
http://localhost:8080/cis/api?method=gettopicstats&appid=abc&listid=1074&topicid=1080

XML response:

Method: getTopicContents

Method getTopicContents provides filtered contents for a topic list or a topic. Data type can be specified to get public updates, blogs or news.

URL: <api-url>?method=getTopicContents&appid=&listid=[&topicid=&=datatype=&sense=&start=&max=]

Parameters:

listid	Topic list id. It's required.	Returns contents for all topics in the list.
topicid	Topic id. Optional. Requiring listid co-present.	If present, return contents for the topic only.
datatype	Content data type. Optional.	1=tweet, 2=blog, 3=news.   Default=1. Not applied when sense is present.
sense	Sense of the context. Optional.	pos=positive, neg=negative. default is none. Applied to topic only.
start	Start index for returned contents. Optional.	0-based. Default=0. Results are sorted by time in descending order.
max	Max number of contents to return. Optional.	Range=1-100. Default=20.

XML response format for content:
XML-encoded parameters: name, sourceId, monitorUrl, title, link, author, publisher, source, text, authorUrl, engageUrl
Tweet has authorUrl linked to twitter user page.
Tweet and blog have engageUrl linked to SWI Server for engagement.

Example uses:

To get contents for topic list:
http://localhost:8080/cis/api?method=gettopiccontents&appid=abc&listid=1074

To get contents for a topic:
http://localhost:8080/cis/api?method=gettopiccontents&appid=abc&listid=1074&topicid=1076&datatype=1

To get contents for a topic that have positive sense:
http://localhost:8080/cis/api?method=gettopiccontents&appid=abc&listid=1074&topicid=1076&datatype=1&sense=1

Sample XML responses:

Method: getAuthors

Method getAuthors provides authors of filtered social contents or social leads.

URL: <api-url>?method=getAuthors&appid=[&lead=&sort=&start=&max=]

Parameters:

lead	Author is selected as lead or not. Optional.	true or false (default)
sort	Authors are sorted by time or content count. Optional.	1=by count, 2=by time (default)
start	Start index for returned contents. Optional.	0-based. Default=0.
max	Max number of contents to return. Optional.	Range=1-1000. Default=100.

XML response format:
XML-encoded parameters: userId, name, publisher, categories, monitorUrl

Example uses:

To get latest authors of social contents:
http://localhost:8080/cis/api?method=getauthors&appid=abc

To get latest social leads:
http://localhost:8080/cis/api?method=getauthors&appid=abc&lead=true

Sample XML response:

Error Response

Example:

Please let us know if you need more API support.