Warning: session_start() [function.session-start]: open(/home/reg8rww/sessions/7/3/sess_735f7b1bbed8a0b5d48c602e0bfec8e9, O_RDWR) failed: No space left on device (28) in /home/reg8rww/public_html/platform/pagedocumentation.php on line 1

Warning: session_start() [function.session-start]: Cannot send session cookie - headers already sent by (output started at /home/reg8rww/public_html/platform/pagedocumentation.php:1) in /home/reg8rww/public_html/platform/pagedocumentation.php on line 1

Warning: session_start() [function.session-start]: Cannot send session cache limiter - headers already sent (output started at /home/reg8rww/public_html/platform/pagedocumentation.php:1) in /home/reg8rww/public_html/platform/pagedocumentation.php on line 1
Regator Semantic API Documentation
LIVE DEMO LEARN MORE DOCUMENTATION ABOUT US

Documentation


View Developer Demo

Overview


Introduction

The Regator API is a RESTful web service. As such, functions are called via URIs, return either JSON or XML data (JSON being the default), and HTTP status codes are used to indicate the success or failure of a request. At the time of this writing, all API calls are accessed using the GET HTTP method, and parameters should be UTF-8 and URL encoded.


The Regator API also supports compressed responses using gzip, and it is highly recommended that you use this feature to save yourself, your users, and our servers bandwidth. To enable this feature, simply send an HTTP header with the value 'Accept-Encoding: gzip' as part of your request, and the data will be returned gzipped with a 'Content-Encoding: gzip' response header.


If in doubt about how a function may work, check out the developer demo. It's an easy to use interface to experiment with all the parameters for every API function with real-time results.

Versioning

The Regator API is committed to a sensible versioning scheme that values backward compatibility. Fields may be added to objects, optional parameters may be added to functions, additional options may be added to existing parameters, and new functions may be added without creating a new version of the API. Only in the event of changes that would break backwards compatibility will a new version number be released, and ideally this will happen rarely and with some prior notice.

text vs. searchTerm

There are several functions that take either a text or searchTerm parameter, and it's important to understand the difference in the two input formats. A searchTerm has a maximum length of 200 characters and allows quotation marks to indicate an exact phrase. Text has a maximum length of 4000 characters and does not consider quotation marks.

errors and omissions

If you find something that doesn't behave as described in this documentation or that you otherwise think is a bug, please let us know. Resolving API bugs is always a top priority for us. If in doubt, implement based on this documentation rather than unexpected behavior that conflicts with the documentation.

Common Parameters



There are some parameters that are common to all Regator API function calls.

apiKey

All API functions require an apiKey parameter that identifies you so we can verify and track your access to the API. You can track your API usage on your account management console. To obtain an apiKey, sign up for an account and we'll review your application shortly.

format

By default, all Regator API calls return data as JSON. In addition, the Regator API supports XML and JSONP. Passing a value of xml as the format parameter will return XML formatted data. Using JSONP requires not only using a value of jsonp for the format parameter, but also an additional callback parameter indicating the name of the javascript function to call in the returned script.

Common Attributes


matchConfidence

For functions that return related content, the matchConfidence attribute indicates the level of certainty of the returned objects. The matchConfidence is expressed as a float between 0 and 1. The best match will always have a matchConfidence of 1 with other matches relative to that.

Error Handling


Status Codes

All calls to the Regator API will return a HTTP status code indicating whether the call was a success or failure, and in the event of a failure, the status code will indicate the nature of the failure.

  • STATUS CODE MEANING

  • 200 OK : The request was successful, and a valid response of the type requested was returned, though the returned array may be empty.
  • 400 Bad Request : The request was malformed. An error message will be returned in the data format you've requested (either JSON or XML) indicating the nature of the error.
  • 401 Unauthorized : The request was sent with an invalid or missing apiKey.
  • 403 Forbidden : The apiKey used has exceeded the number of allowed calls.
  • 414 Request-URI Too Large : You've attempted to pass too much data in the URI.
  • 500 Internal Server Error or 503 Service Unavailable : Something has gone awry with the the Regator API servers. If this persists, contact us and we'll look into it immediately.

Object Types


topic

