Skip to main content

CallRail Data Source

The CallRail connector enables you to ingest call tracking and analytics data — including calls, text messages, form submissions, companies, tracking numbers, and account information — from your CallRail account into Nexla. This connector is particularly useful for marketing analytics pipelines that need to combine CallRail attribution data with CRM records, advertising spend data, or business intelligence tools.

The CallRail connector enables you to ingest call tracking and lead analytics data from your CallRail account into Nexla. Follow the instructions below to create a new data flow that ingests data from a CallRail source in Nexla.
call_rail_api.png

CallRail

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

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

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

    Returns a list of all calls for the account. Use this endpoint to ingest call tracking records — including caller details, duration, tracking number, and attribution data — for marketing analytics and reporting.

    Supports date-range filtering via start_date and end_date query parameters. Use date/time macros to implement incremental ingestion and avoid pulling the full call history on every run.

    List Text Messages

    Returns a list of all text message conversations for the account. Use this endpoint to ingest SMS lead interactions from CallRail for multi-channel marketing analysis.

    Text message records include conversation threads, timestamps, and tracking number attribution. Pagination is supported via page and per_page query parameters.

    List Users

    Returns a list of all users in the account. Use this endpoint to retrieve CallRail user records for access auditing or associating call activity with specific team members.

    User records include name, email, role, and account association. This endpoint returns users across all companies in the account.

    List Companies

    Returns a list of all companies associated with the account. Use this endpoint to retrieve the companies configured in your CallRail account, which are used to organize tracking numbers and calls.

    Company records include company name, time zone, and associated tracking settings. Company IDs from this endpoint can be used with lookup-based macros to scope other endpoints (such as calls) to a specific company.

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​

CallRail sources can also be configured manually, allowing you to ingest data from any valid CallRail API v3 endpoint. Configuration options available for CallRail sources allow them to be fully customized to suit any use case — including filtering calls by date range, retrieving data from specific companies within your account, or applying field selection to reduce payload size.

First, select the HTTP method that will be used for calls to the CallRail API from the Method pulldown menu. For retrieving data from CallRail, use GET. The CallRail API v3 base URL is https://api.callrail.com/v3/, and all data retrieval endpoints use the GET method.

API Endpoint URL​

  1. Enter the URL of the CallRail API v3 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 CallRail API v3 endpoints include:

    • List calls: https://api.callrail.com/v3/a/{'{account_id}'}/calls.json — Returns a paginated list of all calls in the specified account, with support for filtering by date, duration, direction, and more.

    • List companies: https://api.callrail.com/v3/a/{'{account_id}'}/companies.json — Returns a list of all companies within the specified CallRail account.

    • List tracking numbers: https://api.callrail.com/v3/a/{'{account_id}'}/trackers.json — Returns all tracking numbers (trackers) configured within the account.

    • List text messages: https://api.callrail.com/v3/a/{'{account_id}'}/text-messages.json — Returns a paginated list of text message conversations.

    • List form submissions: https://api.callrail.com/v3/a/{'{account_id}'}/form-submissions.json — Returns form submission records tracked by CallRail.

    • List accounts: https://api.callrail.com/v3/a.json — Returns all accounts accessible by the authenticated API key.

    Replace {'{account_id}'} with your CallRail account ID, which can be found in your CallRail account settings or retrieved via the /v3/a.json accounts endpoint.

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. For a complete reference of all available CallRail API v3 endpoints and their query parameters, refer to the CallRail API v3 documentation.

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.

The CallRail API supports date-range filtering via query parameters such as start_date and end_date on the calls endpoint. Using Nexla's date/time macros within these parameters enables incremental data ingestion runs that automatically pull only the calls that occurred since the last run.

Macros are particularly useful for CallRail calls endpoints, which can return large volumes of data. Using start_date and end_date query parameters with date macros allows you to fetch only the records from a specific rolling time window rather than pulling all historical data on every run.

  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-7)` to indicate the datetime seven 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 CallRail sources that need to iterate over a list of account IDs or company IDs retrieved from a previous Nexla source, enabling you to pull data for each entity without hardcoding IDs into 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 CallRail API endpoint is needed, you can designate the part of the response that should be included in the Nexsets produced from this source by specifying the path to the relevant data. This is particularly useful because most CallRail list endpoints return a JSON object that wraps the actual records array inside a named property along with pagination metadata.

For example, the CallRail /calls.json endpoint returns a response where the array of call records is nested under the calls key, alongside pagination fields like total_records, total_pages, and page. By specifying $.calls[*] as the path to data, you instruct Nexla to treat each element of the calls array as an individual record rather than the entire response object.

Path to Data is essential for CallRail API responses, which consistently wrap record arrays inside named JSON properties. Without specifying the correct path, Nexla may treat the entire response object — including pagination metadata — as a single record rather than expanding the array of call or company 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., $.calls[*] to access the calls array, $.companies[*] for the companies array, or $.trackers[*] for the tracking numbers array).
    Path to Data Examples for CallRail endpoints:
    • Calls endpoint (/calls.json): enter $.calls[*]
    • Companies endpoint (/companies.json): enter $.companies[*]
    • Trackers endpoint (/trackers.json): enter $.trackers[*]
    • Text messages endpoint (/text-messages.json): enter $.text_messages[*]
    • Form submissions endpoint (/form-submissions.json): enter $.form_submissions[*]
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 is not part of the main data array.

For example, the CallRail /calls.json response includes pagination fields (total_records, total_pages, page) at the top level of the JSON object. If you have specified $.calls[*] as the path to relevant data, you can additionally specify $.total_records or other top-level fields as metadata paths to attach that context to each call record in the generated Nexset.

Metadata paths are particularly useful for preserving CallRail API response context like total record counts or request timestamps that apply to all records in a paginated 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 CallRail responses in JSON format, enter the JSON path to the object or value that contains the metadata (e.g., $.total_records to include the total record count with each call record).

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). For the CallRail API, this may be useful for specifying response format preferences or API versioning headers when required.

    You do not need to include the Authorization header — Nexla automatically adds the authentication token from your saved credential to every request. Common headers like Authorization and Content-Type are handled automatically based on your credential configuration.

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 CallRail 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.