Ultralink REST API
Display Only Calls I Can Make

Every Ultralink server has REST API endpoints that you can interact with to create new Ultralinks, modify existing ones and do just about anything with the Ultralink Databases that you can think of. You use the search input below to quickly find API calls that match against a given string. Or you can manually browse them by travesrsing the endpoint tree below.

This page allows you to explore that API and even try out specific API calls right here in the documentation itself. When making REST calls in your code that require authentication, you will need to supply the access_token argument with your currently checked out API Key which you can get from the Dashboard.

Using the Ultralink REST API directly can make sense in certain situations, but we recommend using our Client Libraries if there is one available in your language of choice. These interfaces are currently considered in beta and as such, are not set in stone.

Legend
Only Show Results
Open
These API calls do not any kind of authentication and are completely open.
Optional
These API calls are also open and do not require authentication but can use authentication parameters for extra functionality.
Contributor
Authentication is required. This is the most basic authorization level.
Editor
Authentication is required. Editors have more capabilities and privileges.
Admin
Authentication is required. Admins can do almost anything on the server.
U
<user identifier>Identifies a registered user on the Master. This can be either a user ID number or the user's email address.
DB
<database identifier>Identifies an Ultralink Database on the Master. This can be either a database ID number or the database name.
UL
<ultralink identifier>Identifies an Ultralink in a database. This can be either an Ultralink ID number or a vanity string.
J
<job identifier>Identifies a job in a database by it's ID number.
N
<notification identifier>Identifies a user notification by it's ID number.
S
<service identifier>Identifies an API service it's associated link type.
s
stringA simple string. No specific structure.
i
intA simple integer.
b
boolEither a value of true, false, 1 or zero.
t
timestampA UNIX timestamp.
d
dateA date string.
e
emailAn email address.
u
urlA simple URL.
w
wordA word string.
c
categoryA category string.
lt
linktypeA link type string.
cx
connectionA connection string.
ct
countryA two-letter country code.
la
languageA two-letter language code.
j
jsonString representation of a JSON object.
x
multichoiceOne of a set of various strings.
API
Open
/
https://ultralink.me/API/0.9.1/https://ultralink.me/API/0.9.1/
Execute
Simply returns successfully indicating that this Master and API version exist.
... Show Hidden ...
Open
exists
https://ultralink.me/API/0.9.1/?existshttps://ultralink.me/API/0.9.1/?exists
Execute
Returns successfully with the serverOptions (if any) indicating that this Master and API version exist.
Databases
Admin
db
https://ultralink.me/API/0.9.1/dbhttps://ultralink.me/API/0.9.1/db
Returns a list containing the ID and name for every database in the Master.
... Show Hidden ...
Optional
i
nameForDBID
Database ID.
https://ultralink.me/API/0.9.1/dbhttps://ultralink.me/API/0.9.1/db
nameForDBID
Execute
Returns the name for a given database ID.
Optional
s
IDForDBName
Database name.
https://ultralink.me/API/0.9.1/dbhttps://ultralink.me/API/0.9.1/db
IDForDBName
Execute
Returns the ID for a given database name.
Contributor
s
nameCheck
Proposed name for a new database
https://ultralink.me/API/0.9.1/dbhttps://ultralink.me/API/0.9.1/db
Examines a newly proposed database name to see if it fits the criteria for database names:
  • Cannot start with a number.
  • Must be 16 characters or less.
  • Must contain only lower case alphanumeric characters.
If nameCheck passes these tests and there is not already an existing database with this name, then it will return with success to indicate availability.
Contributor
s
create
The name of the new database to create
https://ultralink.me/API/0.9.1/dbhttps://ultralink.me/API/0.9.1/db
If the user isn't an admin of a database already then this attempts to create a new database for them with the name provided and makes them an admin for it.
Database
Optional
/<database identifier>
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Execute
This will return basic information about the Database such as it's ID, name and any affiliateKeys that might be associated with it. It will also return the auth level of the calling user.

If the calling user's auth level is that of a Contributor, this will also return any grants they might have as well as their currentDailyEditCount and currentDailyEditLimit.
... Show Hidden ...
Optional
s
recentUltralink
Word to search for.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
recentUltralink
Execute
Returns the ID for the most recently modified Ultralink within the last day that has the given word attached to it.
Optional
s
categorySuggestions
A partial catgory string to search on.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
categorySuggestions
Execute
Returns a category structure based on partial matches of categorySuggestions against the existing categories in the database.
Optional
j
connectionCommon
An array of commonality description objects describing the calculations.
lt
pullLinkType
A link type determining what link should be pulled out and included in the answer sets.
b
getIntersect
Indicating if an intersection array of all the commonality sets should also be returned.
i
uID
An Ultralink ID.
u
uURL
A URL attached to the Ultralink that you want to calculate commonality from.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
connectionCommon
pullLinkType
getIntersect
uID
uURL
Execute
Returns a result set for each commonality description objects passed in through connectionCommon. A commonality connection object has these fields:
  • peer - An Ultralink connection type indicating the set of related Ultralinks to calculate against.
  • common - An Ultralink connection type designating the type of Ultralinks that we want to calculate a commonality value between.
For every Ultralink connected to the one indicated by uURL through the connection type peer it calculates how many other Ultralinks exist in the database that both of these Ultralinks are connected to by the connection type common. Results are sorted by most common connections first.

Resultant sets are arrays that include information about each 'peer' Ultralink:
  • fID - The peer Ultralink's ID
  • word - Primary Word
  • image - Primary Image Link
  • C - Calculated commonality value
  • link - If any, a link attached to the peer Ultralink of type pullLinkType