Topic objects serve as containers for sets of blogs and posts. They have no options for the attributes returned. Top-level topics have a parentid of 0 and a parentname of root.

  • ATTRIBUTES

  • topicID : INTEGER - The topicID is a unique identifier for each topic, which also serves as an indicator for which level of the hierarchy the topic is in. Top-level topics have a topicID greater than 10000000. Mid-level topics have a topicID between 100000 and 1000000, and low-level topics have a topicID less than 100000.
  • name : STRING - The name is simply a name for the topic describing the blogs and posts within it.
  • blogCount : INTEGER - The number of blogs in the topic. This number is not updated in real-time, but is instead updated once nightly.
  • postCount : INTEGER - The number of posts in the topic. This number is not updated in real-time, but is instead updated once nightly.
  • parentID : INTEGER - This is the topicID of the topics parent in the topic hierarchy, if one exists. If the topic is a top-level topic, the parentID will be 0.
  • parentName : STRING - The parentName is the name attribute of the topic's parent topic. The parentName of top-level topics is root.

blog

Blog objects serve as containers for sets of posts. Any call that returns a blog object can also take an optional integer parameter called blogAttributes, indicating which attributes to return for each blog object. The blogAttributes parameter functions as a bitfield with the bits to use for each attribute indicated below.

  • DEFAULT ATTRIBUTES

  • 0 blogID : INTEGER - The blogID is a unique identifier for each blog.
  • 1 topicID : INTEGER - The topicID indicates which topic contains this blog.
  • 2 title : STRING - This is the title of the blog.
  • 3 link : STRING - The link is the URL of the blog's home page.
  • OPTIONAL ATTRIBUTES

  • 4 timeLastNew : TIMESTAMP - The timeLastNew is an ISO 8601 timestamp indicating the time of the blog's last new post in the Regator database.
  • 5 timeAdded : TIMESTAMP - The timeAdded is an ISO 8601 timestamp indicating the time the blog was added to the Regator database.
  • 6 postCount : INTEGER - This is the number of posts in the Regator database from this blog. This count is updated once nightly, so it should not be depended on to be accurate in real-time.
  • 7 rssLink : STRING - The rssLink is the URL of the blog's RSS feed.
blogAttributes Picker blogAttributes value :


post

Post objects represent individual blog posts. Any call that returns a post object can also take an optional integer parameter called postAttributes, indicating which attributes to return for each post object. The postAttributes parameter functions as a bitfield with the bits to use for each attribute indicated below.

  • DEFAULT ATTRIBUTES

  • 0 postID : INTEGER - The postID is a unique identifier for each post.
  • 1 blogID : INTEGER - The blogID indicates which blog contains this post.
  • 2 topicID : INTEGER - The topicID indicates which topic contains this post.
  • 3 title : STRING - This is the title of the post.
  • 4 link : STRING - The link is the URL of the post.
  • 5 summary : STRING - The summary is either a summary of a post's content if provided by the blog, or the first portion of a full post if no summary was provided. It is important to note that the vast majority of blog posts in the Regator archive have summaries, but not all. In the event that a post has no summary, the summary field will be an empty string. The summary returned is at most 500 characters long, but some posts may have a longer summary (up to 928 characters). (For the longer format summary containing all the text Regator has for that post, include the longsummary flag in the postattributes bitfield parameter, which overrides summary if both are set in postattributes.) The summary attribute, however, uses an algorithm to return a summary shortened to between 300-500 characters at a natural break in the text. New paragraphs are the preferred place where summaries will end. If no paragraph breaks are found within the 300-500 character limit, sentence ends or spaces are used, but words will not be broken.
  • 6 timeAdded : TIMESTAMP - The timeAdded is an ISO 8601 timestamp indicating when the post was added to the Regator archive.
  • OPTIONAL ATTRIBUTES

  • 7 audio : OBJECT ARRAY - This is an array of audio objects that the post links to.
  • 8 video : OBJECT ARRAY - This is an array of video objects that the post links to.
  • 9 longSummary : STRING - The longSummary is the same as summary, only with a maximum length of 928 characters rather than 500. The maximum length of content that Regator aggregates is 928 characters, which may cause words or sentences to be broken.
  • 10 blogTitle : STRING - The blogTitle is the title attribute of the blog object that is the parent of this post. This option is available here as a convenience so that a second call to look up the blog title isn't necessary when displaying a list of posts.
  • 11 topicName : STRING - The topicName is the name attribute of the topic object that is the parent of this post. This option is available here as a convenience so that a second call to look up the topic name isn't necessary when displaying a list of posts.
postAttributes Picker postAttributes value :


term

