Skip to main content

Totango Data Source

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

Totango

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

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

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

    Search Accounts

    This endpoint template allows you to query Totango's online database for accounts that fit certain search criteria (e.g., "all paying customers who were active in the last 90 days"). Use this template when you need to search for accounts based on specific criteria for analysis, reporting, or integration purposes.

    • Enter the Query in the Query field. This should be a JSON object containing the search criteria and the account fields you'd like returned. The Query determines which accounts will be retrieved and which fields will be included in the response. The query should include terms for filtering accounts, count and offset for pagination, fields to return, sort options, and scope. A default query is provided that searches for paying customers and returns health information and success manager details.

    This endpoint allows you to search for accounts using complex criteria and return specific fields for each matching account. The query uses JSON format with terms for filtering, pagination parameters, field selections, and sorting options.

    For detailed information about account search queries, API response structures, and available search criteria, see the Totango Search API documentation.

    Retrieve events per account

    This endpoint template retrieves all events registered on the timeline of a specific account from your Totango account. Use this template when you need to access event history, activity logs, or timeline data for a particular account for analysis, reporting, or integration purposes.

    • Enter the Account ID in the Account ID field. This should be the unique identifier of the account whose events you want to retrieve. The Account ID determines which account's events will be retrieved. You can find the Account ID by using the "Search Accounts" endpoint or from your Totango account dashboard.

    This endpoint returns all events registered on the timeline of the specified account, including event types, timestamps, and event details. The Account ID can be found by using the "Search Accounts" endpoint or from your Totango account dashboard.

    For detailed information about events, API response structures, and available event data, see the Totango Touchpoints API documentation.

    Search for users

    This endpoint template allows you to query Totango's online database for users that fit certain search criteria. You can specify which data fields you'd like Totango to return for every user that fits the criteria. Use this template when you need to search for users based on specific criteria for analysis, reporting, or integration purposes.

    • Enter the Query in the Query field. This should be a JSON object containing the search criteria and the user fields you'd like returned. The Query determines which users will be retrieved and which fields will be included in the response. The query should include terms for filtering users, count and offset for pagination, fields to return, and scope. A default query is provided that searches for users in paying accounts and returns last activity time and activity counts.

    This endpoint allows you to search for users using complex criteria and return specific fields for each matching user. The query uses JSON format with terms for filtering, pagination parameters, field selections, and scope options.

    For detailed information about user search queries, API response structures, and available search criteria, see the Totango Search 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​

Totango data sources can be manually configured to ingest data from any valid Totango 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 Totango 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 Totango API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most common for Totango data sources)
    • POST: For sending data to the API or triggering actions

API Endpoint URL​

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

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.

Path to Data​

If only a subset of the data that will be returned by 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 API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of accounts, the API will typically return an array of account records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Totango 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., $.response.accounts.hits[*] to access an array of accounts within a response object).

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

    Path to Data Example:

    If the Totango API response is in JSON format and includes a nested array named hits within a response.accounts object that contains the relevant data, the path to the response would be entered as $.response.accounts.hits[*].

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

Endpoint Testing (Manual Configuration)​

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 & 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 Totango 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.