Amperity

Amperity is an AI-powered Customer Data Cloud that unifies fragmented customer data into comprehensive, trusted profiles using patented identity resolution technology. The platform ingests data from CRM systems, email platforms, transaction databases, and dozens of other sources, then resolves identities across those records to build a single, accurate view of each customer. Marketers and data teams use Amperity to power personalized experiences, build precise audience segments, run campaigns, and deliver customer intelligence across every channel. The Amperity API provides programmatic access to campaigns, segments, customer profile indexes, ingest jobs, audit events, and workflow management within your Amperity tenant.

Power end-to-end data operations for your Amperity API with Nexla. Our bi-directional Amperity connector is purpose-built for Amperity, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Amperity or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Amperity workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

To connect Nexla to Amperity, you need an Amperity tenant with API access enabled, and a user account that has been assigned the Allow API key administration policy. This policy is required to create and manage API keys and generate the access tokens used for authentication.

The Amperity API uses JSON Web Token (JWT) access tokens for authentication. These tokens are issued from API keys that are managed directly within the Amperity user interface. Each API key is a synthetic identity bound to your tenant that grants programmatic access to the Amperity API.

API requests are authenticated by including the access token as a Bearer token in the Authorization request header, along with your tenant ID in the Amperity-Tenant header.

Obtain your tenant ID. Your tenant ID is a unique identifier for your Amperity instance and is required for all API requests.

1. Sign in to your Amperity account at your tenant URL (e.g., https://app.amperity.com).

2. Navigate to Settings in the left sidebar.

3. Click the Security tab.

4. Under API keys, locate any existing API key in the list, open its row menu (the three-dot menu icon), and select Copy tenant ID.

5. Save the copied tenant ID — you will need it when configuring the Nexla credential.

Create an API key and generate an access token.

1. Sign in to your Amperity account and navigate to Settings > Security.

2. In the API keys section, click Add API key to create a new key.

3. Enter a descriptive name for the API key (for example, Nexla Integration) to identify its purpose.

4. Click Save to create the key. The new API key will appear in the list under API keys.

5. In the row for your newly created API key, open the row menu and select Generate access token. A dialog will appear showing the generated JWT access token.

Important

Copy and securely store the access token immediately after it is generated. For security reasons, the token value is only displayed once and cannot be retrieved again after you close the dialog. If the token is lost, you will need to generate a new one.

6. Note that JWT access tokens have an expiration period. Amperity recommends refreshing tokens on a regular basis. When a token expires, return to Settings > Security > API keys and generate a new access token for the same API key.

For additional details about Amperity API key management, token rotation, and security best practices, refer to the official Amperity Authentication documentation.

Authenticate

Credentials required

JWT access token from Amperity Settings > Security > API keys. Requires DataGrid Operator key policy.

Field	Required	Secret	Description
Tenant ID	Yes	No	Your Amperity tenant ID. Found under Settings > Security > API keys > Actions menu > Copy tenant ID.
Access Token	Yes	Yes	JWT access token from Settings > Security > API keys > Get token. Token expires per the duration chosen at generation.

Create a credential in Nexla

Amperity uses Bearer token authentication. You will need the JWT access token generated in Prerequisites and your Amperity tenant ID.

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Amperity JWT access token in the Access Token field. This is the Bearer token that Nexla will include in the Authorization header of all API requests to your Amperity tenant. The token authenticates Nexla to the Amperity API and should be kept secure.

4. Enter your Amperity tenant ID in the Tenant ID field. This value is used to construct the base URL for all API requests (e.g., https://{tenant-id}.amperity.com/api/) and to populate the Amperity-Tenant request header. Your tenant ID was obtained in Prerequisites.

   Amperity JWT access tokens expire after a set period. When your access token expires, you will need to generate a new one in Amperity (Settings > Security > API keys) and update this credential in Nexla with the new token value.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Amperity connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Amperity API endpoints. 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.

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.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Amperity data sources can also be manually configured to ingest data from any valid Amperity API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

All Amperity API endpoint URLs follow the format https://{tenant-id}.amperity.com/api/{endpoint-path}, where the tenant ID is the subdomain of your Amperity instance (e.g., https://your-tenant.amperity.com/api/campaigns, https://your-tenant.amperity.com/api/segments, or https://your-tenant.amperity.com/api/indexes/{index-id}/profiles). For the complete list of available Amperity API endpoints, refer to the Amperity API Endpoints reference.

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 data to configure Nexla to treat each element in the data array as a separate record. Response context such as the next_page cursor token can be preserved with a metadata path. Date/time macros are particularly useful for Amperity endpoints that support date-range filtering, such as workflow run history queries that accept a start and end date in the URL, and lookup-based macros can supply ID path parameters such as profile index IDs retrieved in an earlier step of a multi-source workflow. You do not need to include the Authorization or Amperity-Tenant headers in the request headers field — those are automatically managed by Nexla using the values from your Amperity credential configuration.

Once all of the relevant settings have been configured, 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Amperity destination, and select the Send to Destination option from the menu. Select the Amperity connector from the list of available destination 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Amperity API endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Start Workflow Run

This endpoint triggers a new run of an existing Amperity workflow. Use this template when you need to programmatically launch Amperity workflows in response to upstream data events, such as starting a data refresh or a model retraining workflow after new data arrives in Nexla.

• Ensure the data being sent to this destination includes the required fields for the workflow run request. The Amperity API expects a JSON payload containing the workflow ID and any run-specific parameters.

• The workflow ID can be obtained from the Amperity UI by navigating to the Workflows section, or by using the List Workflows data source endpoint to retrieve the IDs of available workflows programmatically.
• After sending the request, the Amperity API returns a workflow run ID and status. Enable the Response Webhook option in the destination configuration to capture this response data as a new Nexla source for downstream processing or status tracking.

For additional information about triggering workflows via the Amperity API, refer to the Amperity POST /workflow/runs documentation.

Manual configuration

Amperity destinations can also be manually configured to send data to any valid Amperity API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Amperity API expects data in JSON format for all write operations. Endpoint URLs follow the format https://{tenant-id}.amperity.com/api/{endpoint-path} — for example, to trigger a workflow run, use https://your-tenant.amperity.com/api/workflow/runs. For the complete list of Amperity API endpoints that support write operations, refer to the Amperity API Endpoints reference.

You do not need to include the Authorization or Amperity-Tenant headers in the request headers field — those are automatically managed by Nexla using the values from your Amperity credential configuration. Enabling the response webhook option is useful for capturing confirmation data, resource IDs, or status information — such as workflow run IDs — returned by the Amperity API after each write operation.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Amperity endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to Amperity until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.