We recommend reading the following pages before integrating with Ometria:
The easiest and quickest way to add contact data to Ometria is to use the Push endpoint; the contacts endpoint should only be used for specific cases.
The contacts endpoint provides methods to:
- list the different collections (which can be viewed as sources of data),
- retrieve lists of contacts,
- retrieve one individual contact, and;
- create a new contact.
A contact is a child object of a profile - it represents the contact listing which makes up a customer profile.
If you need to retrieve the profile, use the profiles endpoint.
Records about people (customers / contacts / leads / subscribers) are supplied as 'contacts' records.
Contacts are organised into collections. For example, you might have a customers collection (customer records from your eCommerce platform) and a subscribers collection (contact records from your ESP).
Each record in a collection is uniquely identified by a string ID.
In cases where the same person exists in each list (or even more than once in each collection) Ometria will attempt to merge these contacts records into a single 'profiles' record (based on
customer_id and then
This means a single profile record can have several contacts records attached.
You can't write profile records directly as they are automatically clustered by Ometria.
We recommend that you pass contacts from different sources into Ometria with different collections.
This will help to ensure that data on the record is not over-ridden by missing data from another source.
If you have a unique customer/account identifier that you want to use in your reporting (e.g. row ID from your eCommerce importer), you can optionally supply this for each contact as the
This value is also supplied in the contact's records when an order is placed by a registered customer (i.e. not a guest checkout) and is used to connect the profile record and the order.
This is different to a contact listing ID, as a profile can have many "contact listings" (with multiple contact IDs) but only one customer ID.
It's very important that IDs sent to Ometria do not contain personally identifiable information (PII) such as email address, phone number or name. This is in case the ID is exposed publicly.
When merging contact records to create a profile, there are sometimes non-matching parameters in the contact records.
In this case, Ometria will use the following two rules of priority to determine which value to assign to the profile:
- Preferences centre
- API, App, CSV
- Ometria Form
- Importer (Magento or Shopify)
- Third party sync
- If there are two contact records with the same level of priority, then the varying parameters from the most recent contact record will be used.
lastnameparameters will always be taken from the same contact record.
These rules only apply only to a contact's
The order of preference:
- Any Ometria controlled source (e.g. Preference centre, an Ometria form, CSV upload).
- Any Client controlled source (e.g. API, Magento or Shopify importer).
- Any third party controlled source.
Updated 12 months ago