It is with great pleasure that we’d like to announce the first (beta) release of the SiteCondor’s API Ruby client.
SiteCondor’s API enables digital agencies to integrate powerful on-page extraction and analysis functionality into their own custom workflows and processes. In-house marketing teams and third-party developers can use the SiteCondor API to enrich their products by adding accurate on-page element information and metrics, content analysis functionality, and more.
This thin wrapper makes it extremely easy for Ruby programmers to interact with various endpoints of our RESTful API. Also included within the github repository are multiple examples showcasing the currently available functionality. Also included are a few advanced examples that perform additional content analysis and data crunching on the client side.
While the client doesn’t yet fully support all of the API features, it does implement most of the job-related GET operations. Let’s look at an example.
Given an API key and a Job ID, the example above first gets a job result, and then gets all the H1 Heading results for that same job. API results are JSON-encoded so they are very easy to digest. The ruby client results are all encoded as Ruby Hash objects.
The job result includes fields that reflect the options selected at the time of job creation and fields that summarize job crawl results. Here’s an example:
SiteCondor aggregates H1 headings by unique values, counting the number of occurrences for each of them, and including the array of URLs where the heading was found. In addition, results are also reverse ordered by frequency (count) so that the most used unique titles are returned first. While the Get H1s API endpoint is actually paginated, the client takes care of this for you so you don’t have to iterate through the result pages.
Here is an example of how the Headings results look like:
For more info on the available functionality, please check out the examples included in the Github repo. If you’d like to gain access to our API, please consider signing up for SiteCondor, or let us know and we may just hook you up with an API trial account.
We plan on creating API clients for other languages, let us know what you’d like to see and we may just release a wrapper for it. 🙂
In case you were wondering, the code is open source and released under the MIT license.