Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an Outbrain Amplify source in Nexla.
outbrain_amplify_api.png

Outbrain Amplify

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Outbrain Amplify connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Outbrain Amplify account, and click Next; or, create a new Outbrain Amplify credential for use in this flow.

  3. In Nexla, Outbrain Amplify data sources can be created using pre-built endpoint templates, which expedite source setup for common Outbrain Amplify endpoints. Each template is designed specifically for the corresponding Outbrain Amplify endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Outbrain Amplify sources can also be configured manually, allowing you to ingest data from Outbrain Amplify endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Outbrain Amplify endpoints. Each template is designed specifically for the corresponding Outbrain Amplify endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch Marketers

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

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

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

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

    Fetch Campaigns for a Marketer

    This endpoint template retrieves all campaigns for a specific marketer from your Outbrain Amplify account. Use this template when you need to retrieve information about campaigns, including campaign IDs, names, and configurations for a specific marketer.

    • Enter the marketer ID in the Marketer ID field. This should be the unique identifier of the marketer whose campaigns you wish to fetch. The marketer ID determines which marketer's campaigns will be retrieved. You can find the marketer ID by using the "Fetch Marketers" endpoint.

    This endpoint retrieves all campaigns for a specific marketer from your Outbrain Amplify 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 10 campaigns per page by default.

    For detailed information about campaign management, API response structures, pagination, and available campaign data, see the Outbrain Amplify API documentation.

    Fetch Campaigns with Performance Stats

    This endpoint template retrieves all campaigns and campaign performance statistics for a specific marketer from your Outbrain Amplify account. Use this template when you need to retrieve campaign data along with performance metrics, including impressions, clicks, conversions, and other performance statistics.

    • Enter the marketer ID in the Marketer ID field. This should be the unique identifier of the marketer whose campaign stats you wish to fetch. The marketer ID determines which marketer's campaign performance statistics will be retrieved.
    • Enter the start date in the Start Date (YYYY-MM-dd) field. This should be the start day for performance stats (e.g., 2024-01-01). You can use Nexla date-time macros like {now}, {now - 1}, etc. The start date determines the beginning of the date range for which performance statistics will be retrieved.
    • Enter the end date in the End Date (YYYY-MM-dd) field. This should be the end day for performance stats (e.g., 2024-01-31). You can use Nexla date-time macros like {now}, {now - 1}, etc. The end date determines the end of the date range for which performance statistics will be retrieved.

    This endpoint retrieves all campaigns and campaign performance statistics for a specific marketer from your Outbrain Amplify 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 10 campaigns per page by default.

    The performance statistics include metrics such as impressions, clicks, conversions, spend, and other campaign performance data. For detailed information about performance reporting, API response structures, pagination, and available performance metrics, see the Outbrain Amplify API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Outbrain Amplify data sources can be manually configured to ingest data from any valid Outbrain Amplify API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Outbrain Amplify sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Outbrain Amplify API from the Method pulldown menu. Outbrain Amplify API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Outbrain Amplify API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including your API server URL (from your credential), the API path (e.g., /marketers, /marketers/{marketer_id}/campaigns), and any required query parameters. Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Outbrain Amplify API uses offset-based pagination with limit and offset for some endpoints. The endpoint URL should include your API server URL and the appropriate API path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Outbrain Amplify API responses, use $.marketers[*] to extract all marketers from the marketers array, or $.campaigns[*] to extract all campaigns from the campaigns array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Outbrain Amplify API response. Outbrain Amplify API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Outbrain Amplify API uses offset-based pagination with limit and offset for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For offset-based pagination, specify the page size parameter name (limit), the starting offset value (0), and the offset parameter name (offset).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, 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.