Term objects are phrases up to five words long.

  • ATTRIBUTES

  • term : STRING - The term is simply phrase returned.

audio

Audio objects are references to MP3 files linked to in a post and are currently only available as sub-objects to post objects. Not all attributes are available for all audio files, depending on the MP3's ID3 tag, but the link attribute is always available.

  • ATTRIBUTES

  • link : STRING - Link is the URL of the audio file. It is important to note that audio files are not stored on the Regator servers and may have been removed by the source.
  • artist : STRING - This is the artist field retrieved from the ID3 tag.
  • title : STRING - This is the title field retrieved from the ID3 tag.
  • genre : STRING - This is the genre field retrieved from the ID3 tag.
  • album : STRING - This is the album field retrieved from the ID3 tag.
  • bitRate : STRING - This is the bitrate field retrieved from the ID3 tag.
  • year : STRING - This is the year field retrieved from the ID3 tag.

video

Video objects are references to videos linked to in a post and are currently only available as sub-objects to post objects. Title and description may not be available for all videos.

  • ATTRIBUTES

  • link : STRING - The link is a URL to the page where the video can be watched.
  • site : STRING - This is the site the video is hosted on. Site will be one of the following: youtube, video.google, vimeo, liveleak, dailymotion, veoh, or metacafe.
  • siteID : STRING - The siteID is the unique identifier that the hosting site uses to identify the specific video. This can be used, along with embed code from each site, to embed the video elsewhere.
  • title : STRING - The title is retrieved from the hosting site, though it may not be available for all videos.
  • description : STRING - The description is retrieved from the hosting site, though it may not be available for all videos.

searchData

This is information about a search for a searchTerm over a time period. This object type is only returned from the searchdata/search function.

  • DEFAULT ATTRIBUTES

  • resultsInfo : OBJECT - This is a resultinfo object that contains summary information about a search.
  • searchIntervals : OBJECT ARRAY - This is an array of searchInterval objects.
  • OPTIONAL ATTRIBUTES

  • blogs : OBJECT ARRAY - This is an array of blogs in which there are search results during the requested time period. It contains at most 20 blogs, each of which has an additional count attribute indicating how many results were in that blog during the requested time period.
  • topics : OBJECT ARRAY - This is an array of topics in which there are search results during the requested time period. It contains at most 20 topics, each of which has an additional count attribute indicating how many results were in that topic during the requested time period.

resultInfo

This is an object that contains general information about a searchData object. It currently only appears as a sub-object to searchData objects.

  • ATTRIBUTES

  • total : INTEGER - This indicates the total number of results in the search.
  • max : INTEGER - This is the maximum number of results in one searchinterval.
  • min : INTEGER - This is the minimum number of results in one searchinterval.
  • avg : FLOAT - This is the average number of results per interval over the entire search period.
  • stdDeviation : FLOAT - This the standard deviation of the results per interval.

searchInterval

This object contains information about a search for a specific time period. It is currently only used as a sub-object to searchData objects.

  • ATTRIBUTES

  • intervalIndex : INTEGER - This index indicates which of the requested time intervals this data is for, starting with 0 for the first interval.
  • count : INTEGER - This is the number of results during the time interval.
  • startTime : TIMESTAMP - The startTime is an ISO 8601 timestamp indicating when this time interval begins.

Term Functions


terms/relatedToText

This function takes a block of text and returns a set of terms related to that text.

  • REQUIRED PARAMETERS

  • text : STRING - This is the block of text used to generate related terms. This can be at most 4000 characters long. For best results, include a title-case title if searching for terms related to a blog post or article.
  • OPTIONAL PARAMETERS

  • filterInText : BOOLEAN (default false) - The default value is false, which may return related terms not contained in the source text. Setting this parameter to true limits the returned terms to terms that appear in the source text.
  • timeStart : TIMESTAMP - Time intervals require two parameters, timeStart and timeEnd. The timeStart value is the beginning of the time interval to use in ISO 8601 format.
  • timeEnd : TIMESTAMP - Time intervals require two parameters, timeStart and timeEnd. The timeEnd value is the end of the time interval to use in ISO 8601 format.

Examples: example 1, example 2, example 3



terms/relatedToSearchterm

