Amperity Data Source

The Amperity connector enables you to ingest customer data, campaign information, segment definitions, profile indexes, audit events, and workflow details from your Amperity tenant. Follow the instructions below to create a new data flow that ingests data from an Amperity source in Nexla.

Amperity

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

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

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

This endpoint retrieves a list of campaigns from your Amperity tenant. Use this endpoint when you need to audit active campaigns, sync campaign metadata to downstream systems, or analyze your campaign portfolio. Amperity campaigns represent audiences and their associated delivery configurations for downstream activation.

• This endpoint automatically returns all campaigns accessible within your tenant. No additional parameters are required to retrieve the full list of campaigns.
• Each campaign record includes details such as the campaign name, associated destination, launch schedule, and the segment used to define the audience.
• The Amperity API paginates results. Nexla handles pagination automatically, fetching all pages until the complete list is retrieved.

For additional information about campaigns in Amperity, refer to the Amperity GET /campaigns documentation.

List Campaign Drafts

This endpoint retrieves a list of draft campaigns from your Amperity tenant. Use this endpoint when you need to review campaigns that are in progress but have not yet been published or launched.

• This endpoint returns all draft campaigns in your tenant, including campaigns that are in the planning or review stage. No additional parameters are required.
• Draft campaigns contain the same metadata fields as published campaigns, allowing you to track campaign development over time or compare drafts to published versions.

For additional information about campaign drafts in Amperity, refer to the Amperity GET /campaign-drafts documentation.

List Segments

This endpoint retrieves a list of audience segments defined in your Amperity tenant. Use this endpoint to catalog your segment library, sync segment metadata to external BI tools, or audit segment definitions for governance purposes.

• This endpoint returns all segments available in your tenant, including the segment name, description, and unique identifier. No additional parameters are required to retrieve the full segment list.
• Segment IDs returned by this endpoint can be used in other workflows to reference specific segments when working with campaign configurations or profile data.
• The Amperity API paginates results. Nexla handles pagination automatically, fetching all pages until the complete segment list is retrieved.

For additional information about segments in Amperity, refer to the Amperity GET /segments documentation.

List Profile Indexes

This endpoint retrieves a list of customer profile indexes available in your Amperity tenant. Profile indexes are collections of customer profile attributes that can be queried via the Amperity Profile API. Use this endpoint to discover available indexes before retrieving customer profiles.

• This endpoint returns all profile indexes configured in your tenant, including the index name, ID, and associated attributes. No additional parameters are required.
• The index IDs returned by this endpoint are required when using the List Profiles or Get Profile endpoints to retrieve actual customer profile records.

For additional information about profile indexes in Amperity, refer to the Amperity GET /indexes documentation.

List Profiles

This endpoint retrieves a paginated list of customer profiles from a specific profile index in your Amperity tenant. Use this endpoint to extract unified customer records for downstream analytics, personalization engines, or data warehouse ingestion.

• Enter the unique identifier of the profile index from which customer profiles will be retrieved in the Index ID field. Index IDs can be obtained by first using the List Profile Indexes endpoint template.

• Each profile record returned contains all customer attributes included in the specified index, such as name, email, phone number, purchase history, and any other attributes configured in your Amperity Customer 360 table.
• The Amperity Profile API paginates results. Nexla handles pagination automatically, fetching all pages until the complete profile list is retrieved.

The attributes returned for each profile depend on the attributes configured in the specified index. For additional information, refer to the Amperity GET /indexes/{id}/profiles documentation.

Get Profile

This endpoint retrieves a single customer profile from a specific profile index using a profile ID. Use this endpoint when you need to look up or refresh data for a specific, known customer record.

• Enter the unique identifier of the profile index in the Index ID field. Index IDs can be obtained by first using the List Profile Indexes endpoint template.
• Enter the unique identifier of the specific customer profile to retrieve in the Profile ID field. Profile IDs can be obtained from the results of the List Profiles endpoint.
• This endpoint returns a single customer record containing all attributes defined in the specified index.

For additional information about retrieving individual profiles, refer to the Amperity GET /indexes/{id}/profiles/{id} documentation.

List Ingest Jobs

This endpoint retrieves a list of ingest jobs from your Amperity tenant. Use this endpoint to monitor data ingestion activity, audit job history, or track the status of data loads into Amperity.

