Add (POST) and list (GET) sources from the database, you may also use DELETE to remove a source.
deviceToken and apiKey are required for all requests.
get
Lists the most recent 1000 sources added by the authenticated user. The JSON will contain fields for TITLE and ID,
along with various other fields including some statistics from
Athena's log about how much data she is gathering.
The ID can also be used with a DELETE request to remove a source from the database.
The JSON response body looks like this:
[
{
"TOTAL_INSIGHTS": 6,
"RSS": "https://www.google.co.uk/alerts/feeds/18063037792485323000/8829033790769206021",
"TOTAL_RUNS": 1,
"TWITTERSEARCH": "",
"TOTAL_INDICATORS": 15,
"TITLE": "Google Alert - \"smart cities\" OR \"smart city\"",
"ID": 508784,
"SEARCHEXPRESSION": "",
"LAST_RUN": "July, 11 2015 01:53:00",
"TOTAL_ERRORS": 0,
"TWITTER": ""
},
{
"TOTAL_INSIGHTS": 42,
"RSS": "",
"TOTAL_RUNS": 19,
"TWITTERSEARCH": "",
"TOTAL_INDICATORS": 76,
"TITLE": "Steve Rosenbush",
"ID": 445297,
"SEARCHEXPRESSION": "",
"LAST_RUN": "July, 17 2015 02:35:00",
"TOTAL_ERRORS": 0,
"TWITTER": "Steve_Rosenbush"
}
]
Arguments:
optional
string
tag
A tag with which to filter the sources list
optional
numeric
sourceid
The ID number of a single source if you only wish to retrieve the data for one of them
delete
Remove a source from the database
Arguments:
required
numeric
id
ID number of the user's source to remove, you may only remove sources belonging to the authenticated user.
Responds with a JSON string containing a field called 'MESSAGE' with the value 'Success'
post
Submit a source:
@twitter_user, #twitter_search, RSS feed URL or Bing search query. The omniAdd function will figure out what it is and add the source to Athena's workload. She will then
begin gathering data from the sources per the schedule listed below. The response will be a JSON object with 'Success' and 'Error' fields. If the error field is
empty the request was successful, the success field will confirm that the input was correctly added to the database.
The JSON response body looks like this:
{
"SUCCESS": "",
"STREAM": "",
"ERROR": "",
"PROCESSSTREAM": ""
}
Schedule:
RSS Feeds - Saturday
Bing searches - Sunday
Tweets - Monday, Wednesday and Friday
Twitter Searches - Tuesday and Thursday
Arguments:
required
string
omniSource
Post a @twitter_user, #twitter_search, RSS feed or Bing search query.
optional
string
tag
A single tag to assign to the source when it is added, you can use the GET method in the tags endpoint if you wish to create a typeahead or list of tags for the user to select from. Please see the tags endpoint for further information. New tags may also be added by submitting a string in this argument.
required
string
deviceToken
The deviceToken stored locally after authentication