This function returns terms that are related to a searchTerm. This function's results are based on a time interval. By default, this interval is the most recent two weeks, so that related terms are timely. However, with the optional time timeStart and timeEnd parameters, you can get terms related to a searchterm during a specific period. The algorithm will use, at most, the 100 most recent posts within that interval to generate related terms, so for terms referenced in a large number of posts, a wide time interval may not give significantly different results from a smaller interval. Experiment to find the best results for your particular application.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • OPTIONAL PARAMETERS

  • timeStart : TIMESTAMP - Time intervals require two parameters, timeStart and timeEnd. The timeStart value is the beginning of the time interval to use in ISO 8601 format.
  • timeEnd : TIMESTAMP - Time intervals require two parameters, timeStart and timeEnd. The timeEnd value is the end of the time interval to use in ISO 8601 format.

Examples: example 1, example 2



terms/relatedToPost

This function returns terms related to a specific post, if any related terms exist.

  • REQUIRED PARAMETERS

  • postID : INTEGER - This is the postID for which to find related terms.

Examples: example 1



terms/topicTrends

This function returns an ordered list of terms that are a real-time representation of what the bloggers in a particular topic are writing about. If no topicID or a topicID of 0 is specified, the trends list for all blogs will be returned.


In addition, some terms may be tied to other terms in a parent/child relationship, in which case the child term will have a parentTerm attribute indicating its parent. Parent/child relationships are currently only calculated for top-level topic and all-blogs trends lists.


Each term will also contain a positionChange attribute, indicating whether a term is moving up or down the trends list, and if so, how many places it moved during the last update. This can be used to determine whether a term is becoming more or less relevant in relation to other currently trending terms. Values may be positive or negative integers, with positive integers indicating the term has moved up the list (more important) and negative integers indicating the term has moved down the list (less important). A value of 0 indicates the term has stayed in the same position.

  • OPTIONAL PARAMETERS

  • topicID : INTEGER - This is the topicID for which to retrieve trends.

Examples: example 1, example 2, example 3



Topic Functions


topics/relatedToText

This function takes a block of text and returns the most closely related topics. Topics returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • text : STRING - This is the block of text used to generate related topics. This can be at most 4000 characters long. For best results, include the title if searching for topics related to a blog post or article.

Examples: example 1, example 2



topics/relatedToSearchterm

This function takes a searchTerm and returns the topics that are most related to that searchTerm. Topics returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the term used to find related topics. The searchTerm can be at most 200 characters long.

Examples: example 1, example 2



topics/all

This function returns the entire Regator topic structure. Top-level topics will have a parentID of 0, which is the root of the tree. The names and/or location of topics may change from time to time (generally no more than a few times a month), so this data should not be permanantly cached.

  • THIS FUNCTION TAKES NO PARAMETERS

Examples: example 1



topics/children

This function takes a topicID and returns the topics that are the immediate children of that topic. This function can take a topicID of 0 to retrieve the top-level topics.

  • REQUIRED PARAMETERS

  • topicID : INTEGER - This is the topicid for which to retrieve subtopics.

Examples: example 1, example 2



topics/parent

This function takes a topicID and returns the topicID of the topic's parent. Top-level topics (those with topicIDs greater than 10000000) will return the root node, which has boolean false as the parentID and parentName attributes.

  • REQUIRED PARAMETERS

  • topicID : INTEGER - This is the topicID for which to retrieve the parent.

Examples: example 1



topics/search

This function takes a searchTerm and returns topics whose name attribute matches or begins with the searchTerm.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • OPTIONAL PARAMETERS

  • matchMode : STRING (default 'prefix') - This determines the circumstances under which a topic is considered a match to the searchTerm. There are three possible values: prefix, exact, or any. The default setting is prefix, which returns matches that have words with the searchterm as a prefix. A value of exact returns only topics whose name attributes are an exact match to the searchTerm. A value of any will return topics whose name attributes contain the searchTerm in any part of their names. All matching modes are case insensitive.

Examples: example 1, example 2, example 3



Blog Functions


blogs/relatedToText

This function takes a block of text and returns the most closely related blogs to that text. Blogs returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • text : STRING - This is the block of text used to generate related blogs. This can be at most 4000 characters long. For best results, include the title if searching for topics related to a blog post or article.
  • blogAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1, example 2



blogs/relatedToSearchterm

This function takes a searchTerm and returns the blogs that are most related to that searchTerm. Blogs returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • OPTIONAL PARAMETERS

  • pageLength : INTEGER (default 10) - Indicates the maximum number of results to return. The possible options are: 5, 10, 20, or 40.
  • blogAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1



blogs/info

