> ## 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.

# BrandIndex Connector

## Intro

To learn more about the BrandIndex API, visit their page ([https://api.brandindex.com/v0](https://api.brandindex.com/v0 "https://api.brandindex.com/v0") ).

You connect to your BrandIndex account in the Data Center. This topic discusses the fields and menus that are specific to the BrandIndex connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Connector](/s/article/360042926274 "Adding a DataSet Using a Connector").

## Prerequisites

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

* The email address associated with your BrandIndex account
* Your BrandIndex password

## Connecting to Your BrandIndex Account

This section enumerates the options in the **Credentials** and **Details** panes in the BrandIndex 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 Connector](/s/article/360042926274 "Adding a DataSet Using a Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your BrandIndex 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> Email </p></td><td colspan="1" rowspan="1"><p> Enter the email associated with your BrandIndex account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Password </p></td><td colspan="1" rowspan="1"><p> Enter the password associated with your BrandIndex account. </p></td></tr></tbody></table>

Once you have entered valid BrandIndex credentials, you can use the same account any time you go to create a new BrandIndex DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Manage Connector/Adapter Accounts](/s/article/360042926054 "Manage Connector/Adapter Accounts").

### 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.

<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 BrandIndex 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> Brands List </p></td><td colspan="1" rowspan="1"><p> Returns a list of brands for a given region and sector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Custom Sectors </p></td><td colspan="1" rowspan="1"><p> Returns a list of custom sectors. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Demographic Filters </p></td><td colspan="1" rowspan="1"><p> Returns a list of demographic filters for the "Multi Brand Query" report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Metric Filters </p></td><td colspan="1" rowspan="1"><p> Returns a list of available metric filters for the "Multi Brand Query" report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Multi Brand Query </p></td><td colspan="1" rowspan="1"><p> Returns data for multiple brands. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Regions </p></td><td colspan="1" rowspan="1"><p> Returns a list of regions. For use with the "Single Brand," "Brands List," "Demographic Filters," and "Sectors" reports. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Sectors </p></td><td colspan="1" rowspan="1"><p> Returns a list of sectors. For use with the "Single Brand," "Brands List" and "Demographic Filters" reports. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Single Brand </p></td><td colspan="1" rowspan="1"><p> Returns a list of data points for a given brand. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Region </p></td><td colspan="1" rowspan="1"><p> Enter the name of the region you want to retrieve data for. You can find a list of regions by running the "Regions" report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Sector </p></td><td colspan="1" rowspan="1"><p> Enter the ID for the sector you want to retrieve data for. You can find a list of sectors by running the "Sectors" report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Query </p></td><td colspan="1" rowspan="1"><p> Enter your Brandlndex query to retrieve data for multiple brands. You must provide at least one brand, sector, or custom sector parameter. The brand parameter can have single or multiple brands separated by the <span class="mt-font-courier-new"> & </span> symbol. </p><p> The query can include filters in the following formats: </p><p><b> Sectors </b>: <span class="mt-font-courier-new"> sector=region:sector\_id\[:demo\_filters]\[:metric\_filters]\[:metrics] </span></p><p><b> Custom Sectors: </b><span class="mt-font-courier-new"> custom\_sector=region:custom\_sector\_id\[:demo\_filters]\[:metric\_filters]\[:metrics] for custom sectors </span></p><p><b> Brand Queries: </b><span class="mt-font-courier-new"> brand=region:sector\_id:brandJd\[:demo\_filters]\[:metric\_filters]\[:metrics] </span></p><p> For example: </p><p><span class="mt-font-courier-new"> brand=us:123:1234:/brand.3456.reputation.1\&brand=us:234:2345:/foo\_filter.1/bar\_filter.2\ </span></p><p> This query would retrieve brand ID "1234" from sector "123" and from the "U.S." region with a metric filter reputation value of "1" for brand "3456," as well as brand ID "2345" from sector "234" and from the "U.S." region, with the following demographic filters: <span class="mt-font-courier-new"> foo\_filter </span> value of "1" and <span class="mt-font-courier-new"> bar\_filter </span> value of "2." </p><p> Brandlndex does not require you to supply demo filters, metric filters, or metrics. You are able to supply any combination of the filters and metrics, but you must include at least one brand, sector, or custom sector. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Scoring Type </p></td><td colspan="1" rowspan="1"><p> The scoring option to use, within "total" (includes all respondents, including unaware respondents), "aware" (excludes unaware respondents) and "opinion" (excludes both unaware respondents and respondents who don't have a positive or negative opinion of the brand). </p></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><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"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> Select whether the report data is for a specific date or for a relative number of days back from today. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the date for the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back </p></td><td colspan="1" rowspan="1"><p> Enter the number of past days that should appear in the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1"><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 <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to End At </p></td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day 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 <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 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 Connector](/s/article/360042926274 "Adding a DataSet Using a Connector").