• This endpoint returns all ingest jobs in your tenant, including job names, statuses, and timestamps. No additional parameters are required to retrieve the job list.
• Ingest job records include details about the data source, job state (e.g., running, completed, failed), and timing information, which can be useful for operational monitoring and alerting workflows.

List Workflows

This endpoint retrieves a list of workflows from your Amperity tenant. Use this endpoint to monitor the state of Amperity workflows, audit workflow execution history, or build operational dashboards that track data processing activity.

• This endpoint returns workflows including their names, statuses, and run details. No additional parameters are required to retrieve the full workflow list.
• Workflow records contain information about the workflow state, execution timing, and any associated errors, enabling you to detect failures or delays in your Amperity data processing pipelines.
• The Amperity API paginates results. Nexla handles pagination automatically, fetching all pages until the complete workflow list is retrieved.

List Audit Events

This endpoint retrieves a log of audit events from your Amperity tenant, capturing user activity and system actions. Use this endpoint for security auditing, compliance reporting, or tracking changes made within the Amperity platform.

• This endpoint returns up to 1,000 audit events per request, covering user activity such as logins, configuration changes, and API key operations. No additional parameters are required to retrieve the default audit event log.
• Audit event records include the event type, the user or system that triggered the event, the timestamp, and contextual details about the action performed.

Audit events are limited to the most recent 1,000 events per API response. For compliance or long-term audit purposes, schedule regular ingestion runs to capture events over time before they age out of the available log.

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

Amperity data sources can be manually configured to ingest data from any valid Amperity 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 Amperity sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that apply custom request parameters beyond what the templates expose.

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 Amperity API from the Method pulldown menu. For most Amperity read operations, select GET. The supported methods include:

   • GET: For retrieving data from the Amperity API (campaigns, segments, profiles, workflows, etc.)
   • POST: For creating resources or triggering actions, such as starting a workflow run

API Endpoint URL

3. Enter the URL of the Amperity API endpoint from which this source will fetch data in the Set API URL field. All Amperity API endpoint URLs follow the format https://{tenant-id}.amperity.com/api/{endpoint-path}, where {tenant-id} is your Amperity tenant ID. For example:
   • List campaigns: https://your-tenant.amperity.com/api/campaigns
   • List segments: https://your-tenant.amperity.com/api/segments
   • List profiles for an index: https://your-tenant.amperity.com/api/indexes/{index-id}/profiles

Ensure the API endpoint URL uses your specific tenant ID. Your tenant ID is the subdomain of your Amperity instance and can also be found by navigating to Settings > Security > API keys and selecting Copy tenant ID from the row menu of any API key. For the complete list of available Amperity API endpoints, refer to the Amperity API Endpoints 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.

Date/time macros are particularly useful when querying Amperity API endpoints that support date-range filtering, such as workflow run history queries that accept a start and end date in the URL.

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 particularly useful for Amperity endpoints that require an ID parameter in the URL path, such as profile index IDs or specific resource IDs retrieved in an earlier step of a multi-source workflow.

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 Amperity 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 Amperity API responses contain metadata, pagination tokens, or other context that you don't need for your analysis.

For example, many Amperity API list endpoints return an array of records nested under a data key in the JSON response body. By entering the path to that array, you can configure Nexla to treat each element of the returned array as an individual record.

Path to Data is essential when Amperity 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., $.data[*] to access an array of records within a data object in the response).
  Path to Data Example:

  For most Amperity list endpoints, the response body is a JSON object with a top-level data array containing the records. Enter $.data[*] as the path to configure Nexla to treat each element in the data array as a separate 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 & 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.

  

Metadata

If metadata is included in the Amperity API 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 contextual information — such as pagination tokens, total record counts, or request timestamps — that applies to all records in the response but is not part of the main data array.

Metadata paths are particularly useful for preserving Amperity API response context like the next_page cursor token, which can be valuable for tracking paginated result sets.

• 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 & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). The Amperity API requires the Amperity-Tenant header to be present on all requests; this header is handled automatically by the Amperity credential configuration. Additional headers may be needed for specific endpoints or use cases.

  You do not need to include the Authorization or Amperity-Tenant headers here — those are automatically managed by Nexla using the values from your Amperity credential configuration.

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