Webservice for interacting with MXNA 2.0


The MXNA 2.0 webservice allows read-only access to the Macromedia XML News Aggregator.


properties:
methods: getCategories, getFeeds, getFeedsByCategory, getFeedsByLanguage, getLanguages, getMostPopularFeeds, getMostPopularPosts, getMostProlificFeeds, getMostRecentPosts, getPostsByCategory, getPostsByFeed, getPostsBySmartCategory, getSearchHistory, getSmartCategories, search
* - private method

getCategories
remote query getCategories ( )

Returns a query with all MXNA 2.0 categories. Columns include: categoryId, categoryName.

getFeeds
remote query getFeeds ( )

Returns a query of all feeds aggregated by MXNA 2.0. Columns include: feedId, feedName, feedDescription, feedCategories, feedUrl, languageId, lastUpdated, siteName, siteUrl, and siteDescription. The column feedCategories is a comma-delimited list of all the categories the feed is in.

getFeedsByCategory
remote query getFeedsByCategory ( required numeric categoryId )

Returns a query of all feeds aggregated by MXNA 2.0 in the specified category. Columns include: feedId, feedName, feedDescription, feedCategories, feedUrl, languageId, lastUpdated, siteName, siteUrl, and siteDescription. The column feedCategories is a comma-delimited list of all the categories the feed is in. The category that was passed in will always be one of the categories included in the list.

Parameters:
   categoryId: numeric, required, categoryId - The ID of the category for which you want feeds.

getFeedsByLanguage
remote query getFeedsByLanguage ( required numeric languageId )

Returns a query of all feeds aggregated by MXNA 2.0 in the specified language. Columns include: feedId, feedName, feedDescription, feedCategories, feedUrl, languageId, lastUpdated, siteName, siteUrl, and siteDescription. The column feedCategories is a comma-delimited list of all the categories the feed is in.

Parameters:
   languageId: numeric, required, languageId - The ID of the language for which you want feeds.

getLanguages
remote query getLanguages ( )

Returns a query with all MXNA 2.0 languages. MXNA 2.0 supports just about all languages. The languages this function returns are those for which MXNA 2.0 has feeds. Columns include: languageId, languageName.

getMostPopularFeeds
remote query getMostPopularFeeds ( required numeric daysBack, required numeric limit )

Returns the specified number of feeds with the highest click average in the last 30 days. The limit cannot exceed 50. Columns include: feedId, feedName, feedDescription, clickAverage, totalClicks, postCount.

Parameters:
   daysBack: numeric, required, daysBack - The number of days you want to go back.
   limit: numeric, required, limit - The total number of rows you want returned.

getMostPopularPosts
remote query getMostPopularPosts ( required numeric daysBack, required numeric limit )

Returns the specified number of posts with the most clicks in the last 30 days. The limit cannot exceed 50. Columns include: postId, clicks, dateTimeAggregated, feedId, feedName, postTitle, postExcerpt, postLink.

Parameters:
   daysBack: numeric, required, daysBack - The number of days you want to go back.
   limit: numeric, required, limit - The total number of rows you want returned.

getMostProlificFeeds
remote query getMostProlificFeeds ( required numeric daysBack, required numeric limit )

Returns the specified number of feeds with the highest number of posts in the last 30 days. The limit cannot exceed 50. Columns include: feedId, feedName, feedDescription, clickAverage, totalClicks, postCount.

Parameters:
   daysBack: numeric, required, daysBack - The number of days you want to go back.
   limit: numeric, required, limit - The total number of rows you want returned.

getMostRecentPosts
remote query getMostRecentPosts ( required numeric limit, required numeric offset, required string languageIds )

Returns a query containing most recently aggregated posts. Columns include: postTitle, postExcerpt, postLink, clicks, ranking (1-11), uniqueId, dateTimeAggregated, and feedId.

Parameters:
   limit: numeric, required, limit - The total number of rows you want returned.
   offset: numeric, required, offset - Which row to start the search from (the first row is 0).
   languageIds: string, required, languageIds - A comma-delimited list of language IDs.

getPostsByCategory
remote query getPostsByCategory ( required numeric limit, required numeric offset, required numeric categoryId, required string languageIds )

Returns a query containing most recently aggregated posts in the specified category. Columns include: postTitle, postExcerpt, postLink, clicks, ranking (1-11), uniqueId, dateTimeAggregated, and feedId.

Parameters:
   limit: numeric, required, limit - The total number of rows you want returned.
   offset: numeric, required, offset - Which row to start the search from (the first row is 0).
   categoryId: numeric, required, categoryId - The category from which you want the most recent posts.
   languageIds: string, required, languageIds - A comma-delimited list of language IDs.

getPostsByFeed
remote query getPostsByFeed ( required numeric limit, required numeric offset, required numeric feedId )

Returns a query containing most recently aggregated posts in the specified feed. Columns include: postId, postTitle, postExcerpt, postLink, clicks, ranking (1-11), uniqueId, dateTimeAggregated, feedName, and feedId.

Parameters:
   limit: numeric, required, limit - The total number of rows you want returned.
   offset: numeric, required, offset - Which row to start the search from (the first row is 0).
   feedId: numeric, required, feedId - The feed from which you want the most recent posts.

getPostsBySmartCategory
remote query getPostsBySmartCategory ( required numeric limit, required numeric offset, required numeric smartCategoryId, required string smartCategoryKey, required string languageIds )

Returns a query containing most recently aggregated posts in the specified smart category. Columns include: postTitle, postExcerpt, postLink, clicks, ranking (1-11), uniqueId, dateTimeAggregated, and feedId.

Parameters:
   limit: numeric, required, limit - The total number of rows you want returned.
   offset: numeric, required, offset - Which row to start the search from (the first row is 0).
   smartCategoryId: numeric, required, smartCategoryId - The smart category from which you want the most recent posts.
   smartCategoryKey: string, required, smartCategoryKey - The smart category key.
   languageIds: string, required, languageIds - A comma-delimited list of language IDs.

getSearchHistory
remote query getSearchHistory ( )

Returns a query containing the last unique searches conducted with MXNA 2.0. Columns include: searchTerms.

getSmartCategories
remote query getSmartCategories ( )

Returns a query with all MXNA 2.0 smart categories. Columns include: smartCategoryId, smartCategoryName, smartCategoryKey.

search
remote query search ( required numeric limit, required numeric offset, required string searchTerms, required string sortBy, required string languageIds )

Returns a query containing posts resulting from a text search. Columns include: postTitle, postExcerpt, postLink, clicks, uniqueId, dateTimeAggregated, and feedId.

Parameters:
   limit: numeric, required, limit - The total number of rows you want returned.
   offset: numeric, required, offset - Which row to start the search from (the first row is 0).
   searchTerms: string, required, searchTerms - The terms being searched for.
   sortBy: string, required, sortBy - How you want the results ordered. Either 'date' or 'relevance'.
   languageIds: string, required, languageIds - A comma-delimited list of language IDs.