This function uses a blogid to return a single blog object.

  • REQUIRED PARAMETERS

  • blogID : INTEGER - This is the blogID of the blog to fetch.
  • OPTIONAL PARAMETERS

  • blogAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1



blogs/inTopic

This function returns blogs from a topic.

  • REQUIRED PARAMETERS

  • topicID : INTEGER - This is the topicID for which to retrieve blogs.
  • OPTIONAL PARAMETERS

  • pageLength : INTEGER (default 10) - This indicates the maximum number of results to return. The possible options are: 5, 10, 20, or 40.
  • offset : INTEGER (default 0) - The offset indicates how many blogs to skip in the result set before returning blogs. The offset must be a multiple of pageLength and less than 1000.
  • sortMode : STRING (default 'alphabetical') - This determines what attributes are used to sort the returned blogs. There are five possible values: alphabetical, popularity, timeLastNew, timeAdded, or postCount. The default value is alphabetical. The value popularity sorts by a combination of several metrics based on how Regator's userbase interacts with blogs. The values timeLastNew, timeAdded, and postCount sort based on the corresponding blog object attributes.
  • sortDir : STRING (default 'asc') - This parameter determines how results are sorted. The default value is asc, which sorts in ascending order. The other option is desc, which sorts in descending order.
  • blogAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1, example 2



blogs/search

This function returns blogs matching a searchTerm.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • OPTIONAL PARAMETERS

  • pageLength : INTEGER (default 10) - This indicates the maximum number of results to return. The possible options are: 5, 10, 20, or 40.
  • offset : INTEGER (default 0) - The offset indicates how many blogs to skip in the result set before returning blogs. The offset must be a multiple of pageLength and less than 1000.
  • matchMode : STRING (default 'prefix') - This determines the circumstances under which a blog is considered a match to the searchTerm. There are three possible values: prefix, exact, or any. The default value is prefix, which returns matches that have words with the searchTerm as a prefix. A value of exact returns only blogs whose name attributes are an exact match to the searchTerm. A value of any will return blogs whose name attributes contain the searchTerm in any part of their names. All matching modes are case insensitive.
  • sortMode : STRING (default 'alphabetical') - This determines what attributes are used to sort the returned blogs. There are five possible values: alphabetical, popularity, timeLastNew, timeAdded, or postCount. The default value is alphabetical. The value popularity sorts by a combination of several metrics based on how Regator's userbase interacts with blogs. The values timeLastNew, timeAdded, and postCount sort based on the corresponding blog object attributes.
  • sortDir : STRING (default 'asc') - This parameter determines how results are sorted. The default value is asc, which sorts in ascending order. The other option is desc, which sorts in descending order.
  • blogAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1, example 2



Post Functions


posts/relatedToText

This function returns the ten most related posts to a block of text. Posts returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • text : STRING - This is the block of text used to generate related posts. This can be at most 4000 characters long. For best results, include the title if searching for posts related to a blog post or article.
  • OPTIONAL PARAMETERS

  • timeStart : TIMESTAMP - Time filters require two parameters, timeStart and timeEnd. The timeStart value is the earliest time to fetch posts from in ISO 8601 format.
  • timeEnd : TIMESTAMP - Time filters require two parameters, timeStart and timeEnd. The timeEnd value is the latest time to fetch posts from in ISO 8601 format.
  • postAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1



posts/relatedToSearchterm

This function returns posts most related to a searchTerm during a specific time period. If no time period is specified, the most recent posts are used to determine relevance. Posts returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • OPTIONAL PARAMETERS

  • timeStart : TIMESTAMP - Time filters require two parameters, timeStart and timeEnd. The timeStart value is the earliest time to fetch posts from in ISO 8601 format.
  • timeEnd : TIMESTAMP - Time filters require two parameters, timeStart and timeEnd. The timeEnd value is the latest time to fetch posts from in ISO 8601 format.
  • postAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1, example 2, example 3



posts/relatedToPost

This function returns the ten most related posts to another post in the Regator database. Posts returned include a matchConfidence attribute.

  • REQUIRED PARAMETERS

  • postID : INTEGER - This is the postID for which to find related posts.
  • OPTIONAL PARAMETERS

  • postAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1



posts/inTopic

