API Overview

Now that you know how the API works in general, this section lists the individual API methods that are available. The API methods are organized in a path-structure that logically groups together related API methods.

/persisted Methods for working with and executing persisted authenticated requests.


Retrieve information about persisted requests.


Create a new persisted request.


Update a persisted request.


Delete a persisted request.
/persisted/execute Execute a persisted request.
/processing Used for manipulating resources that can be used to customize selected aspects of the platform's processing.
/processing/dictionary/read Retrieve dictionary data and meta data.


Create a new dictionary.


Delete a dictionary.


Upload new or updated dictionary data or meta data. Dictionaries can be provided as Excel workbooks.


Revert to the previous dictionary data. Useful if a rollback is required.
/processing/linguistics/execute Generates a possibly customized content profile on the fly, given input text.
/profile/content Methods for working with content profiles.
/profile/content/external/delete Delete a customer-specified content profile configuration.
/profile/content/external/deleteAll Delete all customer-specified content profile configurations for a site.
/profile/content/external/read Retrieve a customer-specified content profile configuration.

Retrieve all customer-specified content profile configurations.

/profile/content/external/update Update or create a customer-specified content profile configuration. Enables content profile data to be augmented or modified.
/profile/content/fetch Retrieve the content profile of a given URL.
/profile/content/push Push a URL for refetching and content processing.
/profile/content/related Retrieve keywords which are statistically related to a set of specified keywords.
/profile/user Methods for working with user profiles.
/profile/user Retrieve a specific user profile.
/profile/user/external/update Upload information which will be associated with a given user
/profile/user/external/read Return the annotated data which has been uploaded and associated with a specific user


Delete the uploaded information associated with a specified user.

/profile/user/external/link Read customer user identifiers for an end user.
/profile/user/external/link/update Link an end user with a customer-specific user identifier.


/public Unauthenticated methods.
/public/date Retrieve the current date and time for use with authentication headers.
/site Methods for working with sites and site groups.


Retrieve information about sites.
/site/create Create a new site.


Update an existing site.


Retrieve information about a site group.


Create a new site group.


Update an existing site group.
/traffic Methods for working with traffic statistics.
/traffic Retrieve aggregated traffic data.
/traffic/event Retrieve top lists of aggregated event data.
/traffic/event/describe List groups available in /traffic/event.
/traffic/keyword Retrieve top lists of aggregated keywords from events and content profiles.
/traffic/keyword/describe List groups available in /traffic/keyword.
/traffic/custom Retrieve top lists of aggregated custom parameters from events.
/traffic/custom/describe List groups available in /traffic/custom.
/traffic/compare Compare the aggregated traffic based on two different sets of filters.
/traffic/related Retrieve similar items based on the recent page views.
/traffic/user Retrieve top lists of users behind the events matching a filter.
/traffic/user/interest Retrieve top lists of aggregated user interests.
/traffic/user/keyword Retrieve top lists for a range of aggregated user data.
/traffic/user/external Retrieve top lists for user data which has been associated with users through/profile/user/external/update.
/traffic/user/histogram Retrieve overall traffic distribution for users.
/traffic/user/histogram/event Retrieve event data cardinality distribution for users.


Have more questions? Submit a request


Powered by Zendesk