# Outbrain

### Snapshot

| Features                        | Details                              |
| ------------------------------- | ------------------------------------ |
| Release Status                  | Released                             |
| Source API Version              | v0.1                                 |
| Table Selection                 | Yes                                  |
| Column Selection                | Yes                                  |
| Edit Integration                | Yes                                  |
| Replication Type Selection      | No                                   |
| Authentication Parameters       | <p>Outbrain Username<br>Password</p> |
| Replication Type                | Key Based Incremental                |
| Replication Key                 | Date                                 |
| Suggested Replication Frequency |                                      |

| Tables/APIs Supported                   |                                 |
| --------------------------------------- | ------------------------------- |
| ConversionEvents                        | Budgets                         |
| Campaigns                               | Segments                        |
| PromotedLinks                           | Interests                       |
| CampaignsPerformanceReport              | PromotedLinksPerformanceReport  |
| MarketersDailyPerformanceReport         | CampaignsDailyPerformanceReport |
| PromotedLinksDailyPerformanceReport     | PublishersPerformanceReport     |
| CampaignsPerformanceReportByPublisher   | SectionsPerformanceReport       |
| CampaignsPerformanceReportBySections    | PlatformsPerformanceReport      |
| CampaignsPerformanceReportByPlatforms   | GeographicsPerformanceReport    |
| CampaignsPerformanceReportByGeographics | CampaignOptimizationExperiments |

### Stepwise Manual

#### Prerequisites:

