Output Reference

The output includes 4 sections. The "Meta Info" provides information concerning API consumption and the request itself. The "Thread Object" provides information about the complete thread (e.g. full article text and associated comments). The "Post Object" includes information about a particular post in a thread. A post could be the article, i.e the first post, or a comment to the article. The "External Images Object" includes information about the images found on a page, including visual image analysis and meta data extraction about each image found.

Meta Info

Field Name
Description
Type

totalResults

The total number of posts matching your query

Integer

moreResultsAvailable

How many more results are available

Integer

next

A URL to get the next batch of posts matching your query.

String

requestsLeft

How many more requests are available in your current subscription plan.

Integer

Thread Object

Field Name
Description
Searchable?
Type

uuid

A unique ID representing the thread

False

String

url

The link to the top of the thread (goes through omgili.com on the free plan)

True

String

site_full

The complete domain of the site

True

String

site

The top level domain of the site

True

String

site_section

A link to the section in the site where the thread was created

True

String

section_title

The title of the section in the site where the thread was created

True

String

title

The title of the thread

True

String

title_full

The full title of the thread including prefix or suffix automatically added by the site (like the site name)

True

String

published

The date/time when the thread was published.

True

replies_count

How many replies are there to the main post

True

Integer

participants_count

How many different people participated in the discussion

True

Integer

site_type

Is the site a blog/new/forum

True

String

main_image

A link to the main image presented with the article

False

String

country

The country of the site, determined automatically by the site language, IP and TLD

True

String

site_category

A list of categories for this website

True

String

social

A list of of social networks and the number of shares/likes/comments for this article

True

String

performance_score

A virality score for news and blogs posts only. The score ranges between 0-10, where 0 means that the post didn't do well at all, i.e rarely or was never shared, to 10 which means that the post was on fire, shared thousands of times on Facebook.

True

Integer

spam_score

A score value between 0 to 1, indicating how spammy the thread text is.

True

Float

domain_rank

A rank that specifies how popular a domain is (by monthly traffic)

True

Integer

Post Object

Field Name
Description
Searchable?
Type

uuid

A unique ID representing a post in a thread

No

String

url

A link to the post in the thread (goes through omgili.com on the free plan)

Yes

String

ord_in_thread

The order in the thread, i.e if its the first post, the second etc..

Yes

Integer

author

The author name of the post

Yes

String

published

The date/time when the post was published.

Yes

title

The title of the post

Yes

String

text

The text body of the post

Yes

String

language

The language of the post

Yes

String

external_links

A list of URLs that are linked from the post

Yes

String

rating

For review posts, the rating parameter provides the star rating for the review, a floating number between 0.0 to 5.0.

Yes

Float

entities/sentiment

  • persons - a list of identified people names found in the post (currently available for news/blogs posts in English)

  • locations - a list of identified locations found in the post (currently available for news/blogs posts in English)

  • organizations - a list of identified companies/organizations found in the post (currently available for news/blogs posts in English)


Sentiment
Sentiment context attached to either a person or organization. Possible values are: positive, negative, none.

Yes

String

crawled

The date/time when the post was crawled.

Yes

External Images Object

Field Name
Description
Searchable?
Type

url

The link to the actual image

no

String

meta_info

Link to more information about the image

no

String

uuid

A unique ID for the image by its content. Multiple posts could link to the same image, even if its on different locations.

yes

String

label

A list of labels that describe the visual content of the image.

yes

Array[String]

{
  "posts": [
    {
      "thread": {
        "uuid": "fd1c035192a9bf567ed7ee642fa25765bd35ed20",
        "url": "https://forums.sherdog.com/threads/when-did-the-nytimes-hire-david-duke-as-an-editor.3951353/page-2",
        "site_full": "forums.sherdog.com",
        "site": "sherdog.com",
        "site_section": "https://forums.sherdog.com/forums/the-war-room.54/",
        "site_categories": [
          "illegal_content",
          "boxing",
          "sports"
        ],
        "section_title": "The War Room | Sherdog Forums | UFC, MMA & Boxing Discussion",
        "title": "Opinion - When did the @nytimes hire David Duke as an editor? 2",
        "title_full": "Opinion - When did the @nytimes hire David Duke as an editor? | Page 2 | Sherdog Forums | UFC, MMA & Boxing Discussion",
        "published": "2019-04-28T18:49:00.000+03:00",
        "replies_count": 11,
        "participants_count": 7,
        "site_type": "discussions",
        "country": "US",
        "spam_score": 0.0,
        "main_image": "https://cdn1-www-forums.sherdog.com/data/avatars/m/531/531839.jpg?1539103279",
        "performance_score": 0,
        "domain_rank": 5787,
        "social": {
          "facebook": {
            "likes": 0,
            "comments": 0,
            "shares": 0
          },
          "gplus": {
            "shares": 0
          },
          "pinterest": {
            "shares": 0
          },
          "linkedin": {
            "shares": 0
          },
          "stumbledupon": {
            "shares": 0
          },
          "vk": {
            "shares": 0
          }
        }
      },
      "uuid": "7699ce1c729ce1d681e915f5d8238620f075bf66",
      "url": "https://forums.sherdog.com/threads/when-did-the-nytimes-hire-david-duke-as-an-editor.3951353/page-2#post-7",
      "ord_in_thread": 7,
      "author": "SBJJ",
      "published": "2019-04-28T19:48:00.000+03:00",
      "title": "",
      "text": "It's because Trump disavowed David Duke so many times.",
      "highlightText": "It's because <em>Trump</em> disavowed David Duke so many times.... ",
      "highlightTitle": "",
      "language": "english",
      "external_links": [
        "http://time.com/5579188/new-york-times-apology-anti-semitic-cartoon/",
        "https://www.youtube.com/embed/PPTQaOVbR9k",
        "https://s9e.github.io",
        "http://www.time.com/5579188/new-york-times-apology-anti-semitic-cartoon/",
        "https://s9e.github.io/iframe/2/twitter.min.html#1122560256192782337",
        "https://www.s9e.github.io/iframe/2/twitter.min.html#1122560256192782337",
        "http://time.com/5579188/new-york-times-apology-anti-semitic-cartoon",
        "https://s9e.github.io/iframe/2/twitter.min.html#1122328967716003842"
  
      ],
      "external_images": [
        
        {
          "url": "https://cdn1-www-forums.sherdog.com/data/avatars/l/535/535063.jpg",
          "meta_info": "/images?token=xxxxxxxx&format=json&q=uuid:107863973373834162119171538058262530453",
          "uuid": "107863973373834162119171538058262530453",
          "label": [
            "Text",
            "Symbol",
            "Logo",
            "Trademark",
            "Label"
          ],
          "text": "  GREAT STAND YOUR GROUND. "
        }
      ],
      "entities": {
        "persons": [
          
        ],
        "organizations": [
          
        ],
        "locations": [
          
        ]
      },
      "rating": null,
      "crawled": "2019-04-29T00:29:57.022+03:00"
    }

Output Reference


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.