Skip to main content

Outbrain Engage

Outbrain Engage provides publishers with comprehensive content monetization and audience engagement tools, offering detailed analytics, revenue optimization, and content recommendation solutions to maximize publisher value and user engagement.

Outbrain Engage icon

Power end-to-end data operations for your Outbrain Engage API with Nexla. Our bi-directional Outbrain Engage connector is purpose-built for Outbrain Engage, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Outbrain Engage or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Outbrain Engage workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Outbrain Engage credential, you need to identify your API server URL and obtain your Outbrain username and password. Outbrain Engage uses token-based authentication, where your username and password are used to obtain an API token that is then used for all subsequent API requests.

To obtain your Outbrain Engage credentials, follow these steps:

  1. Sign in to your Outbrain Engage account using your Outbrain account credentials.

  2. Navigate to your Outbrain Engage dashboard or account settings in the Outbrain interface.

  3. Identify your API server URL. The default API server URL for Outbrain Engage is https://api.outbrain.com/engage/v2. This URL is used for all API requests to the Outbrain Engage API.

  4. Your Outbrain username is the username you use to sign in to your Outbrain Engage account. This username is used to authenticate with the Outbrain Engage API and obtain an API token.

  5. Your Outbrain password is the password associated with your Outbrain Engage account. This password is used along with your username to authenticate with the Outbrain Engage API and obtain an API token.

  6. Store all credentials securely, as you will need them to configure your Nexla credential. The username and password are sensitive information and should be kept confidential.

The username and password are used to authenticate with the Outbrain Engage API login endpoint (/login) to obtain an API token. The API token is then sent in the Authorization header with the Bearer prefix for all subsequent API requests. The API token is automatically obtained and refreshed by Nexla as needed. If your credentials are compromised, you should immediately change your password in your Outbrain account settings. For detailed information about Outbrain Engage authentication, API access, and available endpoints, refer to the Outbrain Engage API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API Server URLYesNoEnter the API server URL for Outbrain Engage API.
Outbrain UsernameYesNoEnter your Outbrain username. This is used to fetch an API token.
Outbrain PasswordYesYesEnter your Outbrain password. This is used to fetch an API token.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Outbrain Engage

OutbrainEngCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Enter your Outbrain Engage API server URL in the API Server URL field. The default API server URL is https://api.outbrain.com/engage/v2. This URL is used for all API requests to the Outbrain Engage API, including the login endpoint for token authentication.

  3. Enter your Outbrain username in the Outbrain Username field. This is the username you use to sign in to your Outbrain Engage account. The username is used along with your password to authenticate with the Outbrain Engage API login endpoint and obtain an API token.

  4. Enter your Outbrain password in the Outbrain Password field. This is the password associated with your Outbrain Engage account. The password is used along with your username to authenticate with the Outbrain Engage API login endpoint and obtain an API token. The password is sensitive information and must be kept confidential.

    Your Outbrain Engage credentials can be found in your Outbrain Engage account. The username and password are used to authenticate with the Outbrain Engage API login endpoint (/login) to obtain an API token. The API token is then automatically sent in the Authorization: Bearer {token} header for all subsequent API requests to the Outbrain Engage API.

    The API token is automatically obtained and refreshed by Nexla as needed. If your credentials are compromised, you should immediately change your password in your Outbrain account settings. The username and password provide access to your Outbrain Engage account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about Outbrain Engage authentication, API access, and available endpoints, see the Outbrain Engage API documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Outbrain Engage connector tile, then select the credential that will be used to connect to your Outbrain Engage account, and click Next; or, create a new Outbrain Engage credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Outbrain Engage endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Fetch Publishers

This endpoint template retrieves all publishers associated with the current user from your Outbrain Engage account. Use this template when you need to retrieve information about publishers, including publisher IDs, names, and configurations.

  • This endpoint automatically retrieves all publishers associated with the current user. No additional configuration is required beyond selecting this endpoint template.

This endpoint retrieves all publishers associated with the current user from your Outbrain Engage account, including publisher IDs, names, and other publisher metadata. Use this endpoint to discover which publishers are available in your Outbrain Engage account before using them with other Outbrain Engage endpoints.

For detailed information about publisher management, API response structures, and available publisher data, see the Outbrain Engage API documentation.

Get Report for a Publisher/Group

This endpoint template retrieves metrics for a publisher or group at a daily granularity from your Outbrain Engage account. Use this template when you need to retrieve performance metrics, including impressions, clicks, revenue, and other engagement metrics for a specific publisher or group. See API documents for other breakdowns available.

  • Enter the entity ID in the Entity ID field. This should be the publisher or group ID for this report. Please contact your Outbrain account manager and ask for your external ID for publisher or group. The entity ID determines which publisher or group's metrics will be retrieved.
  • Enter the start date in the Start Date (yyyyMMdd) field. This should be the start day for the report (e.g., 20240101). You can use Nexla date-time macros like {now}, {now - 1}, etc. The start date determines the beginning of the date range for which metrics will be retrieved.
  • Enter the end date in the End Date (yyyyMMdd) field. This should be the end day for the report (e.g., 20240131). You can use Nexla date-time macros like {now}, {now - 1}, etc. The end date determines the end of the date range for which metrics will be retrieved.

This endpoint retrieves metrics for a publisher or group at a daily granularity from your Outbrain Engage account. The endpoint uses offset-based pagination with limit and offset parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the offset. The endpoint returns up to 1000 items per page by default.

The report metrics include daily performance data such as impressions, clicks, revenue, and other engagement metrics. The API documents provide information about other breakdowns available beyond daily granularity. For detailed information about reporting, API response structures, pagination, and available metrics, see the Outbrain Engage API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Outbrain Engage data sources can also be manually configured to ingest data from any valid Outbrain Engage API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom query parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

The Outbrain Engage API typically uses the GET method for retrieving data from endpoints, and uses offset-based pagination with limit and offset for most endpoints. For the Response Data Path, use $.publishers[*] to extract all publishers from the publishers array, or $.items[*] to extract all items from the items array, depending on your endpoint.

Once all of the relevant settings have been configured, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.