Documentation

Amperity Profile Sync

📘

This integration requires activation of additional services. Contact your MetaRouter representative for assistance.

What is Amperity?

Amperity is a customer data platform that unifies and enriches customer profiles across systems. The Amperity Profile Sync retrieves profile attributes for a known identifier and returns them to MetaRouter for storage and downstream use. This sync enables first-party enrichment of events with Amperity-resolved attributes that support targeting, personalization, and analytics. It communicates with Amperity’s Profiles API using secure, tenant-scoped credentials.

Product Type: Customer Data Platform

Integration Type: ID Sync

Capabilities

  • Retrieves attributes from Amperity’s Profiles API response and stores them in first-party storage.
  • Retrieves identifiers and attributes directly from the API response body or headers returned by Amperity.
  • Utilizes MetaRouter’s Enrichment Service to fetch and resolve profile data before events are processed.
  • Adds resolved attributes to server-side event payloads for attribution, targeting, and audience enrichment.

Considerations

  • This integration requires activation of additional MetaRouter services to enable the identity sync functionality. For assistance activating these services, please contact your MetaRouter representative.

Sync Details

  • IDs:

    • attributes – Object of Amperity profile fields (for example, amperity_id, anonymousid, email, and other attributes) returned by the Profiles API and used to enrich events.

  • Description:

    • The sync retrieves attributes from a REST GET request to Amperity’s Profiles API endpoint at https://[TENANT_DOMAIN]/api/indexes/[INDEX_ID]/profiles/[VALUE], where [VALUE] is supplied by the configured Lookup Value Source (anonymous ID, user ID, or hashed email).
    • Each value is stored in first-party storage for a configured duration.
    • Values are refreshed when new data is detected.
    • The identifiers are added to server-side event payloads for attribution or targeting.

  • Response Example:

    {
  "attributes": {
    "amperity_id": "4683f9b0-dc7d-395e-9d7b-68327af4a6cb",
    "anonymousid": "8b3db3a6-27cd-45e6-82eb-92a461c329cc",
    "average_product_price": null,
    "email": "[email protected]",
    "messageid": "1746567641900-4df22581-9073-427c-9ff9-cc425a44f7fb",
    "total_orders": null,
    "total_revenue": null
  },
  "id": "8b3db3a6-27cd-45e6-82eb-92a461c329cc",
  "index_id": "ix-vdhJBWkE"
}

  • Server-side Event Payload:
    Server-side Event Payload: Upon completion of all vendor's sync, the server-side events will incorporate all resolved identifiers as described above. The following object will be appended to the context.providers property within the event's JSON payload.

{
   "amperityProfile": {
      "data": "{ "attributes": { "key": "8b3db3a6-27cd-45e ... } // Attributes object shown in "Response example".
   }
}
  • Cookie Name:
    • Cookie: _meta_amperityProfile_data, _meta_amperityProfile_data_failure
    • IndexedDB: [your storage prefix]_amperityProfile_data, [your storage prefix]_amperityProfile_data_failure
    • For a general guide on ID Sync validation, see here.

Sync Setup Guide

1. Gather Credentials

2. Add an Amperity Sync in MetaRouter

  • Submit Integration Request Ticket

    • Submit a request through our support portal to enable enrichment services and set up your Amperity API token. MetaRouter will handle the implementation of the token on your behalf. You may attach a file containing your Amperity API token securely during this step.
    • Example ticket description:
      Ticket Name: Enable Amperity Enrichment and API Token Implementation
      Ticket Description: Please enable enrichment services for our Amperity integration and implement our provided API token (attached).

  • Add the Amperity Profile Sync

    • To gather the attributes, you must add an Amperity sync.
      • From the Pipelines page, find the pipeline associated with the web property you’d like to add a sync to. Hover over the three dot dropdown and select “Build AJS File.”
      • In the Identity Syncs section, select the Amperity sync.
      • Fill out the following fields:
        • Cookie Lifetime (in days) (Optional) – How long values remain in first-party storage before expiring. Example: 30
        • API Timeout (in milliseconds) (Optional) – Maximum time the sync waits for a Profiles API response. Example: 300
        • Fire On ReSync (Required, boolean) – Re-triggers the sync when an identify() call is made. Example: true
        • MetaRouter Ingestor URL (Required, string) – Specifies the MetaRouter ingestor URL used by your organization. Ensure the URL does not include https:// at the beginning or any path information after .com. This should be the same as your “Ingestion Website URL” in the Analytics.js settings of your Pipeline. Example: "mr.example.com"
        • Encrypted (Required, boolean) - When enabled, profile data from the enrichment service is encrypted before being stored.
        • Amperity Tenant ID (Required, string) – Your Amperity tenant identifier. Example: "metarouter"
        • Amperity Tenant Domain (Required, string) – Exclude protocol and paths. Example: "metarouter.amperity.com"
        • Amperity Index ID (Required, string) – Profiles index identifier. Example: "ix-3y3bcXhS"
        • Lookup Value Source (Optional, string) – Which MetaRouter identifier supplies the profile lookup value: matchID (anonymous ID, default), userID, or hashedEmail. When the resolved value is empty (for example, userID or hashedEmail before an identify() call), the request is suppressed and no failure cookie is set; it fires once the value becomes available. Example: "matchID"
      • Scroll down and click the Save and Build File button.
      • Deploy your AJS file to propagate changes to your web property.

Updated 16 days ago