Outbrain (v1.0) | Stitch Documentation

Outbrain is supported by the Singer community
This integration is powered by Singer's Outbrain tap. For support, visit the GitHub repo or join the Singer Slack.

Outbrain integration summary

Stitch’s Outbrain integration replicates data using the Outbrain Amplify API. Refer to the Schema section for a list of objects available for replication.

Outbrain feature snapshot

A high-level look at Stitch's Outbrain integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status	Released	Supported By	Singer Community
Stitch Plan	Free	Singer GitHub Repository	Outbrain Repository
DATA SELECTION
Table Selection	Unsupported	Column Selection	Unsupported
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Unsupported
Table-level Reset	Unsupported	Configurable Replication Methods	Unsupported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Outbrain

Step 1: Add Outbrain as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Outbrain icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Outbrain” would create a schema called stitch_outbrain in the destination. Note: Schema names cannot be changed after you save the integration.
In the Account ID field, enter your Outbrain Account (or Marketer) ID.

You can find this by looking at the URL when you’re logged into your Outbrain account. The Account ID looks something like this: 0f4b02153ee75f3c9dc4fc128ab041962 and is located between marketers and campaigns, if you’re looking at the Overview dashboard:

https://my.outbrain.com/amplify/site/marketers/[account-id-will-be-here]/campaigns/overview
In the Username field, enter your Outbrain username.
In the Password field, enter your Outbrain password.

Step 2: Define the historical sync

The Sync Historical Data setting will define the starting date for your Outbrain integration. This means that:

For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Outbrain’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 3: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Outbrain integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Outbrain, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Outbrain table schemas

Table and column names in your destination

Depending on your destination, table and column names may not appear as they are outlined below.

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

campaign_performance

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	fromDate
Primary Key :	campaignId : fromDate	API endpoint :	retrieveCampaignsWithPerformanceStatisticsForAMarketer

The campaign_performance table contains performance metrics for your Outbrain campaigns.

campaign_performance table schema

campaignId
STRING

The campaign ID plus the start date (day).

fromDate
DATE

The start date.

impressions
NUMBER

The total number of PromotedLinks impressions for the campaign.

clicks
NUMBER

The total number of PromotedLinks clicks for the campaign.

ctr
NUMBER

The average click through rate percentage for the campaign. Calculated as (clicks / impressions)/100

spend
NUMBER

The total amount of money spent for the campaign.

ecpc
NUMBER

The effective (calculated) average CPC (Cost Per Click) for the campaign. Calculated as (spend / clicks)

conversions
NUMBER

The total number of conversions for the campaign.

conversionRate
NUMBER

The average rate of conversions per click percentage for the campaign. Calculated as (conversions / clicks)/100

cpa
NUMBER

The average CPA (Cost Per Acquisition) for the campaign. Calculated as (spend / conversions)

campaigns

View table schema on GitHub

Replication Method :	Full Table	Primary Key :	id
API endpoint :	listAllCampaignsAssociatedWithAMarketer

The campaigns table contains info about your Outbrain campaigns.

campaigns table schema

id
STRING

The campaign ID.

name
STRING

The name of the campaign.

campaignOnAir
BOOLEAN

Indicates if the campaign is on air.

onAirReason
STRING

The reason for the campaign’s on air status.

enabled
BOOLEAN

Indicates if the campaign is enabled.

budget
OBJECT

Details about the budget associated with the campaign.

Click to expand budget

id
STRING

The budget ID.

name
STRING

The name of the budget.

shared
BOOLEAN

Indicates if the budget is shared between campaigns.

amount
NUMBER

The monetary amount of the budget.

currency
STRING

The currency denomination applied to the budget.

amountRemaining
NUMBER

The unspent monetary amount remaining on the budget.

amountSpent
NUMBER

The spent monetary amount of the budget.

creationTime
DATE-TIME

The time when the budget was created.

lastModified
DATE-TIME

The time the budget was last updated.

startDate
DATE

The date the budget is scheduled to begin spending.

endDate
DATE

The date the budget is scheduled to stop spending. If the runForever attribute is true, this attribute will not be present for the budget.

runForever
BOOLEAN

Indicates if the budget has an end date. If true, the endDate attribute will not be present for the budget.

type
STRING

Indicates the period on which the budget refreshes. Ex: monthly

pacing
STRING

Indicates how fast the budget will be spent. Ex: automatic

dailyTarget
NUMBER

The maximum amount of spend that is allowed per day.

maximumAmount
NUMBER

The maximum amount allowed, if defined.

campaigns (table), budget (attribute)

cpc
NUMBER

The cost per monetized user action. For example: cost per click.

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues