Saltar al contenido principal
waffle.svg
Domo

Clavis Connector

Version 1

 

Important: When referencing this page outside of Knowledge Base, use this link: https://knowledge.domo.com?cid=clavis

Intro

Clavis Insight provides intelligence and analysis of how products and brands perform in online stores. Use Domo's Clavis connector to get data about content, products, KPIs, and search terms to help you unlock eCommerce opportunities and protect your brand online. To learn more about the Clavis API, reach out to your account representative.

You connect to your Clavis account in the Data Center. This topic discusses the fields and menus that are specific to the Clavis 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 Clavis account and create a DataSet, you must have your Clavis username and password.

Connecting to Your Clavis Account

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

Field

Description

Username

Enter your Clavis username.

Password

Enter your Clavis password.

Once you have entered valid Clavis credentials, you can use the same account any time you go to create a new Clavis 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 Clavis report you want to run. The following reports are available:

Content

Returns the rule failures from the Content Integrity report.

KPI

Returns the top level scores for each of your metrics for either a single report date or for a date range period.

Products

Returns data for availability, rating, number of reviews, price, promotion text and retailer product image.

Search Terms

Returns the search term results for a single report date.

Classification

Select the classification you want to retrieve data for.

Online Store (Optional)

Enter a comma-separated list of stores you want to filter by.

Brand (Optional)

Enter a comma-separated list of brands you want to filter by.

Category (Optional) 

Enter a comma-separated list of categories you want to filter by.

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.

Aggregation Period

Select whether you want data to be aggregated for the entire selected date range or broken down by day.

Competitor Data

Select whether you want to include or exclude competitor data.

Manufacturer (Optional)

Enter a comma-separated list of manufacturers you want to filter by.

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.