Data Segmentation API

Data Segmentation

The segmentation feature is a powerful API that provides instant insight into a dataset. Using this feature, you can find the top 100 sites, languages, authors, entities around a topic or a dataset, produced by a query.

It’s a powerful tool to get a 360° view of the dataset you’ve created. For example, you can segment the top forums for your query. For each forum, you can find the top authors, and for each author, the top users who comment on their posts. Another example is listing the top journalists who write about certain topics, or the top people or locations mentioned in a text.

URL Structure:
https://api.webz.io/nbdSeg?token=XXXXXXXX&q=[QUERY]&field=[SEGMENT]

HTTP GET Parameters

Parameter

Description

Example

q

A Boolean query containing the filters that define which posts will be returned.

News articles about Bitcoin

thread.title:bitcoin site_type:news

token

Your private access token that you received when you signed up.

field

The field by which to segment the data. The following are the available segments:

  • thread.site
  • thread.site_suffix
  • thread.site_full
  • thread.site_section
  • thread.site_type
  • thread.country
  • author
  • published
  • language
  • site_category
  • rating
  • locations
  • persons
  • person.positive
  • person.negative
  • person.neutral
  • organizations
  • organization.positive
  • organization.negative
  • organization.neutral

Segment by top sites

&field=thread.site

ts

The ts (timestamp) parameter returns results that were crawled after this timestamp (ts is a Unix timestamp in milliseconds).
Here is a Timestamp/Date converter
When not specified the default is the past 3 days.

&ts=1459835503426