Editor
ultralinkCount
https://ultralink.me/API/0.9.1/db/<database identifier>?ultralinkCounthttps://ultralink.me/API/0.9.1/db/?ultralinkCount
Returns the number of Ultralinks currently in this database.
Admin
j
updateAffiliateKeys
A JSON object describing the new affiliate key types and values.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Sets the affilliate keys for this database to the given values.
Admin
DB
sourceDatabase
The new database that we want to source from.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Changes the source database. A value of -1 indicates that there is no source database.
Admin
nuke
https://ultralink.me/API/0.9.1/db/<database identifier>?nukehttps://ultralink.me/API/0.9.1/db/?nuke
Destroys the database and all related data. Sets the default database for the user to be the Mainline.
Ultralink Listing
Optional
c
categoryUltralinks
A category string to search for Ultralinks on.
i
offset
Pagination offset.
i
limit
Pagination limit. Default: 100, Max: 1000.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
categoryUltralinks
offset
limit
Execute
Returns a set of Ultralinks that have a category string that begins with categoryUltralinks ordered by primary instance count descending.
Optional
s
connectionUltralinks
A connection string to search for Ultralinks on.
i
offset
Pagination offset.
i
limit
Pagination limit. Default: 100, Max: 1000.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
connectionUltralinks
offset
limit
Execute
Returns a set of Ultralinks that have a connection string that beings with connectionUltralinks ordered by primary instance count descending.
Information
Optional
remoteRoots
https://ultralink.me/API/0.9.1/db/<database identifier>?remoteRootshttps://ultralink.me/API/0.9.1/db/?remoteRoots
Execute
Returns a list of all the remote roots currently associated with this Database.
Optional
i
lookupVanityDescription
An Ultralink ID.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
lookupVanityDescription
Execute
Returns the vanity string for the Ultralink ID lookupVanityDescription or a null string if it does not exist.
Optional
s
lookupVanityName
An Ultralink vanity string.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
lookupVanityName
Execute
Returns the Ultralink ID for the given vanity name lookupVanityName or 0 if it does not exist.
Optional
i
url_ID
A url ID.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
url_ID
Execute
Returns the URL for the link associated with the ID url_ID.
Optional
u
url
A url.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
url
Execute
Returns the ID for url.
Optional
u
website_ID
A website url.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
website_ID
Execute
Looks up the website ID for the given website.
Optional
u
ulFromURL
A URL.
s
trimset
A set of characters to trim off the end of the URL. Defaults to '/'
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
ulFromURL
trimset
Execute
Returns the first Ultralink ID that has the given URL attached to it. A value of 0 means that none was found.
Optional
w
ulFromWord
A word string.
b
case
Case sensitivity.
c
category
A category string.
b
recent
Whether the search should be restricted to Ultralinks modified within the last day.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
ulFromWord
case
category
recent
Execute
Returns the first Ultralink ID that has word attached to it. You can optionally use case, category and recent to further narrow down your results. A value of 0 means that none was found.
The Holding Tank
Optional
c
submitUltralink
A category string.
u
URL
The URL for an initial link to be attached.
lt
urlType
The link type of above URL.
w
word
A an initial word to be attached.
b
caseSensitive
Case-sensitivty of the above word.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
submitUltralink
URL
urlType
word
caseSensitive
Execute
Submits information about a proposed Ultralink into the holding tank for review.
Editor
s
resolveNewUltralink
The descision string whether to accept or reject the submitted Ultralink.
U
contributor
The user that made this contribution.
c
category
A category string.
u
URL
The URL for an initial link to be attached.
lt
urlType
The link type of above URL.
w
word
A an initial word to be attached.
b
caseSensitive
Case-sensitivty of the above word.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Decides whether an Ultralink suggested by the submitUltralink command should actually be created or not. Removes the corresponding submitted entry record.
Editor
holdingTankCount
https://ultralink.me/API/0.9.1/db/<database identifier>?holdingTankCounthttps://ultralink.me/API/0.9.1/db/?holdingTankCount
Returns the number of items currently in the holding tank.
Editor
holdingTank
https://ultralink.me/API/0.9.1/db/<database identifier>?holdingTankhttps://ultralink.me/API/0.9.1/db/?holdingTank
Returns the entries currenlty in the holding tank.
Category Tree
Editor
c
categoryTree
A category string. Can be "".
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Gets a list of all the subcategories under the given category string as well as the number of subcategories and Ultralinks. Ordered by the count of Ultralinks in the category descending.
Editor
c
changeCategory
A category string that you want changed universally
c
newCategory
A category string that you want the above category to be changed to.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Modifies all applicable Ultralinks to change an existing category to newCategory.
Editor
categoryFlow
https://ultralink.me/API/0.9.1/db/<database identifier>?categoryFlowhttps://ultralink.me/API/0.9.1/db/?categoryFlow
Returns the current Category Flow state.
Editor
c
deleteCategoryFlow
The incoming category of the flow that is to be deleted.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Deletes a category flow.
Editor
c
addCategoryFlow
The incoming category of the flow that is to be added.
c
outgoingCategory
The outgoing category of the flow that is to be added.
c
originalAddCategory
The original incoming category of the flow that is to be added.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Adds a category flow.
Content Analysis
Contributor
s
EntityExtraction
A chunk of content to be analyzed.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Analzyes the provided content in the specified database and returns the detected Ultralinks.
Database Analytics
Admin
reports
https://ultralink.me/API/0.9.1/db/<database identifier>?reportshttps://ultralink.me/API/0.9.1/db/?reports
Returns the set of saved analytics reports saved in this database.
Admin
j
addReport
A JSON object describing the new database analytics report to be added.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Adds the specific database analytics report.
Admin
i
removeReport
The report ID to delete.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Removes the specified database analytics report.
Admin
historicalAnalytics
x
timeScale
The time scale of the data we are looking at.
i
timeDuration
The numeric length of the time slice that the data should examine in units defined by timeScale.
s
analyticsBreakdown
The type of analytics data that should be returned.
x
numericType
The type of numeric data that should be returned.
x
statusType
A user status type to filter the data though.
x
osType
A OS type to filter the data though.
x
browserType
A browser to filter the data though.
x
authType
A user authentication status to filter the data though.
x
actionType
A action to filter the data though.
s
linkType
A link type to filter the data through. Valuse can be all or any valid link type in this database.
https://ultralink.me/API/0.9.1/db/<database identifier>?historicalAnalyticshttps://ultralink.me/API/0.9.1/db/?historicalAnalytics
Returns a set of chart data based on the parameters passed in. Can leverage the analyticsCache with a resultant data hash passed in through historicalAnalytics. If the data has is identical to the one in the cache then it will block and wait on one of the analytics queues so that web services can long poll on this.
Website Analytics
Admin
u
myWebsites
A URL fragment that defines the scope of desired data.
x
orderBy
How to structure and order the results.
x
resultRestrict
Determines if the results should be restricted in any way.
x
timeScale
The time scale of the data we are looking at.
i
timeDuration
The numeric length of the time slice that the data should examine in units defined by timeScale.
s
search
A search string to restrict the entires under myWebsites can match against.
i
offset
Pagination offset.
i
limit
Pagination limit.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Gets a statistical look within timeDuration units of timeScale at a given URL Path fragment myWebsites which can also be "". Results can be ordered and organized by usage frequency, whether or not the Ultralinks are hosted natively, number of pages or numbers of clicks through orderBy.

