Skip to main content
waffle.svg
Domo Knowledge Base

Shareablee Connector

Version 3

 

Intro

Shareablee is an online platform that offers audience intelligence, competitive benchmarking, and insights for social media. Use Domo's Shareablee connector to retrieve data across social platforms and industry-standard metrics. To learn more about the Shareablee API, visit their page (http://api.shareablee.com/v1.4/docs/).

You connect to your Shareablee account in the Data Center. This topic discusses the fields and menus that are specific to the Shareablee 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.

Prerequisites

To connect to your Shareablee account and create a DataSet, you must have the following:

  • A Shareablee API key

  • A Shareablee API secret

To obtain these credentials, reach out to your Shareablee account representative.

Connecting to Your Shareablee Account

This section enumerates the options in the Credentials and Details panes in the Shareablee 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 Shareablee account. The following table describes what is needed for each field:  

Field

Description

API Key

Enter your Shareablee API key.

API Secret

Enter your Shareablee API secret.

Once you have entered valid Shareablee credentials, you can use the same account any time you go to create a new Shareablee 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 various other menus which may or may not appear depending on the report type you select.

Menu

Description

Report

Select the Shareablee report you want to run. The following reports are available:

Audience Affinity Comparison

Returns affinity data for the given entity vs. the given object for the selected date range. Earliest start date is 2015-12-01.

Audience Affinity Ranking

Returns property-level affinity data for the given object. Earliest start date is 2015-12-01.

Audience Overlap Comparison

Returns cross-engagement data for the given entity vs. the given object for each month and service in the time range.

Audience Overlap Ranking

Returns property-level cross-engagement data for the given entity.

Category Cross Platform Member Info

Returns service-specific information related to the members of a given category.

Category Cross Platform Member Rankings

Returns member ranking data for a given category across supported services.

Category Cross Platform Top Content

Returns a list of top content for a given category across supported services.

Category Full Metrics

Returns complete metrics along with entity metrics for given entities associated with specified categories.

Category Member Info

Returns service-specific information related to the members in a given category.

Category Metrics

Returns a list of all metrics for a given category.

Category Ranking

Returns a list of category members sorted by metric name.

Category Time Series

Returns a list of the values of the requested fields per day in the date range.

Cross Platform User Info

Returns service-specific information related to a given entity.

List Category IDs

Returns a list of category IDs.

List Entity IDs

Returns a list of entity IDs.

Page Insights

Returns a list of property level insights data for the given entity. Earliest start date is 2016-01-01.

User Content

Returns a list of pieces of content for a given user identified by the entity ID.

User Cross Platform Top Content

Returns a list of top content for a given user identified by the entity ID across supported services.

User Metrics

Returns a list of all metrics for a given user identified by the entity ID.

User Real Time Series

Returns a list of the values of the requested fields per day in the date offset range.

User Time Series

Returns a list of the values of the requested fields per day in the date range.

Entity ID

Enter the entity ID you want to pull data for, or enter multiple IDs separated by commas.

Category ID

Enter the category ID you want to pull data for, or enter multiple IDs separated by commas.

Object ID

Enter the ID of the object you want to pull data for.

Service

Select the service you want to pull data for.

Field

Select the field you want to flatten.

Duration 

Select whether you want to pull data for a specific date or a date range. 

Report Date 

Select whether the report data is for a specific date or for a relative number of days back from today. 

Select Specific Date 

Select the date for the report. 

Days Back

Enter the number of past days that should appear in the report.  

Start Date

Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in End Date

End Date

Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in Start Date.  

Select Specific Start Date

Select the first date in your date range. 

Select Specific End Date

Select the second date in your date range. 

Days Back to Start From

Enter the number of the farthest day back that should be represented in the report. Combine with Days Back to End At to create a range of represented days.

For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago.

Days Back to End At

Enter the number of the most recent day back that should be represented in the report. Combine with Days Back to Start From to create a range of represented days.

For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago.

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.

FAQs

How frequently will my data update?

As often as needed.

Are there any API restrictions I should be aware of?

Each API token and/or IP address is limited to 5 requests per second. If you exceed these limits, you may be subject to additional terms, review, and/or have the API token revoked.