Brandwatch Inbound Connector

About the Brandwatch Inbound Connector

You can use the Brandwatch inbound connector to load social media and open website data from your Brandwatch account into XM Discover. This can be a great way to integrate online reviews for your company into XM Discover’s analytics and reporting features.

Setting Up a Brandwatch Inbound Job

1. On the Jobs page, click New Job.
   
2. Select Brandwatch.
   
3. Give your job a name so you can identify it.
   
4. Choose the project to load data into.
5. Give your job a description so you know its purpose.
   Qtip: This is a personal description only displayed on the Jobs page, and is not mapped as part of the job’s data.
6. Click Next.
7. Select an existing Brandwatch account, or add a new one.
   
8. Enter a name for your connection.
9. Enter your Brandwatch account’s username.
10. Enter your Brandwatch account’s password.
11. If you want your credentials to expire, then configure the following options:
    • Send Expiration Notifications: Select this option to allow your credentials to make sure your credentials expire.
    • Days prior expiration: If enabling expiration notifications, enter how many days you’d like to be notified before the expiration. You may enter a value between 1 to 100 days.
    • Expiration Date: Set the date when the credentials will expire. Click on the box to open a calendar to pick the date.
12. Click Next.
13. Select a Brandwatch project.
14. Select one of the predefined search queries to pull into the data loader.
    Qtip: If you have questions about logging into Brandwatch, creating projects, or configuring queries, reach out to the Brandwatch support team.
15. On the Select Brandwatch Data Options page, you can further narrow down your search query by applying filters. See linked section for details.
16. If needed, adjust your data mappings. See the Data Mapping support page for detailed information on mapping fields in XM Discover. The Default Data Mapping section has information on the fields specific to this connector and the Mapping Conversational Fields section covers how to map data for conversational data.
17. Click Next.
18. If desired, you can add data substitution and redaction rules to hide sensitive data or automatically replace certain words and phrases in customer feedback and interactions.
    Qtip: Click Download Sample Data to download an Excel file with sample data to your computer.
19. Click Next.
20. If desired, you can add a connector filter to filter the incoming data to limit what data is imported.
    
21. You can also limit the number of records imported in a single job by entering a number in the Specify Record Limit box. Enter “All” if you would like to import all records.
    Qtip: For conversational data, the limit is applied based on conversations rather than rows.
22. Click Next.
23. Choose when you’d like to be notified. See Job Notifications for more information.
    
24. Click Next.
25. Choose how duplicate documents are handled. See Duplicate Handling for more information.
    
26. Choose Schedule Incremental Runs if you’d like your job to run periodically on a schedule, or Set Up One-Time Pull if you’d like the job to run just once. See Job Scheduling for more information.
27. Click Next.
28. Review your setup. If you need to change a specific setting, click the Edit button to be brought to that step in the connector setup.
29. Click Finish to save the job.

Brandwatch Data Source Filtering

On the Select Brandwatch Data Options page, you can further narrow down your Brandwatch project’s search query using filters.

• Filter Conditions: You can choose from the following types of conditions:
  • Category: Search by topics defined in Brandwatch.
  • Tag: Search by tags defined in Brandwatch.
• Operators: Decide how results should match the values you enter:
  • Is: Include the exact values you specify.
  • is not: Exclude the exact values you specify.
• Values: The actual value you enter into the condition. You can specify multiple values.
  Qtip: Multiple values in the same condition are joined by “or.” This means any of the values can match your results, but not all of them have to match.

To add a condition, click the plus button ( + ). To remove a condition, click the minus button ( – ).

Default Data Mapping

This section contains information on the default fields for Brandwatch inbound jobs.

• natural_id: A unique identifier of a document. It is highly recommended to have a unique ID for each document to process duplicates correctly. For Natural ID, you can select any text or numeric field from your data. Alternatively, you can automatically generate IDs by adding a custom field. By default, XM Discover uses source IDs prefixed by the connector’s name via a custom transformation:Natural ID = Connector-name;Source-ID. You cannot edit this field.
• document_date: The primary date field associated with a document. This date is used in XM Discover reports, trends, alerts, and so on. By default, this is mapped to the date field selected after specifying the SOQL query. You can choose one of the following options:
  • responseTime (default): The date and time of when feedback was submitted
  • If source data contains other date fields, you can choose one of them.
  • You can also set a specific document date.
• feedback_provider: Identifies data obtained from a specific provider. For Brandwatch uploads, this attribute’s value is set to “Brandwatch” and cannot be changed.
• source: Identifies data obtained from a specific source. This can be anything that describes the origin of data, such as the name of a survey or a mobile marketing campaign. By default, this attribute’s value is set to “Brandwatch.” Use custom transformations to set a custom value, define an expression, or map it to another field.
• feedback_type: Identifies data based on its type. This is useful for reporting when your project contains different types of data (for example, surveys and social media feedback). By default, this attribute’s value is set to “Social”.
• job_name: Identifies data based on the name of the job used to upload it. You can modify this attribute’s value during the setup via the Job Name field that is displayed at the top of each page during the setup.
• loadDate: Indicates when a document was uploaded into XM Discover. This field is set automatically and cannot be changed.