Skip to main content

​
Intro

The Vibe Reporting API extracts reporting data from your Vibe dashboard and uploads it to third-party measurement systems. You can create and run reports to get detailed information about purchases, including timestamps, values, and associated campaign data. Use the Domo Vibe connector to create and run reports, and track and analyze purchase events across your advertising campaigns. For more information, refer to the API documentation. You can connect to your Vibe account in the Data Center. This topic discusses the fields and menus that are specific to the Vibe connector user interface. To add DataSets, set update schedules, and edit DataSet information, see Adding a DataSet Using a Connector.

​
Prerequisites

To connect to your Vibe account and create a DataSet, you need the API Key.

​
Generating Your API Key

All API requests require an API token. Generate your API key directly from your Vibe account by following these steps:
  1. Go to Account Settings.
  2. In the menu, navigate to Developer Tool > API Keys.
  3. Click Create API Key.
  4. Enter a name for the key.
  5. The API key is generated and displayed once.
  6. Click Copy and immediately store the key in a secure location.
Important: For security reasons, the key is displayed only once. If you lose your API key, you must generate a new one.

​
Connecting to Your Vibe Account

This section enumerates the options in the Credentials and Details panes on the Vibe 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 great detail in Adding a DataSet Using a Connector.

​
Credentials Pane

This pane contains fields for entering credentials to connect to your Vibe account. The following table describes what is needed for each field:

Field

Description

API Key Enter the API Key. To generate the API Key, refer to the Prerequisites section or API documentation .
Once you have entered valid Vibe credentials, you can use the same account at any time to create a new Vibe DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector Accounts.

​
Details Pane

Menu

Description

Report

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

Report Name Description

Campaign Details Report

Returns a list of campaigns and strategies for an advertiser.

Create and Run Report

Define the report dimensions and metrics, run the report, and then download the result.

Purchases Details Report

Returns detailed purchase information, including timestamps, values, and associated campaign data.

Advertiser Ids Selection Criteria

Select how you want to retrieve advertisers.

Advertiser IDs

This field appears when you select Create and Run Report or Purchases Details Report .

Select the advertisers for the report.

Metrics

This field appears when you select the Create and Run Report .

Select the metrics for the report.

Dimensions

This field appears when you select the Create and Run Report .

Select the dimensions for the report.

Segment Dimensions

This field appears when you select the Create and Run Report .

Select the segment-related dimension for the report.

Attribution Window

This field appears when you select the Create and Run Report .

Select the desired attribution window duration for web-pixel metrics. This will affect web-pixel metrics. 7 days is selected by default.

Granularity

This field appears when you select the Create and Run Report .

Select the desired time aggregation granularity. Day is selected by default.

App IDs to Filter

This field appears when you select both Create and Run Report and Purchases Details Report.

Select the app IDs as a filter for the report.

Campaign IDs to Filter

Select the campaign IDs as a filter for the report.

Strategy IDs to Filter

Select the strategy IDs as a filter for the report.

Date Range

This field appears when you select Create and Run Report or Purchases Details Report .

Choose whether the report should cover a Single Date or a Date Range .

  • Single Date: Select whether the report data is for a specific date or for a relative number of days back from today.
    • Relative Date: Enter the number of days back from today.
      • Days Back: Enter the number of days relative to today for which you want to receive the data. Use 0 for today, 1 for yesterday, 7 for 7days ago, and so on.
    • Specific Date: Use the date picker to select a precise date.
      • Date: Select the precise date. (The date cannot be before January 1, 2020, and must not be a future date.)

  • Date Range: Select the date range for which you want to fetch the data. The date range cannot be before January 1, 2020, and must not be a future date.

    • Start Date: Select the start date to fetch the data.

      • Relative Date: Enter the number of days back from today.
        • Days Back: Enter the number of days relative to today for the desired start date. For example, enter 1 for yesterday, 7 for 1 week ago, or 30 for 1 month ago.
      • Specific Date: Use the date picker to select a precise start date.
        • Date: Select the precise start date. (The date cannot be before January 1, 2020, and must not be a future date.)

    • End Date: Select the end date to fetch the data.

      • Relative Date: Enter the number of days back from today.
        • Days Back: Enter the number of days relative to today for the desired end date. For example, enter 0 for today, or 1 for an end date of yesterday.
      • Specific Date: Use the date picker to select a precise end date.
        • Date: Select the precise end date. (The date cannot be before January 1, 2020, and must not be a future date.)
  • Time Period: Select the time period for data retrieval.
Timezones

Select the timezone for the returned data. UTC is selected by default.

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