DataMapping

Retrieve a Data Mapping

Retrieve the details of a specific data mapping by its unique ID.

get/v1/ControlPlane/Stores/{storeId}/DataMappings/{dataMappingId}

Response

Data mapping details retrieved successfully.

displayNamestring required

Name of the data mapping.

descriptionstring

A human readable description of this resource, up to 512 characters.

isEnabledboolean

Flag indicating whether the data mapping is active. When true, data will be ingested and mapped according to the configuration. When false, the data mapping will be inactive and no data will be ingested into the Memory Store.

idstring required

The unique identifier for the data mapping.

createdAtstring date-time required

The ISO 8601 timestamp when the data mapping was created.

updatedAtstring date-time required

The ISO 8601 timestamp when the data mapping was last updated.

versioninteger required

The current version number of the DataMapping. Incremented on each successful update.

Example response

{
  "displayName": "crm-contacts",
  "description": "Syncs customer data from CRM dataset to profile traits",
  "isEnabled": true,
  "mappingTo": {
    "type": "TRAITS",
    "mappings": [
      {
        "expression": "primary_email",
        "traitGroup": "Contact",
        "traitName": "email"
      }
    ]
  },
  "mappingFrom": {
    "type": "INGRESS",
    "columns": [
      "first_name",
      "last_name",
      "email",
      "favorite_color"
    ]
  },
  "id": "mem_datamapping_00000000000000000000000000",
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T11:45:00Z",
  "version": 3
}

Changes

Changed in 3 of the 8 revisions of this API.86

Aug 25, 2026v149499262215f2See the full diff
- ○
  removed CSV DATASET discriminator mapping keys from the mappingFrom response property for the response status 200
  response-property-discriminator-mapping-deleted
- ○
  removed DataMappingFromCSV DataMappingFromDataSet from the mappingFrom response property oneOf list for the response status 200
  response-property-one-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 13, 2026v15fb6167593e711See the full diff
- ▲
  added DataMappingFromIngress DataMappingFromCloudAppDataSet DataMappingFromWarehouseDataSet to the mappingFrom response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  added INGRESS DATASET_CLOUDAPP DATASET_WAREHOUSE discriminator mapping keys to the mappingFrom response property for the response status 200
  response-property-discriminator-mapping-added
Aug 11, 2026v1b0ed05460bbf73See the full diff
- ▲
  the code response property's max was increased from 99999.00 to 999999.00 for the response status 400
  response-property-max-increased
- ▲
  the code response property's max was increased from 99999.00 to 999999.00 for the response status 404
  response-property-max-increased
- ▲
  the code response property's max was increased from 99999.00 to 999999.00 for the response status 429
  response-property-max-increased
- ▲
  the code response property's max was increased from 99999.00 to 999999.00 for the response status 500
  response-property-max-increased
- ▲
  the code response property's max was increased from 99999.00 to 999999.00 for the response status 503
  response-property-max-increased
- ▲
  added DataMappingFromCSV to the mappingFrom response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  removed the required property mappingTo/oneOf[DataMappingToTraits]/mappings/items/fieldName from the response with the 200 status
  response-required-property-removed
- ○
  the response property mappingTo/oneOf[DataMappingToTraits]/mappings/items/expression became required for the status 200
  response-property-became-required
- ○
  added CSV discriminator mapping keys to the mappingFrom response property for the response status 200
  response-property-discriminator-mapping-added
- ○
  the displayName response's property pattern was changed from ^[a-zA-Z][a-zA-Z0-9-_.]*$ to ^[a-zA-Z][a-zA-Z0-9-.]*$ for the status 200
  response-property-pattern-changed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 8 revisions, 1 has no diff computed.

Full history