Can restrict some configurations to only look at data connected to what is in the current content cache through resultRestrict. Can also restrict results to be limited through search as we well.
Admin
s
myContents
A URL fragment that defines the scope of desired data.
x
contentsType
Indicates what kind of content data is desired.
x
resultRestrict
Determines if the results should be restricted in any way.
b
restrictToThis
Indicates that results should only match the exact URL of myContents.
x
timeScale
The time scale of the data we are looking at.
i
timeDuration
The numeric length of the time slice that the data should examine in units defined by timeScale.
i
offset
Pagination offset.
i
limit
Pagination limit.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Gets Ultralink content and interaction information within timeDuration units of timeScale at a given URL Path fragment myWebsites which can also be the value all. You can specify what kind of Ultralink content you want through contentsType and select prescence of Ultralinks, categories or click data on both those as well.

Can restrict some configurations to only look at data connected to what is in the current content cache through resultRestrict. Can also restrict the results to an exact URL path fragment match instead of including everything under it as well through restrictToThis.

Can be paged through offset and limit.
User Analytics
Admin
s
associationSessions
An association identifier.
s
associationType
The type of the above identifier if given.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns a list of activity sessions for an association identifier associationSessions of type associationType. Sessions are defined as activity clusters at least 60 minutes apart from each other.
Admin
s
associationHistory
An association identifier.
t
startDate
A starting time to the session.
t
endDate
An ending time to the session.
i
eventNum
The number of events expected in the session as given by associationSessions
s
associationType
The type of the above identifier if given.
s
dataHash
A resultant data hash so as to leverage the analytics cache if possible.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns a set of events for an association identifier of a given type from a start date to an end date with a known number of events. Based on these paramters and a hash of the resultant data it wil try to lean on the analyticsCache if possible.
Hardcoded
Admin
u
websiteInfo
A website URL.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns the ID, time and blacklisted status for the given website.
Admin
u
pageInfo
A page URL.
i
websiteID
The ID for the website.
s
title
The title of the page.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns information for the given page URL.
Admin
contentSelectors
https://ultralink.me/API/0.9.1/db/<database identifier>?contentSelectorshttps://ultralink.me/API/0.9.1/db/?contentSelectors
Returns a list of all the websites currently with selector overrides.
Admin
urlModifiers
https://ultralink.me/API/0.9.1/db/<database identifier>?urlModifiershttps://ultralink.me/API/0.9.1/db/?urlModifiers
Returns a list of all the websites currently with URL modifiers.
Admin
customized
https://ultralink.me/API/0.9.1/db/<database identifier>?customizedhttps://ultralink.me/API/0.9.1/db/?customized
Returns a list of all the websites currently with custom url classifiers or selector overrides along with the website ID and URL.
Admin
i
deleteModifier
A ID specifying the url modifier.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Deletes a url modifier.
Admin
i
updateModifier
A ID specifying the url modifier.
b
enabled
Whether the modifier is enabled or not.
i
websiteID
The website ID for the site we are acting on.
s
regex
A regular expression specifying which sites are affected.
s
type
The type of modifier.
s
info
Info about the modifier.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Updates a url modifier.
Admin
addModifier
b
enabled
Whether the modifier is enabled or not.
i
websiteID
The website ID for the site we are acting on.
s
regex
A regular expression specifying which sites are affected.
s
type
The type of modifier.
s
info
Info about the modifier.
https://ultralink.me/API/0.9.1/db/<database identifier>?addModifierhttps://ultralink.me/API/0.9.1/db/?addModifier
Adds a url modifier.
Admin
j
saveClassifiers
A JSON object describing the set of desired url classifiers.
i
websiteID
The website ID for the site we are acting on.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Sets a given website's url classifiers to the set passed in.
Admin
i
deleteOverride
A ID specifying the override.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Deletes an override.
Admin
i
updateOverride
A ID specifying the override.
i
websiteID
The website ID for the site we are acting on.
s
regex
A regular expression specifying which sites are affected.
s
selector
A CSS selector specifying where to grab content on the pages.
i
priority
An execution priority.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Updates an override.
Admin
addOverride
i
websiteID
The website ID for the site we are acting on.
s
regex
A regular expression specifying which sites are affected.
s
selector
A CSS selector specifying where to grab content on the pages.
i
priority
An execution priority.
https://ultralink.me/API/0.9.1/db/<database identifier>?addOverridehttps://ultralink.me/API/0.9.1/db/?addOverride
Adds an override.
Admin
j
saveOverrides
A JSON object describing the set of desired selector overriddes.
i
websiteID
The website ID for the site we are acting on.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Sets a given website's selector overrides to the set passed in.
Content Cache
Admin
i
getFragment
A fragment ID number.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns the content for a fragment given it's ID.
Admin
x
getFragments
A content cache examination type.
i
lowerLimit
A numeric lower limit to restrict the results to. Has appropriate defaults if not specified
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns a set of content cache fragment information based on whether it passes a lower limit on a particular metric defined in getFragments. Default lower limits are:
repetitive500
size524288
stuffed2000
Admin
x
getCacheHistogram
A content cache examination type.
i
bucketSize
The size of the bucket to divide results into.
https://ultralink.me/API/0.9.1/db/<database identifier>https://ultralink.me/API/0.9.1/db/
Returns content cache chart data on a particular metric defined in getFragments in both absolute and logarithmic terms for a given bucketSize.
Modification History
Admin
editHistory
https://ultralink.me/API/0.9.1/db/<database identifier>?editHistoryhttps://ultralink.me/API/0.9.1/db/?editHistory
Returns all un-resolved modification entires for users with an auth level lower than Editor ordered by time ascending.
Ultralinks
Editor
/ul
https://ultralink.me/API/0.9.1/db/<database identifier>/ulhttps://ultralink.me/API/0.9.1/db//ul
Returns the number of Ultralinks currently in the database.
... Show Hidden ...
Optional
s
search
A string to search on.
b
wordSearch
Indicates whether the Ultralink's words should be searched. Will default to true if both wordSearch and categorySearch are false.
b
categorySearch
Indicates whether the Ultralink's categories should be searched.
x
sortType
A results sorting type.
b
exact
Indicates whether matches need to be exact.
b
includePages
Indicates whether page information for the Ultralinks should be included.
i
offset
Pagination offset.
i
limit
Pagination limit. Default: 100, Max: 1000.
https://ultralink.me/API/0.9.1/db/<database identifier>/ulhttps://ultralink.me/API/0.9.1/db//ul
search
wordSearch
categorySearch
sortType
exact
includePages
offset
limit
Execute
Returns a set of Ultralinks based on search. Searches can examine Ultralink words and category strings or both through wordSearch and categorySearch. Matches can be required to be exact or not.

