Omgili

Omgili Developers API (Beta)

Introduction

The Omgili API allows you to develop applications that leverage the unique data we collect from millions of discussions across the web. All requests to the Omgili API are HTTP GET requests. The API is available for non-commercial use and each user is limited to 1000 requests per day. The API is provided free of charge, but its use is subject to our Terms of Use. Please contact us if you would like that limit extended or if you would like to request any additional functionality.

Commercial Use

If you would like to use the API in a commercial application please contact us and provide as much detail as you can about your proposed application and how you would like our business relationship to work. We will review your proposal and get back to you as soon as possible.

Data Format

All requests to the Omgili API are HTTP GET requests. The response is always in XML format.

Questions & Bugs

Omgili API is in Beta. If you found a bug or have any question, please don't hesitate to contact us and will try to answer your query as soon as possible.

Terms of Service

By using our API on your service, you must provide a link to the Omgili Service and to the Omgili results page of the service you are using. Please provide a "Powered by Omgili" text or logo (http://omgili.com/images/slogo.png )

Requests

To access the XML for each service use the following URL formats:
  • Omgili Discussion Search: http://omgili.com/api.search?q=[QUERY]&type=0
    Example: http://omgili.com/api.search?q=best+laptop&type=0

    Special Features

    • Showing only Q&A: If you want to search only for questions and answers, add "is_question:1" to the search query
    • Showing discussions from the past x days: If you want to limit the time frame of the discussions, add "max_days_back:[days back]" to the search query. For example, adding max_days_back:30 will search for disucssions that took place in the past 30 days.
    • Advanced Search Flags: You can use any of the flags described in the advanced search or special features documentation.
  • Omgili Review Search: http://omgili.com/api.search?q=[QUERY]&type=1
    Example: http://omgili.com/api.search?q=iPod&type=1

Pagination

Each request will return 10 results. To access the next pages use the "p" parameter values 1 to 10.
Example: http://omgili.com/api.search?q=best+laptop&type=0&p=2

XML Response

Discussion Search Response :
  • <ResultsInfo/> - Container for general information about the results set.
    • <Query/> - The search query the user entered
    • <Link/> - The link to the Omgili results page. This link must be displayed as a Hyperlink on the application's result page
    • <CurPage/> - The current page: 1-10
    • <TotalResults/> - The total number of discussions matching the query
  • <Results/> - Container around the discussion results items
    • <Title/> - The title of the discussion
    • <Link/> - The link to the discussion
    • <DiscussionSource/> - The domain name of the discussion source
    • <Snippet/> - Relevant text from the discussion. The query is highlighted
    • <DiscussionDate/> - The date where most of the discussion's posts were made. The format is [Day Month Year]
    • <NumOfReplies/> - The number of replies at the time of crawl (this number does not include the topic post). The total number of posts in a discussion is the number of replies + 1 (the topic)

Review Search Response:
  • <ResultsInfo/> - Container for general information about the results set.
    • <query/> - The search query the user entered
    • <Link/> - The link to the Omgili reviews results page. This link must be displayed as a Hyperlink on the application's result page
    • <CurPage/> - The current page: 1-10
    • <TotalResults/> - The total number of prodcuts matching the query
  • <Results/> - Container around the product items
    • <ProductName/> - The name of the product matching the query.
    • <Link/> - The link to the reviews page on Omgili Reviews.
    • <ImageLink/> - The link to the product's image.
    • <TotalGrades/> - The total number of reviews for this product
    • <AverageRating/> - The average rating or score for this product
    • <MiserableReviews/> - The total number of Miserable (Grade = 1) reviews for this product
    • <BadReviews/> - The total number of Bad (Grade = 2) reviews for this product
    • <ModerateReviews/> - The total number of Moderate (Grade = 3) reviews for this product
    • <GoodReviews/> - The total number of Good (Grade = 4) reviews for this product
    • <ExcellentReviews/> - The total number of Excellent (Grade = 5) reviews for this product