> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Shareablee Connector

## Intro

Shareablee is a strategic marketing intelligence solution empowering brands, content publishers, and agencies to easily get the insights they need to know across all measurable channels of social engagement to drive their most important marketing and business decisions.

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 ([https://www.shareablee.com/product/api-integrations](https://www.shareablee.com/product/api-integrations "https://www.shareablee.com/product/api-integrations") ). The Shareablee API offers a great selection of industry-wide owned, paid, and earned metrics for Facebook, Instagram, Twitter, and YouTube –on a single brand level, keyword or topic, and category level (which represent a predefined or custom set of brands).

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](https://domo-support.domo.com/s/article/360042926274?language=en_US "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 on the Shareablee Connector page. The components of the other panes on 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](https://domo-support.domo.com/s/article/360042926274?language=en_US "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:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> API Key </p></td><td colspan="1" rowspan="1"><p> Enter your Shareablee API key. </p></td></tr><tr><td colspan="1" rowspan="1"><p> API Secret </p></td><td colspan="1" rowspan="1"><p> Enter your Shareablee API secret. </p></td></tr></tbody></table>

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](https://domo-support.domo.com/s/article/360042926054?language=en_US "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.

Reports regarding Content and Page Insights also serve private data that is available for owners of social pages that authenticate them to the Shareablee technology.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the Shareablee report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p><b> Report Name </b></p></td><td colspan="1" rowspan="1"><p><b> Description </b></p></td></tr><tr><td colspan="1" rowspan="1"><p> Audience Affinity Comparison </p></td><td colspan="1" rowspan="1"><p> Returns a list of Affinity data on the entity\_id against the object\_ids for the selected date range. The earliest start date is 2015-12-01. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Audience Affinity Ranking </p></td><td colspan="1" rowspan="1"><p> Returns a list of Property level Affinity data for the entity\_id. The earliest start date is 2015-12-01. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Audience Overlap Comparison </p></td><td colspan="1" rowspan="1"><p> Returns a list of Cross Engagement data on the entity\_id against the object\_ids for each month and service in the time range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Audience Overlap Ranking </p></td><td colspan="1" rowspan="1"><p> Returns a list of Property level cross engagement data for the entity\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Cross Platform Member Info </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns service specific information related to the members from a given category\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Cross Platform Member Rankings </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of ranked members for a given category identified by the category\_id across supported services. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Cross Platform Top Content </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of top content for a given category identified by the category\_id across supported services. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Category Full Metrics </p></td><td colspan="1" rowspan="1"><p> Returns complete metrics along with entity metrics for entity ids associated with specified category ids. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Member Info </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns service specific information related to the members from a given category\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Metrics </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of all metrics for a given category identified by the category\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Ranking </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of category members of category\_id sorted by the metric name 'metric'. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Category Time Series </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of the values of the requested fields per day in the date range. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Cross Platform User Info </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns service specific information related to a given entity\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> List Category IDs </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of all category ids. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> List Entity IDs </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of all entity ids. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> Page Insights </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of Property-level insights data for the entity\_id. The earliest start date is 2016-01-01. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> User Content </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of pieces of content for a given user identified by the entity\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> User Cross Platform Top Content </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of top content for a given user identified by the entity\_id across supported services. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> User Metrics </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of all metrics for a given user identified by the entity\_id. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> User Real Time Series </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of the values of the requested fields per day in the date offset range. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> User Stories </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of stories for the selected entity in the selected date range. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top"><p> User Time Series </p></td><td colspan="1" rowspan="1" valign="top"><p> Returns a list of the values of the requested fields per day in the date range. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Entity ID </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Enter the entity ID you want to pull data for or enter multiple IDs separated by commas. Entity ID represents a Brand. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Category ID </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Enter the category ID you want to pull data for or enter multiple IDs separated by commas. Categories are preconfigured sets of Brands reflecting e.g., industries or markets. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Service </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select the service you want to pull data for. Service represents Social Platform. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Field </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select the field you want to receive data for. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Duration </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select whether you want to pull data for a specific date or a date range. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Report Date </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select whether the report data is for a specific date or a relative number of days back from today. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Select Specific Date </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select the date for the report. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Days Back </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Enter the number of past days that should appear in the report. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Start Date </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Specify whether the first date in your date range is specific or relative. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> End Date </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Specify whether the second date in your date range is specific or relative. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Days Back to End At </b> to create a range of represented days. </p><p> For example, if you entered 10 for <b> Days Back to Start From </b> and 5 for <b> Days Back to End At </b>, the report would contain data from 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1" valign="top" width="16%"><p> Days Back to End At </p></td><td colspan="1" rowspan="1" valign="top" width="83%"><p> Enter the number of the most recent days back that should be represented in the report. Combine with <b> Days Back to Start From </b> to create a range of represented days. </p><p> For example, if you entered 10 for <b> Days Back to Start From </b> and 5 for <b> Days Back to End At </b>, the report would contain data from 10 days ago up until 5 days ago. </p></td></tr></tbody></table>

## 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](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Data Connector").

## FAQs

<AccordionGroup>
  <Accordion title="How frequently will my data update?">
    As often as needed.
  </Accordion>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>
