Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Campaigner source in Nexla.
campaigner_api.png

Campaigner

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 Campaigner connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Campaigner instance, and click Next; or, create a new Campaigner credential for use in this flow.

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

    Campaigner sources can also be configured manually, allowing you to ingest data from Campaigner 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 Campaigner endpoints. Each template is designed specifically for the corresponding Campaigner 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.

    Get Sources

    This endpoint retrieves a list of Source objects from your Campaigner account. Use this endpoint when you need to access source information for data import, contact management, or source analysis.

    • This endpoint automatically retrieves all sources from your Campaigner account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://edapi.campaigner.com/v1/Sources. The endpoint URL is automatically constructed based on the Campaigner API base URL.
    • The endpoint does not use pagination and returns all sources in a single request.
    • The endpoint will return all sources in your account. The response data is extracted from the Sources array in the API response ($.Sources[*]), with each source record processed individually.

    The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.Sources[*], which extracts all items from the Sources array in the API response. For detailed information about retrieving sources, see the Campaigner API documentation.

    All Campaigns

    This endpoint allows you to page through all campaigns regardless of their status, including deleted campaigns. Use this endpoint when you need to access comprehensive campaign information for analysis, reporting, or campaign management.

    • This endpoint automatically retrieves all campaigns from your Campaigner account, including deleted campaigns. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://edapi.campaigner.com/v1/Campaigns/All. The endpoint URL is automatically constructed based on the Campaigner API base URL.
    • The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the PageNumber and PageSize query parameters. The endpoint starts from page 1 and continues fetching pages until all available campaigns have been retrieved. By default, the endpoint retrieves up to 100 items per page.
    • The endpoint will return all campaigns in your account, including deleted campaigns. The response data is extracted from the Items array in the API response ($.Items[*]), with each campaign record processed individually.

    This endpoint supports pagination through PageNumber and PageSize query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.Items[*], which extracts all items from the Items array in the API response. This endpoint includes all campaigns regardless of status, including deleted campaigns. For detailed information about retrieving campaigns, see the Campaigner 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​

Campaigner data sources can be manually configured to ingest data from any valid Campaigner REST 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 Campaigner sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

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 Campaigner API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Campaigner API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Campaigner API endpoints typically follow the pattern https://edapi.campaigner.com/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires API key authentication in the ApiKey header, which is handled automatically by your credential configuration. For detailed information about Campaigner API endpoints and available APIs, see the Campaigner REST API documentation.

Path to Data​

  1. Enter the JSON path that identifies the location of the relevant data within the API response in the Path to Data field. JSON paths use dot notation to navigate through nested JSON structures.

    • For example, if your API response has the structure {"Sources": [...]}, you would enter $.Sources[*] to extract all items from the Sources array.
    • Use $[*] to extract all items from a root-level array.
    • Use $ to extract the entire root-level object.

JSON paths are case-sensitive and must match the exact structure of your API response. Campaigner API responses may use different array names like Sources or Items depending on the endpoint. Use the Test button to verify that your JSON path correctly extracts the desired data from the API response.

Save the Data Source​

  1. Once all configuration steps have been completed, click the Save button to save your data source configuration.

  2. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.