1. An active Outbrain account.
2. API access enabled on your account. \
   (If API access is not enabled, fill out the [Outbrain API access form](https://lp.outbrain.com/partner-api-form/) and wait for a confirmation email.)

#### Integrate Outbrain with Daton

1. Sign in to Daton.
2. Select Outbrain from the Integrations page.
3. Provide Integration Name, Replication Frequency, and History. The integration name would be used in creating tables for the integration and cannot be changed later.
4. Provide Outbrain Username and Password corresponding to your Outbrain account.
5. Post successful authentication, you will be prompted to choose from the list of available tables
6. Then select all required fields for each table.
7. Submit the integration.

### Workflow

1. Integrations would be in the Pending state initially and will be moved to the Active state as soon as the first job loads data successfully onto the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### Outbrain Data

**ConversionEvents**

Purpose: Multiple Conversions gives the ability to track any of the actions a user takes after clicking through to your content. You can track everything from the top of the funnel (page landings and time on site) to the bottom of the funnel (e-book downloads and product purchases). Retrieve all Conversion Events associated with the current Marketer.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/multiple-conversions/conversion-event-collection/retrieve-all-marketer's-conversion-events>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name                 | Target Datatype |
| -------------------- | --------------- |
| trackingStatus       | STRING          |
| name                 | STRING          |
| enabled              | BOOLEAN         |
| conversionWindow     | NUMERIC         |
| id                   | STRING          |
| type                 | STRING          |
| includeInConversions | BOOLEAN         |
| marketerId           | STRING          |
| url                  | STRING          |
| lastModified         | STRING          |
| usingNewTag          | BOOLEAN         |
| creationTime         | STRING          |

**Budgets**

Purpose: Budget objects represent an amount of money to be spent via the Amplify platform. A single Budget may be shared among Campaigns (also known as a "shared budget"), though it is more common to have just one Campaign per Budget. For convenience, Budget objects are often embedded inside the Campaign objects. Retrieve a collection of all Budgets for the specified Marketer.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/budgets/budgets-collection/retrieve-all-marketer's-conversion-events>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name            | Target Datatype |
| --------------- | --------------- |
| currency        | STRING          |
| name            | STRING          |
| shared          | BOOLEAN         |
| amount          | NUMERIC         |
| id              | STRING          |
| amountRemaining | NUMERIC         |
| amountSpent     | NUMERIC         |
| startDate       | STRING          |
| lastModified    | STRING          |
| runForever      | BOOLEAN         |
| creationTime    | STRING          |
| type            | STRING          |
| pacing          | STRING          |
| dailyTarget     | NUMERIC         |
| maximumAmount   | NUMERIC         |

**Campaigns**

Purpose: Collection of all campaigns for a specific Marketer. Campaigns contain many PromotedLinks and define Budget, targeting, cpc, etc. Campaign settings apply to the PromotedLinks contained in a specific Campaign.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/campaigns/campaigns-collection-via-marketer/retrieve-all-marketer's-conversion-events>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name               | Target Datatype |
| ------------------ | --------------- |
| marketerId         | STRING          |
| name               | STRING          |
| id                 | STRING          |
| onAirReason        | STRING          |
| enabled            | BOOLEAN         |
| lastModified       | STRING          |
| creationTime       | STRING          |
| autoArchived       | BOOLEAN         |
| currency           | STRING          |
| cpc                | NUMERIC         |
| minimumCpc         | NUMERIC         |
| amountSpent        | NUMERIC         |
| targeting          | RECORD          |
| feeds              | STRING          |
| suffixTrackingCode | STRING          |
| prefixTrackingCode | RECORD          |
| liveStatus         | RECORD          |

**Segments**

Purpose: Segments give the ability to segment customers based on their actions, and retarget them with new or existing campaigns. This translates into your campaigns reaching a highly engaged audience that is more likely to convert and fulfill your brand's goals. With this functionality you'll be able to segment customers in two ways: Audience Retargeting (Type: PIXEL) and Story Sequencing (Type: CLICKERS). note: The PIXEL feature requires the installation of the Outbrain Custom Audience pixel, which can be retrieved from your account on Outbrain.com. If you have the old audience pixel installed, you will need to remove that before installing the new pixel. For additional information regarding obtaining and installing the pixel properly, please visit our help center here: <http://help.outbrain.com/customer/en/portal/articles/2809479-how-can-i-create-custom-audiences>

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/segments/segments/retrieve-all-marketer's-conversion-events>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name               | Target Datatype |
| ------------------ | --------------- |
| marketerId         | STRING          |
| name               | STRING          |
| id                 | STRING          |
| description        | STRING          |
| enabled            | BOOLEAN         |
| segmentType        | STRING          |
| pixelTypeRules     | RECORD          |
| clickersCampaigns  | RECORD          |
| archived           | BOOLEAN         |
| membershipDuration | NUMERIC         |
| size               | NUMERIC         |
| trackingStatus     | STRING          |
| lastModified       | STRING          |
| creationTime       | STRING          |

**PromotedLinks**

Purpose: Collection of all PromotedLinks for the specified Campaign. A PromotedLink is the entity that describes a single piece of promoted content.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/promotedlinks/retrieve-all-marketer's-conversion-events>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name             | Target Datatype |
| ---------------- | --------------- |
| campaignId       | STRING          |
| text             | STRING          |
| id               | STRING          |
| siteName         | STRING          |
| sectionName      | STRING          |
| enabled          | BOOLEAN         |
| archived         | BOOLEAN         |
| cpc              | NUMERIC         |
| url              | STRING          |
| status           | STRING          |
| cachedImageUrl   | STRING          |
| baseUrl          | STRING          |
| documentLanguage | STRING          |
| lastModified     | STRING          |
| creationTime     | STRING          |

**Interests**

Purpose: Returns all available interests. Interest Targeting gives you the ability to select your preferred interests categories in your campaign setup.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/interest-targeting/retrieve-all-available-interests/retrieve-all-marketer's-conversion-events>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name | Target Datatype |
| ---- | --------------- |

id STRING name STRING canBeTargeted BOOLEAN reachEstimationCount NUMERIC subConcepts RECORD

**CampaignsPerformanceReport**

Purpose: Retrieves marketer campaigns data with performance statistics.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/retrieve-campaigns-with-performance-statistics-for-a-marketer>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**PromotedLinksPerformanceReport**

Purpose: Retrieves performance statistics by promoted link at different levels: marketer, budget, campaign and promoted link.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/content/retrieve-promoted-links-performance-statistics-for-a-marketer>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**MarketersDailyPerformanceReport**

Purpose: Retrieves performance statistics by periodic breakdown at different levels: marketer, budget, campaign and promoted link.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/periodic/retrieve-periodic-performance-statistics-for-a-marketer>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**CampaignsDailyPerformanceReport**

Purpose: Retrieves periodic data(daily) by campaign breakdown.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/periodic-by-campaign/retrieve-performance-statistics-for-all-marketer-campaigns-by-periodic-breakdown>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| campaignId | STRING          |
| results    | RECORD          |

**PromotedLinksDailyPerformanceReport**

Purpose: Retrieves periodic data by promoted link breakdown for a given campaign.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/periodic-content/retrieve-periodic-performance-statistics-by-promoted-link-for-a-campaign>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name           | Target Datatype |
| -------------- | --------------- |
| promotedLinkId | STRING          |
| results        | RECORD          |

**PublishersPerformanceReport**

Purpose: Publisher: A content site that displays Outbrain recommendations on which your promoted content appeared. Retrieving marketer performance statistics with breakdown by publisher with publishers that are already blocked at the marketer or campaign level.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/publishers/retrieve-performance-statistics-for-a-marketer-by-publisher>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**CampaignsPerformanceReportByPublisher**

Purpose: Retrieves publishers data by campaign breakdown.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/publishers-by-campaign/retrieve-performance-statistics-for-all-marketer-campaigns-by-publisher>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| campaignId | STRING          |
| results    | RECORD          |

**SectionsPerformanceReport**

Purpose: Section: A specific content section within the publisher's site such as sports, business etc. Retrieves marketer performance statistics with breakdown by section with sections that are already blocked at the marketer or campaign level.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/publishers-by-campaign/retrieve-performance-statistics-for-a-marketer-by-section>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**CampaignsPerformanceReportBySections**

Purpose: Retrieves sections data by campaign breakdown.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/sections-by-campaign/retrieve-performance-statistics-for-all-marketer-campaigns-by-section>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| campaignId | STRING          |
| results    | RECORD          |

**PlatformsPerformanceReport**

Purpose: Retrieves performance statistics by platform at different levels: marketer, budget, and campaign.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/platforms/retrieve-performance-statistics-for-all-marketer-campaigns-by-section>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**CampaignsPerformanceReportByPlatforms**

Purpose: Retrieves platforms data by campaign breakdown.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/platforms-by-campaign/retrieve-performance-statistics-for-all-marketer-campaigns-by-platform>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| campaignId | STRING          |
| results    | RECORD          |

**GeographicsPerformanceReport**

Purpose: Retrieves performance statistics by geographic breakdown at different levels: country, region, and DMA.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/geo/retrieve-geo-performance-statistics-for-a-marketer>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name     | Target Datatype |
| -------- | --------------- |
| metadata | RECORD          |
| metrics  | RECORD          |

**CampaignsPerformanceReportByGeographics**

Purpose: Retrieves geographic data by campaign breakdown.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/geo-by-campaign/retrieve-performance-statistics-for-all-marketer-campaigns-by-geo>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name       | Target Datatype |
| ---------- | --------------- |
| campaignId | STRING          |
| results    | RECORD          |

**CampaignOptimizationExperiments**

Purpose: Retrieves performance statistics for campaign optimization experiments.

Source API Documentation  <https://amplifyv01.docs.apiary.io/#reference/performance-reporting/campaign-optimization-experiments/retrieve-optimization-experiments-statistics-for-a-campaign>

Replication: Key-Based Replication

Replication Key: creationTime

**Fields**

| Name                 | Target Datatype |
| -------------------- | --------------- |
| campaignName         | STRING          |
| budget               | RECORD          |
| kpioExperimentStatus | STRING          |
| results              | RECORD          |