Skip to main content

Campaign Monitor Data Source

The Campaign Monitor connector enables you to ingest data from your Campaign Monitor account, including subscriber lists, campaign performance metrics, client details, and more. Follow the instructions below to create a new data flow that ingests data from a Campaign Monitor source in Nexla.
campaign_monitor_api.png

Campaign Monitor

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

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

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

    List Clients

    Returns a list of all clients associated with the authenticated account. Use this endpoint to retrieve the top-level client records in your Campaign Monitor agency account.

    Client IDs returned by this endpoint are required for most other endpoints that scope data to a specific client (e.g., subscriber lists, campaigns, and segments).

    List Admins

    Returns a list of all administrators for the authenticated account. Use this endpoint to audit admin users and their access levels within your Campaign Monitor account.

    Admin records include name, email address, and account access details.

    Get Client Details

    Retrieves detailed information about a specific client. Use this endpoint to fetch comprehensive configuration and billing details for a Campaign Monitor client account.

    Your Client ID is available in your Campaign Monitor account under Account Settings, or can be retrieved using the List Clients endpoint.

    List Client Segments

    Returns a list of all segments for a specific client. Use this endpoint to retrieve audience segments defined within a Campaign Monitor client account.

    Segment records include segment name, list ID, and the rules used to define segment membership.

    List Client Templates

    Returns a list of all templates for a specific client. Use this endpoint to retrieve email template records associated with a Campaign Monitor client.

    Template records include name, preview URL, and creation date.

    List Client People

    Returns a list of all people (team members) associated with a specific client. Use this endpoint to retrieve the users who have access to a Campaign Monitor client account.

    People records include name, email, and access level for each team member associated with the client.

    List Client Tags

    Returns a list of all tags configured for a specific client. Use this endpoint to retrieve the tag taxonomy used to organize campaigns within a Campaign Monitor client account.

    Tags are used in Campaign Monitor to categorize and filter campaigns. Tag records include name and associated campaign counts.

    List Subscriber Lists

    Returns a list of all subscriber lists for a specific client. Use this endpoint to retrieve the mailing lists defined within a Campaign Monitor client account.

    List records include name, list ID, and subscriber counts. List IDs returned here are required to query subscriber-level endpoints such as active subscribers.

    List Suppression Lists

    Returns a list of all suppression lists (unsubscribed and bounced subscribers) for a specific client. Use this endpoint to identify contacts who should not receive future campaigns.

    Suppression list records include email address, suppression reason (unsubscribe, bounce, or spam complaint), and the date the address was suppressed.

    List Sent Campaigns

    Returns a list of all campaigns that have been sent for a specific client. Use this endpoint to retrieve historical sent campaign records for performance analysis and reporting.

    Sent campaign records include campaign name, send date, subject line, and the lists to which the campaign was sent. Campaign IDs from this endpoint can be used to query detailed campaign statistics.

    List Draft Campaigns

    Returns a list of draft campaigns for the client. Use this endpoint to retrieve campaigns that have been created but not yet sent or scheduled.

    Draft campaign records include campaign name, subject line, and creation date.

    List Scheduled Campaigns

    Returns a list of scheduled campaigns for the client. Use this endpoint to retrieve campaigns that have been configured to send at a future date and time.

    Scheduled campaign records include campaign name, subject line, and the scheduled send date and time.

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​

Campaign Monitor sources can also be configured manually, allowing you to ingest data from any valid Campaign Monitor API endpoint. The Campaign Monitor REST API (v3.3) is available at https://api.createsend.com/api/v3.3 and supports both JSON and XML response formats. Configuration options available for Campaign Monitor sources allow them to be fully customized to suit any use case — including using chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

First, select the method that will be used for calls to the Campaign Monitor API from the Method pulldown menu. The most common methods are:

  • GET: For retrieving data from the API — used for the vast majority of Campaign Monitor data retrieval operations such as fetching subscribers, campaign statistics, and list details.

  • POST: For sending data to the API or triggering actions — used when querying endpoints that require a request body.

API Endpoint URL​

  1. Enter the URL of the Campaign Monitor 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.

    Common Campaign Monitor API endpoint URL patterns include:

    • Subscriber Lists: https://api.createsend.com/api/v3.3/clients/{'{clientID}'}/lists.json — retrieves all subscriber lists for a client.

    • Subscribers in a List: https://api.createsend.com/api/v3.3/lists/{'{listID}'}/active.json — retrieves active subscribers from a specific list.

    • Campaign Recipients: https://api.createsend.com/api/v3.3/campaigns/{'{campaignID}'}/recipients.json — retrieves all recipients of a campaign.

    • Campaign Summary: https://api.createsend.com/api/v3.3/campaigns/{'{campaignID}'}/summary.json — retrieves a summary of campaign performance metrics.

    • Client Details: https://api.createsend.com/api/v3.3/clients/{'{clientID}'}.json — retrieves details for a specific client.

Your Client ID is available in your Campaign Monitor account under Account Settings. Your List ID and Campaign ID can be found in the URL when viewing the corresponding list or campaign in the Campaign Monitor dashboard, or retrieved programmatically using the API. For a complete list of available endpoints, see the Campaign Monitor API Reference.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for Campaign Monitor endpoints that support date filtering, such as endpoints that accept date query parameters to retrieve subscribers or campaign activity within a specific time window.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for Campaign Monitor sources when you need to pass Client IDs, List IDs, or Campaign IDs dynamically from another Nexla data source rather than hardcoding them in the URL.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when Campaign Monitor API responses contain metadata, pagination information, or wrapper objects that you don't need for your analysis.

For example, the Campaign Monitor API typically wraps results in a top-level object — for instance, the active subscribers endpoint returns a response where the subscriber records are nested inside a Results array. By entering the path to the relevant data, you can configure Nexla to treat each element of that array as a record.

Path to Data is essential when Campaign Monitor API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.Results[*] to access the Results array in a Campaign Monitor subscriber response).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    For a Campaign Monitor active subscribers endpoint response in JSON format, the subscriber records are typically contained in a top-level Results array. Enter $.Results[*] as the path to treat each subscriber record as a separate row in the Nexset.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, Campaign Monitor paged responses include pagination details such as TotalNumberOfRecords, PageNumber, and RecordsOnThisPage alongside the Results array. If you have specified $.Results[*] as the path to relevant data, you can specify the pagination metadata path to include that context with each record.

Metadata paths are particularly useful for preserving Campaign Monitor response context like total record counts, page numbers, or request timestamps that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The Campaign Monitor API accepts both JSON (application/json) and XML (application/xml) content types, which Nexla handles automatically.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Campaign Monitor data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.