Netbase Connector
Intro
The NetBase Insight API enables you to search the ConsumerBase index, which contains billions of insight-rich sound bites (sentences), based on the focus of your analysis. Retrieve data to use as input for visualizations in your websites and applications. The Insight API returns metric values, sentiment classifications, emotions, behaviors, and attributes for objects, named entities, and more. You can use the Insight API to integrate social media data and metrics in your web sites and applications. To learn more about the Netbase API, visit their page (http://learn.netbase.com/i/706080-ne...ming-interface).
You connect to your Netbase account in the Data Center. This topic discusses the fields and menus that are specific to the Netbase connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.
Primary Use Cases |
|
Primary Metrics |
|
Primary Company Roles |
|
Average Implementation Time |
1 hour |
Ease of Use (on a 1-to-10 scale with 1 being easiest) |
4 (user should have some knowledge of Netbase) |
Best Practices
Be aware that time zones using this connector are determined by UTC.
Prerequisites
To connect to your Netbase account and create a DataSet, you must a Netbase username and password.
Connecting to Your Netbase Account
This section enumerates the options in the Credentials and Details panes in the Netbase Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.
Credentials Pane
This pane contains fields for entering credentials to connect to your Netbase account. The following table describes what is needed for each field:
Field |
Description |
---|---|
Username | Enter the username for your Netbase account. |
Password | Enter the password for your Netbase account. |
Once you have entered valid Netbase credentials, you can use the same account any time you go to create a new Netbase DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.
Details Pane
This pane contains a primary Reports menu, along with a number of other menus for filtering the report data.
Menu |
Description |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report |
Select the Netbase report you want to run. The following reports are available:
|
||||||||||||
Topic Scope | Select the category of topics you want to be able to pull data for. | ||||||||||||
Theme Scope | Select the category of themes you want to be able to pull data for. | ||||||||||||
Topics | Select the topic you want to pull data for. | ||||||||||||
Theme Filters | Select the themes you want to pull data for (up to 50). | ||||||||||||
Time Period |
Enter the time period for the data you want to return. This should be in the format {time period},{time offset},{time rounding}. The following table lists different examples of how to set this parameter:
|
||||||||||||
Time Units | Select the time unit that the data in the report should be broken down by. For example, if you select Month, twelve rows of data appear, one for each month in the year. | ||||||||||||
Metric Series | Select the metric series you want to filter by. You can select as many metric IDs as you want. | ||||||||||||
Optional Parameters |
Select the optional parameters you want to filter by. You can select as many optional parameters as you want. For in-depth documentation on optional parameters, see https://api.netbase.com/explorer/api/netbase. |
||||||||||||
Theme Array | Select up to 50 theme arrays. A theme array is a theme you can use to further drill down into your data set. You must define themes in a NetBase application before you can use them in Domo. | ||||||||||||
Size Needed | Specifies the number of documents or insights to be returned. The maximum number of documents that may be returned is 2000, and the maximum number of insights is 1000. Only numeric values are valid. | ||||||||||||
Peer Count | Specifies the number of sentences to return before and after a matching sentence. The default is 2. | ||||||||||||
Sort |
Sorts sound bites in your report. To sort in ascending order: sort=sort_option. To sort in descending order: sort=-sort_option Here, sort_option is one of the following:
|
||||||||||||
Categories | Select the categories you want to filter by. You can select as many categories as you want. | ||||||||||||
Measure |
Select the measure parameter for the report.
|
Other Panes
For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.
Troubleshooting
If the connection fails, check the error message. It may contain information concerning an illegal configuration that NetBase does not allow. For example, when running the Insight Count report, if you select Followers for your Measure, selecting any category but Authors will return an error.