Sorting can be by instance count, exact matching, alphabetical word order, word length or alphabetical category order through sortType. Results can optinally include information on what pages the Ultralinks resides as well through includePages.
Editor
s
linkQuery
A LIKE string to match the URL against.
lt
type
The like type to match against.
la
language
A langauge bias if any.
ct
country
A country bias if any.
i
primaryLink
Indication if the link should be the primary one or not.
https://ultralink.me/API/0.9.1/db/<database identifier>/ulhttps://ultralink.me/API/0.9.1/db//ul
Returns the Ultralink IDs that have links that fit the given criteria.
Editor
create
c
category
A category string.
i
needsReview
An integer indicating the needsReview value.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul?createhttps://ultralink.me/API/0.9.1/db//ul?create
Creates a new Ultralink.
Ultralink
Optional
/<ultralink identifier>
b
pageFeedback
Indicates if the Ultralink's complete page feedback should be included.
b
connectionInfo
Indicates if the Ultralink's connections should have preview information embedded.
b
affiliateKeys
Indicates if the affiliate keys for the database should be included.
b
remoteRoots
Indicates if the remote roots for the database should be included.
b
permissions
Indicates if the user's permissions on the Ultralink should be included.
b
noDefaults
Indicates if fields that have the default value should be included at all.
b
reduced
Indicates if the Ultralink format should come back in a size conscious format.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
pageFeedback
connectionInfo
affiliateKeys
remoteRoots
permissions
noDefaults
reduced
Execute
This will return structured information about the Ultralink. Optional arguments can control whether additional information is included or in what format the results should be returned.
... Show Hidden ...
Optional
u
specificPageFeedback
A URL.
w
word
A word string.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
specificPageFeedback
word
Execute
Returns the page feedback for this Ultralink on a given URL in pageFeedback for a word string. The word string may be "".
Optional
contributors
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?contributorshttps://ultralink.me/API/0.9.1/db//ul/?contributors
Execute
Returns a list of users who have made manual contributions to this Ultralink.
Optional
b
previewInfo
Indicates whether the returned preview info should be in a reduced format or not.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
previewInfo
Execute
Returns the set of information sufficient to presenting a small preview of an Ultralink: Primary Word, Primary Category, primary image, primary image meta info and whether it needs review or not.
Contributor
reviewStatus
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?reviewStatushttps://ultralink.me/API/0.9.1/db//ul/?reviewStatus
Sets this Ultralink's needsReview value to reviewStatus.
Editor
j
modify
A JSON object defining the Ultralink.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Modifies this Ultralink to match the content of the incoming Ultralink representation in modify. The one exception is page feedback which is additive.
Editor
j
merge
A JSON object listing the IDs of the Ultralinks to merge into this one.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Merges the Ultralinks given in merge into this one.
Editor
j
split
A JSON object describing what parts to split off into a seperate, new Ultralink.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Splits off elements of this Ultralink into a seperate Ultralink.
Editor
DB
cloneInto
The database that we want this Ultralink cloned into.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Creates a copy of this Ultralink in another specified database.
Editor
nuke
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?nukehttps://ultralink.me/API/0.9.1/db//ul/?nuke
Deletes this Ultralink.
Editor
ban
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?banhttps://ultralink.me/API/0.9.1/db//ul/?ban
Deletes this Ultralink and add all of it's words into the autogeneration banned list.
Admin
wordCommon
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?wordCommonhttps://ultralink.me/API/0.9.1/db//ul/?wordCommon
Returns a set of Ultralinks that have a common word with this one.
Admin
modificationDetermination
x
determination
A determination status.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Sets the status of the specified modification and sets the state of the Ultralink to what it was before the modification if the determination is "REVERTED".
Specific Information
Optional
time
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?timehttps://ultralink.me/API/0.9.1/db//ul/?time
Execute
Returns the last modification time of the Ultralink.
Optional
needsReview
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?needsReviewhttps://ultralink.me/API/0.9.1/db//ul/?needsReview
Execute
Returns the Ultralink's needsReview value.
Optional
pageFeedbacks
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?pageFeedbackshttps://ultralink.me/API/0.9.1/db//ul/?pageFeedbacks
Execute
Returns the Ultralink's pageFeedback values.
Optional
i
pageFeedbackSpecific
A page ID.
w
word
The page feedback word.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
pageFeedbackSpecific
word
Execute
Returns specific information about one of this Ultralink's page feedbacks.
Optional
words
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?wordshttps://ultralink.me/API/0.9.1/db//ul/?words
Execute
Returns the Ultralink's words.
Optional
w
wordSpecific
A word string.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
wordSpecific
Execute
Returns specific information about one of this Ultralink's words.
Optional
categories
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?categorieshttps://ultralink.me/API/0.9.1/db//ul/?categories
Execute
Returns the Ultralink's categories.
Optional
c
categorySpecific
A category string.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
categorySpecific
Execute
Returns specific information about one of this Ultralink's categories.
Optional
links
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?linkshttps://ultralink.me/API/0.9.1/db//ul/?links
Execute
Returns the Ultralink's links.
Optional
i
linkSpecific
A link ID.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
linkSpecific
Execute
Returns specific information about one of this Ultralink's links.
Optional
connections
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?connectionshttps://ultralink.me/API/0.9.1/db//ul/?connections
Execute
Returns the Ultralink's connections.
Optional
i
connectionA
The first connected Ultralink ID.
i
connectionB
The second connected Ultralink ID.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
connectionA
connectionB
Execute
Returns specific information about one of this Ultralink's connections.
Optional
primaryCategory
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?primaryCategoryhttps://ultralink.me/API/0.9.1/db//ul/?primaryCategory
Execute
Returns the Ultralink's Primary Category.
Targeted Editing
Editor
j
setWord
A JSON object representing the word.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Updates or inserts a word on this Ultralink.
Editor
j
removeWord
A JSON object representing the word.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes a word from this Ultralink.
Editor
j
setCategory
A JSON object representing the category.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Updates or inserts a category on this Ultralink.
Editor
j
removeCategory
A JSON object representing the category.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes a category from this Ultralink.
Editor
j
setLink
A JSON object representing the link.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Updates or inserts a link on this Ultralink.
Editor
j
removeLink
A JSON object representing the link.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes a link from this Ultralink.
Editor
j
setConnection
A JSON object representing the connection.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Updates or inserts a connection on this Ultralink.
Editor
j
removeConnection
A JSON object representing the connection.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes a connection from this Ultralink.
Editor
j
setPageFeedback
A JSON object representing the page feedback.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Updates or inserts a page feedback on this Ultralink.
Editor
j
removePageFeedback
A JSON object representing the page feedback.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes a page feedback from this Ultralink.
Analytics
Optional
websiteCount
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?websiteCounthttps://ultralink.me/API/0.9.1/db//ul/?websiteCount
Execute
Returns the number of websites this Ultralink is currently found on.
Optional
pageCount
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?pageCounthttps://ultralink.me/API/0.9.1/db//ul/?pageCount
Execute
Returns the number of pages this Ultralink is currently found on.
Optional
instanceCount
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?instanceCounthttps://ultralink.me/API/0.9.1/db//ul/?instanceCount
Execute
Returns the number of instances of this Ultralink.
Optional
instanceWebsites
i
offset
Pagination offset.
i
limit
Pagination limit.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?instanceWebsiteshttps://ultralink.me/API/0.9.1/db//ul/?instanceWebsites
offset
limit
Execute
Returns a list of websites that this Ultralink is known to be on. Result page is dictated by instanceWebsites and limit.
Optional
i
instancePages
A website ID.
i
offset
Pagination offset.
i
limit
Pagination limit.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
instancePages
offset
limit
Execute
Returns a list of pages on a given website instancePages that this Ultralink is known to be on.
Optional
path
x
timeScale
The time scale of the data we are looking at.
i
timeDuration
The numeric length of the time slice that the data should examine in units defined by timeScale.
u
pagePath
A URL path fragment determing the scope of the results.
b
restrictToThis
Indicates whether the results should be restricted to only the exact pagePath
x
resultRestrict
Determines if the results should be restricted in any way.
b
getAggregation
Determines if the extra aggreggation information should be include.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?pathhttps://ultralink.me/API/0.9.1/db//ul/?path
timeScale
timeDuration
pagePath
restrictToThis
resultRestrict
getAggregation
Execute
Returns a set of data outlining click activity for this Ultralink in a specifc URL path fragment pagePath within a specific timeScale and timeDuration. Can set whether the results should be restricted to only data connected to what is in the current content cache through resultRestrict. Can restrict the results to only the exact path instead of all the paths under it with restrictToThis. Can also add specific data on aggreggation through getAggreggation.
Optional
occurrences
x
timeScale
The time scale of the data we are looking at.
i
timeDuration
The numeric length of the time slice that the data should examine in units defined by timeScale.
s
word
A specific word to limit the occurrence results to.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?occurrenceshttps://ultralink.me/API/0.9.1/db//ul/?occurrences
timeScale
timeDuration
word
Execute
Returns chart data for historical occurrence counts for a time period specified by timeScale and timeDuration and optionally limited by word.
Optional
occurrencesAll
x
timeScale
The time scale of the data we are looking at.
i
timeDuration
The numeric length of the time slice that the data should examine in units defined by timeScale.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?occurrencesAllhttps://ultralink.me/API/0.9.1/db//ul/?occurrencesAll
timeScale
timeDuration
Execute
Returns chart data for historical occurrence counts for a time period specified by timeScale and timeDuration.
Optional
stats
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?statshttps://ultralink.me/API/0.9.1/db//ul/?stats
Execute
Returns some statistical information about this Ultralink's occurrences.
Optional
related
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?relatedhttps://ultralink.me/API/0.9.1/db//ul/?related
Execute
Returns a top 20 list of Ultralinks that appear in the same fragments as this one ordered by occurrence number descending.
Holding Tank Feedback
Optional
u
submitPageFeedback
A URL that this Ultralink needs a bias on.
i
feedback
A feedback bias
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
submitPageFeedback
feedback
Execute
Adds a page feedback value for the specified page into the holding tank for this Ultralink.
Optional
w
submitWord
A word string.
b
caseSensitive
Indicates case sensitivity.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
submitWord
caseSensitive
Execute
Adds a word into the holding tank for this Ultralink.
Optional
u
submitLink
A URL.
lt
type
The type of the above URL.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
submitLink
type
Execute
Adds a link into the holding tank for this Ultralink.
Optional
cx
submitConnection
A connection string.
i
connection_ID
The ID of another Ultralink to connect to.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
submitConnection
connection_ID
Execute
Adds a connection into the holding tank for this Ultralink.
Optional
c
submitCategory
A category string.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
submitCategory
Execute
Adds a category into the holding tank for this Ultralink.
Optional
i
reportLink
A URL ID
lt
type
The type of the above URL.
s
problem
The problem with the URL.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
reportLink
type
problem
Execute
Adds a link complaint into the holding tank for this Ultralink.
Optional
i
reportConnection
An ID for a connected Ultralink.
s
problem
The problem with the connection.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
reportConnection
problem
Execute
Adds a connection complaint into the holding tank for this Ultralink.
Editor
i
dismissReportedLink
A URL ID
s
problem
The problem of the above URL.
lt
type
The type of the above URL.
U
contributor
The user that made this contribution.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes a submitted link from the holding tank or a specific type, problem type and contributor.
Editor
i
resolvePageFeedback
A page ID.
x
resolution
The descision string on the submitted page feedback.
i
feedback
The feedback value.
U
contributor
The user that made this contribution.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes the submission entry for the new page feedback. If the resolution is 'accept' then it adds the page feedback.
Editor
u
resolveLink
A URL.
x
resolution
The descision string on the submitted link.
lt
type
The type of the above URL.
U
contributor
The user that made this contribution.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes the submission entry for the new link. If the resolution is 'accept' then it adds the link.
Editor
c
resolveCategory
A category string.
x
resolution
The descision string on the submitted category.
U
contributor
The user that made this contribution.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes the submission entry for the new category. If the resolution is 'accept' then it adds the category.
Editor
w
resolveWord
A word string.
x
resolution
The descision string on the submitted word.
b
caseSensitive
Indicates case sensitivity.
U
contributor
The user that made this contribution.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes the submission entry for the new word. If the resolution is 'accept' then it adds the page feedback.
Link Review
Editor
u
nukeURL
A URL.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Removes the URL nukeURL from the Ultralink.
Editor
u
acceptDetectedURL
A URL.
lt
type
The type of the above URL.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Adds the URL acceptDetectedURL to the Ultralink.
Fleshout
Editor
w
autogenFleshout
Word on this Ultralink to flesh out against.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//ul/
Uses the reference database to set the category for this Ultralink and add as many links as it can based on the word in autogenFleshout.
Editor
wikipediaLangFleshout
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>?wikipediaLangFleshouthttps://ultralink.me/API/0.9.1/db//ul/?wikipediaLangFleshout
Based off the Ultralink's English wikipedia link, this will try to add as many counterpart wikipedia pages in other languages as possible to the Ultralink.
Annotation
Optional
/annotation
la
language
A langauge bias if any.
ct
country
A country bias if any.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>/annotationhttps://ultralink.me/API/0.9.1/db//ul//annotation
language
country
Execute
Gets the annotation content for this Ultralink.
... Show Hidden ...
Editor
s
set
The new annotation content.
x
type
The type of content stored in the annotation.
la
language
A langauge bias if any.
ct
country
A country bias if any.
https://ultralink.me/API/0.9.1/db/<database identifier>/ul/<ultralink identifier>/annotationhttps://ultralink.me/API/0.9.1/db//ul//annotation
Sets the annotation content for this Ultralink.
Jobs
Admin
/jobs
https://ultralink.me/API/0.9.1/db/<database identifier>/jobshttps://ultralink.me/API/0.9.1/db//jobs
Returns a list of information on every job defined in the database.
... Show Hidden ...
Admin
tools
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs?toolshttps://ultralink.me/API/0.9.1/db//jobs?tools
Returns a complete set of all the job queries and operations currently defined in this database.
Admin
j
create
A JSON object describing the characteristics of the job to create.
https://ultralink.me/API/0.9.1/db/<database identifier>/jobshttps://ultralink.me/API/0.9.1/db//jobs
Creates a new job based on the creation parameters passed in by create.
Job
Admin
/<job identifier>
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>https://ultralink.me/API/0.9.1/db//jobs/
Returns basic information on this job.
... Show Hidden ...
Admin
refresh
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>?refreshhttps://ultralink.me/API/0.9.1/db//jobs/?refresh
Refreshes the status for this job and examines all of the currently assigned work to see if it is still valid.
Admin
assignments
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>?assignmentshttps://ultralink.me/API/0.9.1/db//jobs/?assignments
Gets a list of the assignment details for all users who have even completed any work for this job or are currently assigned work.
Work
Contributor
i
request
An amount of work to request assignment.
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>https://ultralink.me/API/0.9.1/db//jobs/
Attempts to assign an amount of work given through request to the current user for the job. If request is zero then if tries to assign the default amount for the job.
Contributor
i
get
A limit of how much assigned work should be returned.
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>https://ultralink.me/API/0.9.1/db//jobs/
Attempts to get assigned work data associated with the specified job for the current user up to a requested amount of getWork.
Admin
U
assign
The user to assign the work to.
i
amount
An amount of work to request assignment.
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>https://ultralink.me/API/0.9.1/db//jobs/
Attempts to assign amount of work to the user specified by assign.
Admin
U
deassign
The user to deassign work from.
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>https://ultralink.me/API/0.9.1/db//jobs/
Deassigns the user specified in deassign all of the work currently assigned to them.
Ultralinks
Contributor
/ul
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>/ulhttps://ultralink.me/API/0.9.1/db//jobs//ul
Gets a list of the Ultralinks currently assigned to the current user for the job.
... Show Hidden ...
Ultralink
Contributor
/<ultralink identifier>
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//jobs//ul/
Gets the work state of an Ultralink for the job if it has been assigned to the current user.
... Show Hidden ...
Contributor
i
operation
A valid operation ID for the job.
s
input
An input string if the operation requires it.
https://ultralink.me/API/0.9.1/db/<database identifier>/jobs/<job identifier>/ul/<ultralink identifier>https://ultralink.me/API/0.9.1/db//jobs//ul/
Commits an operation for the Ultralink in the job with an optional input.
Users
Admin
user
https://ultralink.me/API/0.9.1/userhttps://ultralink.me/API/0.9.1/user
Returns a list of all the users in the system.
... Show Hidden ...
Contributor
sessionTest
https://ultralink.me/API/0.9.1/user?sessionTesthttps://ultralink.me/API/0.9.1/user?sessionTest
Tests whether I have the correct authentication credentials and returns the user ID number (0 indicates un-authenticated).
Admin
s
accountSuggestion
A search string.
i
minAuth
A authorization level identifier.
https://ultralink.me/API/0.9.1/userhttps://ultralink.me/API/0.9.1/user
Returns a list of users based on a search string and minimum authorization level.
User
/<user identifier>
... Show Hidden ...
Open
login
https://ultralink.me/API/0.9.1/user/<user identifier>?loginhttps://ultralink.me/API/0.9.1/user/?login
Execute
Logs a user into the master giving them access to the dashboard and other protected content on the site.
Authorization
Admin
promote
https://ultralink.me/API/0.9.1/user/<user identifier>?promotehttps://ultralink.me/API/0.9.1/user/?promote
Sets this user's authorization level up a notch.
Admin
demote
https://ultralink.me/API/0.9.1/user/<user identifier>?demotehttps://ultralink.me/API/0.9.1/user/?demote
Sets this user's authorization level down a notch.
Me
Contributor
/me
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Returns basic information about my account such as ID, name, billingInfo, paymentAllocation, grants, settings, user_description_ID, achievements, defaultDatabaseAuth, underEdit, currentDailyEditCount, currentDailyEditLimit and premiumInsights.
... Show Hidden ...
Contributor
getAccount
https://ultralink.me/API/0.9.1/user/me?getAccounthttps://ultralink.me/API/0.9.1/user/me?getAccount
Returns a small set of information about my account: email, name, auth and ID.
Contributor
logout
https://ultralink.me/API/0.9.1/user/me?logouthttps://ultralink.me/API/0.9.1/user/me?logout
Logs me out of this master.
Contributor
inviteToCommunity
https://ultralink.me/API/0.9.1/user/me?inviteToCommunityhttps://ultralink.me/API/0.9.1/user/me?inviteToCommunity
Sends me an invite email for the Ultralink Slack Community.
Specific Information
Contributor
ID
https://ultralink.me/API/0.9.1/user/me?IDhttps://ultralink.me/API/0.9.1/user/me?ID
Gets my ID.
Contributor
email
https://ultralink.me/API/0.9.1/user/me?emailhttps://ultralink.me/API/0.9.1/user/me?email
Gets my email address.
Contributor
image
https://ultralink.me/API/0.9.1/user/me?imagehttps://ultralink.me/API/0.9.1/user/me?image
Gets my image URL.
Contributor
todaysEditCount
https://ultralink.me/API/0.9.1/user/me?todaysEditCounthttps://ultralink.me/API/0.9.1/user/me?todaysEditCount
Returns my edit count for today.
Achievements
Contributor
achievements
https://ultralink.me/API/0.9.1/user/me?achievementshttps://ultralink.me/API/0.9.1/user/me?achievements
Returns all my achievements.
Contributor
s
achievement
The name of the achievement.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Returns the achievement of type for me.
API Key
Contributor
APIKey
https://ultralink.me/API/0.9.1/user/me?APIKeyhttps://ultralink.me/API/0.9.1/user/me?APIKey
Returns the my API key and creates it if it doesn't already exist.
Contributor
revokeAPIKey
https://ultralink.me/API/0.9.1/user/me?revokeAPIKeyhttps://ultralink.me/API/0.9.1/user/me?revokeAPIKey
Revokes my API key.
Database Information
Contributor
DB
defaultDatabase
The desired default database.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Sets my default database value to defaultDatabase.
Contributor
DB
dbAuth
The Database in question.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Returns whether I have any authorization level on database dbAuth.
Contributor
DB
authForDB
The Database in question.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Returns the authorization level this user has on database dbAuth.
Contributor
DB
setAuthForDB
The Database in question.
i
auth
Database authorization level.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Sets the authorization level for me to auth on database db.
Contributor
databases
https://ultralink.me/API/0.9.1/user/me?databaseshttps://ultralink.me/API/0.9.1/user/me?databases
Returns an array containing information on all the databases this I have permissions to.
Information Update
Contributor
j
update
A JSON object with new user information values.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Updates my account name and/or description ID.
Settings
Contributor
j
getSettings
A JSON array of user setting key strings.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Returns all my user settings specified in getSettings.
Contributor
s
getSetting
A user setting key string.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Gets the value of my user setting identified by getSetting.
Contributor
j
nukeSetting
A JSON array of user setting key strings.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Deletes my user settings specified by nukeSetting.
Contributor
s
changeSetting
A user setting key string.
s
value
The value to set the user settting changeSetting to.
https://ultralink.me/API/0.9.1/user/mehttps://ultralink.me/API/0.9.1/user/me
Changes my user setting specified by changeSetting to value.
Applications
Contributor
/applications
https://ultralink.me/API/0.9.1/user/me/applicationshttps://ultralink.me/API/0.9.1/user/me/applications
Returns a list of OAuth2 applications registered on this server created by me.
... Show Hidden ...
Admin
s
create
An application name string.
u
redirectURI
A redirect URI.
https://ultralink.me/API/0.9.1/user/me/applicationshttps://ultralink.me/API/0.9.1/user/me/applications
Registers a new OAuth2 application for the Ultralink API on this master.
Notifications
Contributor
/notifications
https://ultralink.me/API/0.9.1/user/me/notificationshttps://ultralink.me/API/0.9.1/user/me/notifications
Returns a list of all my current notifications.
... Show Hidden ...
Contributor
s
registerDevice
A device identifier.
s
type
A string identifying what of device it is.
https://ultralink.me/API/0.9.1/user/me/notificationshttps://ultralink.me/API/0.9.1/user/me/notifications
Registers a device of type specified by registerDevice for notifications to me.
Notification
/<notification identifier>
https://ultralink.me/API/0.9.1/user/me/notifications/<notification identifier>https://ultralink.me/API/0.9.1/user/me/notifications/
Returns my notification for the ID.
... Show Hidden ...
Contributor
dismiss
https://ultralink.me/API/0.9.1/user/me/notifications/<notification identifier>?dismisshttps://ultralink.me/API/0.9.1/user/me/notifications/?dismiss
Dismisses one of my notifications with the given ID.
Jobs
Contributor
/jobs
https://ultralink.me/API/0.9.1/user/me/jobshttps://ultralink.me/API/0.9.1/user/me/jobs
Returns a list of jobs I could potentially be assigned work from.
... Show Hidden ...
Jobs
Contributor
/<database identifier>
https://ultralink.me/API/0.9.1/user/me/jobs/<database identifier>https://ultralink.me/API/0.9.1/user/me/jobs/
Returns a list of all the jobs that I have contributed to or been assigned to in this database.
... Show Hidden ...
Contributor
count
https://ultralink.me/API/0.9.1/user/me/jobs/<database identifier>?counthttps://ultralink.me/API/0.9.1/user/me/jobs/?count
Returns the number of my assigned and unanswered work in this database.
Contributor
potentialJobs
https://ultralink.me/API/0.9.1/user/me/jobs/<database identifier>?potentialJobshttps://ultralink.me/API/0.9.1/user/me/jobs/?potentialJobs
Returns a list of the potential jobs this user can be assigned to.