Skip to main content

ChartMogul Data Source

The ChartMogul connector enables you to ingest subscription analytics and revenue data — including customers, subscriptions, invoices, plans, and SaaS metrics — from your ChartMogul account into Nexla. Follow the instructions below to create a new data flow that ingests data from a ChartMogul source in Nexla.
chartmogul_api.png

ChartMogul

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

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

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

    This endpoint retrieves a list of all customers in the ChartMogul account. Use it to export customer records for CRM sync, churn analysis, or downstream reporting.

    • Sends a GET request to https://api.chartmogul.com/v1/customers. No additional path parameters are required.
    • Response data is extracted from $.entries[*] — each entry in the array is treated as one customer record. ChartMogul paginates results using page and per_page query parameters (maximum 200 per page).

    Use the status query parameter to filter by customer status (e.g., ?status=Active). Customers with a status of Cancelled are still returned unless filtered out.

    List Activities

    This endpoint returns a list of subscription activities across all customers in the ChartMogul account, including new subscriptions, upgrades, downgrades, churn events, and reactivations. Use it to build activity timelines or feed MRR movement analysis.

    • Sends a GET request to https://api.chartmogul.com/v1/activities.
    • Response data is extracted from $.entries[*]. Results are paginated; use the cursor parameter for cursor-based pagination when the full activity history is large.

    Filter activities by date using the start-date and end-date query parameters (format: YYYY-MM-DD). This is recommended for incremental pulls to avoid re-ingesting the full activity history on each run.

    Get Daily Customer Count

    This endpoint returns daily customer count metrics for the ChartMogul account over a specified time period. Use it to track day-over-day growth or churn trends.

    The start-date and end-date query parameters are required for all ChartMogul metrics endpoints. Use date/time macros (e.g., `{now-30}` with a Day time unit) to automate rolling date window ingestion.

    Get Weekly Customer Count

    This endpoint returns weekly customer count metrics for the ChartMogul account over a specified time period. Use it for weekly reporting dashboards or trend analysis.

    The start-date and end-date query parameters are required. Dates must be in YYYY-MM-DD format.

    Get Monthly Customer Count

    This endpoint returns monthly customer count metrics for the ChartMogul account. Use it for monthly business reviews, investor reporting, or MoM growth calculations.

    The start-date and end-date query parameters are required. Dates must be in YYYY-MM-DD format.

    Get Quarterly Customer Count

    This endpoint returns quarterly customer count metrics for the ChartMogul account. Use it for QoQ analysis, board reporting, or aligning SaaS metrics with fiscal quarters.

    The start-date and end-date query parameters are required. Dates must be in YYYY-MM-DD format.

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​

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

API Method​

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

  2. Select the method that will be used for calls to the ChartMogul API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API — used for reading customers, metrics, subscriptions, invoices, and plans
    • POST: For sending data to the API or triggering actions

API Endpoint URL​

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

    The ChartMogul REST API base URL is https://api.chartmogul.com/v1. Common endpoint paths include:

    • https://api.chartmogul.com/v1/customers — Retrieve customer records
    • https://api.chartmogul.com/v1/customers/{uuid}/subscriptions — Retrieve subscriptions for a specific customer
    • https://api.chartmogul.com/v1/customers/{uuid}/invoices — Retrieve invoices for a specific customer
    • https://api.chartmogul.com/v1/metrics/all — Retrieve all key SaaS metrics (MRR, ARR, ARPA, churn, LTV)
    • https://api.chartmogul.com/v1/metrics/mrr — Retrieve Monthly Recurring Revenue data
    • https://api.chartmogul.com/v1/plans — Retrieve subscription plan definitions
    • https://api.chartmogul.com/v1/data_sources — Retrieve configured data sources

ChartMogul paginates most list endpoints using page and per_page query parameters. For example, append ?page=1&per_page=200 to retrieve up to 200 records per page. The maximum per_page value is 200. Use the has_more field in the response to determine whether additional pages are available.

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.

Date/time macros are particularly useful for ChartMogul's metrics endpoints, which accept start-date and end-date query parameters (e.g., https://api.chartmogul.com/v1/metrics/mrr?start-date={'{start_date}'}&end-date={'{end_date}'}), as well as for customer and subscription endpoints that support updated_after filters.

  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-30) to indicate the datetime thirty 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}. ChartMogul's metrics endpoints accept dates in YYYY-MM-DD format.

  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 when building ChartMogul sources that need to iterate over customer UUIDs or data source UUIDs retrieved from a prior data flow — for example, fetching invoice details for each customer by referencing a lookup of customer UUIDs.

  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 that will be returned by the ChartMogul 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.

For example, ChartMogul list endpoints return records in a named array within a JSON object. The customers endpoint returns {"entries": [...], "has_more": true, "per_page": 200, "page": 1, "total_pages": 5} — by specifying the path to the entries array, Nexla will treat each customer record as an individual row.

Path to Data is essential for ChartMogul responses, which consistently wrap record arrays in a named field. Without specifying the correct path, Nexla will treat the entire JSON response object (including pagination metadata) as a single record rather than parsing individual entries.

  • 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 the customers endpoint: enter $.entries[*]
    • For the invoices endpoint: enter $.customer_invoices[*] or $.entries[*] depending on the endpoint variant
    • For the metrics endpoints: enter $.entries[*] for time-series data
    • For the plans endpoint: enter $.plans[*]
    • 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., $.entries[*] to access an array of entries within the root response object).
    Path to Data Example:

    For the ChartMogul customers endpoint (https://api.chartmogul.com/v1/customers), the response contains a top-level array named entries that holds the customer records. Enter $.entries[*] as the path to data to have Nexla treat each customer as an individual record.

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

For example, ChartMogul list endpoint responses include pagination metadata (has_more, total_pages, page, per_page) alongside the records array. Specifying the path to this metadata will include it as common fields on each record, which can be useful for tracking pagination context.

Metadata paths are particularly useful for preserving ChartMogul response context such as total page counts, current page numbers, or summary statistics that apply across 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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header — it is handled automatically by Nexla using the API key from your ChartMogul credential. Common headers like Content-Type and Accept are also handled automatically.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. 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 and 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.

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