v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB
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": [
      {
        "fieldName": "primary_email",
        "traitGroup": "Contact",
        "traitName": "email"
      }
    ]
  },
  "mappingFrom": {
    "type": "DATASET",
    "datasetId": "tdi_dataset_00000000000000000000000000"
  },
  "id": "mem_datamapping_00000000000000000000000000",
  "createdAt": "2026-01-15T10:30:00Z",
  "updatedAt": "2026-01-15T11:45:00Z",
  "version": 3
}