Introducing JotAPI, a powerful and innovative API solution designed to help businesses expand the functionality of their own systems with advanced information management and knowledge discovery features. As an integral component of Jotup's comprehensive knowledge ecosystem, JotAPI seamlessly integrates with your existing systems, providing a connected experience for managing and customizing news content, summarisation, tagging, and sensemaking options.
By leveraging the powerful combination of Jotup's modular tools, AI-powered summarisers, and JotAPI's advanced features, your organization can create an efficient and connected knowledge workspace tailored to your specific requirements.
Several key Jotup features are available via the API:
- Extractor-summariser (exsumm) backend for generation of summaries and insights
- Newsfeed system to automatically monitor and summarise news, as well as extract metadata from the news items
- Access to a large amount of data held on Jotup, for example, corporate information on hundreds of thousands of currently-active organisations
The breakdown for every API call, as well as all data structures involved is as follows:
Notes
- all API calls start with https://jotup.co/api
- data is always returned as a JSON payload
- all tags are identified by 'Term reference' ID integer rather than
Upcoming improvements
- Source control
- select which exact sources to receive news from
- add custom sources to Newsfeeds
- Flexible tag search combinations
- rather than the current 'any' / 'focus' system, this will allows users to set up Newsfeeds (and do searches) with Solr Query syntax, allowing for infinitely flexible combinations of search parameters
Analysis tools
These provide ad-hoc access to JotAPI sensemaking tools
| Feature |
Description |
Additional Information |
|---|
| get Trending Tags |
Retrieves a list of currently trending tags |
| API Callback URL |
/trending |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
|
| Optional Parameters |
|
| Returned Data |
| trending_tags [array] (Array of trending tags, as Term Reference) |
|
|
| get Content Types |
Retrieves the content types currently supported by Jotup / JotAPI |
| API Callback URL |
/type |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
|
| Optional Parameters |
|
| Returned Data |
| updated_types_list[string] (comma-separated list of content types) |
|
|
| get Tag info from Term Reference |
Retrieves tag information from a Term Reference. |
| API Callback URL |
/type |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| term_reference [integer] (Tag Term Reference) |
|
| Optional Parameters |
|
| Returned Data |
| Taxonomy Term*** [array] (Array of Taxonomy Term values) |
|
|
| analyze URL for Tag suggestions |
Analyzes a URL to suggest relevant tags |
| API Callback URL |
/analyse |
| POST or GET |
POST |
| Required Parameters |
| api_key [string] (API Key) |
| url [string] (URL) |
|
| Optional Parameters |
|
| Returned Data |
| suggested_tags [array] (Array of suggested tags, as Term References) |
|
|
| search News Items |
Searches for news items based on date range and keywords |
| API Callback URL |
/all |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| date_range [string] (Look back this number of days) |
| tags [string] (Comma-separated keywords) |
|
| Optional Parameters |
| sort_by [string] (Sort results by: 'relevance', 'date') |
|
| Returned Data |
| News Items* [array] (Array of news items) |
|
|
| summarise a web page |
Returns a summary of a web page from a supplied URL |
| API Callback URL |
/websumm |
| POST or GET |
POST |
| Required Parameters |
| api_key [string] (API Key) |
| URL [string] (URL of a web page) |
|
| Optional Parameters |
|
| Returned Data |
| Web Summary* [array] (array of Web Summary fields) |
|
|
| analyse an organisation |
Returns an organisation summary based on a supplied URL or name. If Jotup knows about the organisation, an Organisation tag will also be returned. |
| API Callback URL |
/orgsumm |
| POST or GET |
POST |
| Required Parameters |
| api_key [string] (API Key) |
|
| Optional Parameters |
| URL [string] (URL of the organisation's web page) |
| Name [string] (organisation name) |
|
| Returned Data |
| Organisation Summary* [array] (array of Organisation summary fields) |
|
|
Newsfeed Controls
Basic commands to control Newsfeeds
| Feature |
Description |
Additional Information |
|---|
| start Newsfeed |
Creates and starts a new newsfeed |
| API Callback URL |
/start |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
|
| Optional Parameters |
|
| Returned Data |
| newsfeed_id [integer] (Newsfeed ID) |
|
|
| poll Newsfeed |
Fetches news from the newsfeed |
| API Callback URL |
/fetch |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
|
| Optional Parameters |
| date_range [integer] (Date range in days; if set all matching news for the date range will return; otherwise only latest unread news will be returned) |
|
| Returned Data |
| news_items* [array] (Array of news items) |
|
|
| Newsfeed status |
Returns the current settings and status of the newsfeed |
| API Callback URL |
/check |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| newsfeed_id [integer] (Newsfeed ID) |
|
| Optional Parameters |
|
| Returned Data |
| topics array |
| focus_status [string] (Focus status) |
| types array (Content types) |
| purge_interval [integer] (Purge interval) |
|
|
| pause Newsfeed |
Pauses the newsfeed, keeping the settings and tags but stopping news delivery |
| API Callback URL |
/pause |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
|
| Optional Parameters |
|
| Returned Data |
| feed_status [boolean] (0 = feed paused) |
|
|
| resume Newsfeed |
Resumes a paused newsfeed, continuing news delivery with the previous settings and tags |
| API Callback URL |
/unpause |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
|
| Optional Parameters |
|
| Returned Data |
| feed_status [string] (1 = feed active) |
|
|
| delete Newsfeed |
Deletes a newsfeed, permanently removing all settings, tags, and content |
| API Callback URL |
/delete |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
|
| Optional Parameters |
|
| Returned Data |
| delete_status [string] (Delete status) |
|
|
Newsfeed Parameters
Adjust parameters of the Newsfeeds, including what they should look for.
| Feature |
Description |
Additional Information |
|---|
| Tags (any) |
Make the newsfeed receive news matching any supplied tag |
| API Callback URL |
/any |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| tags [string] (Comma-separated words/phrases) |
|
| Optional Parameters |
|
| Returned Data |
| update_status [string] (Status of the update) |
|
|
| Tags (focused) |
If some tags the newsfeed is to look for are more important than others, list them in order from most to least important. Optionally specify several compulsory tags by telling Jotbot their quantity and placing them at the start of the tag list. By default, the newsfeed treats only the 1st tag as compulsory |
| API Callback URL |
/focus |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| tags [string] (Comma-separated words/phrases) |
|
| Optional Parameters |
| limit [integer] (Limit, optional) |
|
| Returned Data |
| update_status [string] (Status of the update) |
|
|
| set Content Types |
Sets the content types for the newsfeed |
| API Callback URL |
/type_set |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
| types [string] (Comma-separated list of types, optional) |
|
| Optional Parameters |
|
| Returned Data |
| updated_types_list [string] (Updated list of content types) |
|
|
| set Items Limit |
Sets the limit for the number of items the newsfeed will return |
| API Callback URL |
/limit |
| POST or GET |
GET |
| Required Parameters |
| api_key [string] (API Key) |
| channel_id [string] (Channel ID) |
| limit [integer] (Limit) |
|
| Optional Parameters |
|
| Returned Data |
| updated_items_limit [integer] (Updated items limit) |
|
|
Content Types
Where JotAPI returns specific Content Types, i.e. News Item, Web Summary, and Organisation items, the following fields are returned:
| Content Type |
Description |
Fields
| Field name |
Machine name |
Field Type |
|
| News Item |
Latest news, commercial intelligence, research and regulatory/statutory information. |
| News Title |
title |
Text |
| Author |
field_author_new |
Link |
| Type |
field_types |
List (text) |
| Provider |
field_provider |
Link |
| Key Points |
field_summary |
Long text |
| Retrieved on |
field_date_retrieved |
Date (Unix timestamp) |
| URL |
field_url |
Link |
| Image |
field_image |
Image |
| Reference |
field_reference |
Text |
| Archived version(s) |
field_archived_version_s_availab |
Link |
| Embedded Content |
field_embedded_media |
Long text |
| File attachments |
upload |
File |
| Version |
field_version |
Text |
| Tags |
field_keywords |
Term reference |
| Related News |
field_related_news |
Link |
| Key takeaway |
field_summary_repeater |
Long text |
| Image Link |
field_image_link |
Link |
| Geotags |
field_geotags |
Term reference |
| Stock Symbol |
field_stock_symbol |
Term reference |
| Organisation |
field_organisation_tags |
Term reference |
| Autogenerated Org String Alert |
field__alert |
Text |
| Website |
field_website |
Link |
| Full Text |
field_full_text |
Long text |
| Copyright |
field_copyright |
Text |
| Item ID |
field_item_id |
Text |
| favicon_url |
field_favicon_url |
Link |
| Priority |
field_priority |
Integer |
|
| Web Summary |
Summary of a web page, or any document, retrieved from a specific URL. |
| Title |
title |
Text |
| Author |
field_author_new |
Link |
| Type |
field_types |
List (text) |
| Key Points |
field_summary |
Long text |
| Published around |
field_yr |
Integer |
| Retrieved on |
field_date_retrieved |
Date (Unix timestamp) |
| URL |
field_url |
Link |
| Image |
field_image |
Image |
| Reference |
field_reference |
Text |
| Archived version(s) |
field_archived_version_s_availab |
Link |
| Embedded Content |
field_embedded_media |
Long text |
| File attachments |
upload |
File |
| Tags |
field_keywords |
Term reference |
| Key takeaway |
field_summary_repeater |
Long text |
| Image Link |
field_image_link |
Link |
| Geotags |
field_geotags |
Term reference |
| Original HTML |
field_full_text |
Long text |
| favicon_url |
field_favicon_url |
Link |
| Priority |
field_priority |
Integer |
|
| Organisation |
Summary of an organisation or project.
NOTE: this returns an automatic lookup summary from a supplied URL / name. Detailed information, where available, is supplied inside an Organisation tag, which may be returned within the Organisation summary if such information exists within Jotup about the specific organisation.
|
| Name |
title |
String |
| Image |
field_image |
Image |
| Organisation profile tag |
field_organisation_tags |
Term reference |
| Website |
field_website |
Link |
| Stock Symbol |
field_stock_symbol |
Term reference |
| Notes |
body |
Long text |
| Tags |
field_keywords |
Term reference |
| Geotags |
field_geotags |
Term reference |
| Address |
field_address |
String |
| Contact |
field_contact |
Text |
|
Taxonomy Term values
There are several types of Taxonomy Terms (aka "Tags") on Jotup:
| Type |
Description |
Fields
| Field name |
Machine name |
Type |
|
| Content Tags |
With a range of ~5m different subjects and an infinite number of combinations thereof, these provide accurate and user-friendly means of discovering and organising information on any possible subject, no matter how simple or complex |
|
| Locations |
Provide accurate geolocation for any content item and enable convenient location-based search |
|
| Organisations |
Identifies and overviews commercial, governmental, non-profit and other entities, as well as certain stand-alone projects, e.g. scientific collaborations
NOTE: this returns information about an Organisation held centrally within a specific Jotup taxonomy term. For ad-hoc organisation lookups, or if you need to find out the Term Reference ID for the Organisation term, use 'analyse organisation' API call, which will return an Organisation summary with the appropriate Organisations tag Term Reference ID.
|
| Name |
name |
String |
| Description |
description |
Text |
| Address |
field_address |
Text |
| Locations |
field_geotags |
Term reference |
| Stock Symbol |
field_stock_symbol |
Term reference |
| Organisation Data |
field_organisation_data |
Long text |
| Earnings Calendar |
field_earnings_calendar |
Long text |
| Income Statement |
field_income_statement |
Long text |
| Last updated |
field_date_retrieved |
Date (Unix timestamp) |
| Related Organisations |
field_organisation_tags |
Term reference |
| Parent Organisation |
field_parent_org |
Term reference |
| Child Organisation |
child_org |
Term reference |
| Associated Tags |
field_keywords |
Term reference |
| Main Tag |
field_main_tag |
Boolean |
| Ticker blacklist |
field_ticker_blacklist |
Boolean |
| Common Word Warning |
field_common_warning |
Boolean |
| Twitter |
field_twitter |
Text |
| Linkedin |
field_linkedin |
Text |
| Sibling / Otherwise known as |
field_sibling |
Term reference |
|
| Stock Symbols |
Augments the Organisations vocabulary by providing a database of ticker symbols linking almost all publicly-traded stocks with their respective companies |
| Name |
name |
string |
| Exchange |
field_exchange |
text |
|
Each Taxonomy Term ("Tag") is updated as relevant information comes in.
For further enquiries, please contact us.