This function retrieves posts from a specific topic. By default it fetches the most recent posts, but postType allows you to retrieve the most popular posts in real-time based on Regator's popularity algorithm.

  • REQUIRED PARAMETERS

  • topicID : INTEGER - This is the topicID for which to retrieve posts.
  • OPTIONAL PARAMETERS

  • postType : STRING (default 'new') - The default value of new returns the most recent posts in a topic. The other option for postType is popular, which returns the most popular posts in a topic based on Regator's popularity algorithm.
  • pageLength : INTEGER (default 10) - This indicates the maximum number of results to return. The possible options are: 5, 10, 20, or 40.
  • offset : INTEGER (default 0) - The offset indicates how many posts to skip in the result set before returning posts. The offset must be a multiple of pageLength and less than 1000.
  • postAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1, example 2



posts/inBlog

This function returns posts from a blog's archive.

  • REQUIRED PARAMETERS

  • blogID : INTEGER - This is the blogID for which to retrieve posts.
  • OPTIONAL PARAMETERS

  • pageLength : INTEGER (default 10) - This indicates the maximum number of results to return. The possible options are: 5, 10, 20, or 40.
  • offset : INTEGER (default 0) - The offset indicates how many posts to skip in the result set before returning posts. The offset must be a multiple of pageLength and less than 1000.
  • postAttributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1



posts/search

This is the generic, flexible function to retrieve sets of posts based on a searchTerm. By default it takes a searchTerm and returns a set of posts, but with the optional filter parameters it can be used to fetch specific sets of posts based on topic, blog, or time.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • OPTIONAL PARAMETERS

  • filterTopicID : INTEGER - This is a topicID to filter the posts by. Only posts in that topic will be returned.
  • filterBlogID : INTEGER - This is a blogID to filter the posts by. Only posts in that blog will be returned.
  • filterTimeStart : TIMESTAMP - Time filters require two parameters, filterTimeStart and filterTimeEnd. The filterTimeStart value is the earliest time to fetch posts from in ISO 8601 format.
  • filterTimeEnd : TIMESTAMP - Time filters require two parameters, filtertimestart and filterTimeEnd. The filterTimeEnd value is the latest time to fetch posts from in ISO 8601 format.
  • pageLength : INTEGER (default 10) - This indicates the maximum number of results to return. The possible options are: 5, 10, 20, or 40.
  • offset : INTEGER (default 0) - The offset indicates how many posts to skip in the result set before returning posts. The offset must be a multiple of pageLength and less than 1000.
  • postattributes : INTEGER - This is an integer parsed as a bitfield used to determine which attributes to return.

Examples: example 1, example 2, example 3, example 4



SearchData Functions


searchdata/search

This function returns a searchdata object for a searchTerm for a given time period.

  • REQUIRED PARAMETERS

  • searchTerm : STRING - This is the text to search for. The searchTerm can be at most 200 characters long.
  • startTime : TIMESTAMP - The startTime value indicates the beginning of the time interval to use, in ISO 8601 format.
  • intervalType : STRING - The intervalType must be one of the following: hour, day, week, or month. This indicates how much time each time interval encompasses.
  • intervalCount : INTEGER - This is the number of time intervals for which to return data. The maximum value of intervalCount varies per interval type as follows: hour: 336, day: 365, week: 52, month: 12.
  • OPTIONAL PARAMETERS

  • verbose : BOOLEAN (default false) - For the default value of false, intervals that contain no results are excluded from the results. A value of true for verbose forces all intervals requested to be returned even if the result count is 0.
  • includeBlogData : BOOLEAN (default false) - For the default value of false, no blog data is returned as part of the searchdata object. A value of true for includeblogdata will include the 20 blogs for which there are the most results during the entire time period requested. Each blog will contain a count attribute indicating how many results there were from that blog.
  • includeTopicData : BOOLEAN (default false) - For the default value of false, no topic data is returned as part of the searchdata object. A value of true for includetopicdata will include the 20 topics for which there are the most results during the entire time period requested. Each topic will contain a count attribute indicating how many results there were from that topic.

Examples: example 1, example 2





Contact
PHONE:+1-404-939-7181
TWITTER:@REGATOR
FACEBOOK:/Regator

Warning: Unknown: open(/home/reg8rww/sessions/7/3/sess_735f7b1bbed8a0b5d48c602e0bfec8e9, O_RDWR) failed: No space left on device (28) in Unknown on line 0

Warning: Unknown: Failed to write session data (files). Please verify that the current setting of session.save_path is correct (2;/home/reg8rww/sessions) in Unknown on line 0