Supported Component Types for Data Kit Deployment

To deploy a data kit component, use the POST ssot/data-kits/{dataKitDevName} endpoint.

The config array structure in the request body depends on the component type. Here's the complete list of supported component types and their corresponding payload configurations for deployment.

Analytics Dashboard

{
  "components": [
    {
      "type": "AnalyticsDashboard",
      "config": {
        "templateName": "templateName",
        "name": "New_Dashboard",
        "label": "New Dashboard",
        "dataSpaceName":"dataSpaceName",
        "componentType":"AnalyticsDashboard"
      }
    }
  ]
}

Analytics Visualization

{
  "components": [
    {
      "type": "AnalyticsVisualization",
      "config": {
        "templateName": "templateName",
        "name": "New_Visualization1",
        "label": "New Visualization",
        "dataSpaceName":"dataSpaceName",
        "componentType":"AnalyticsVisualization"
      }
    }
  ]
}

Analytics Workspace

{
  "components": [
    {
      "type": "AnalyticsWorkspace",
      "config": {
        "templateName": "templateName",
        "name": "new_workspace",
        "label": "New Workspace",
        "dataSpaceName":"dataSpaceName",
        "componentType":"AnalyticsWorkspace"
      }
    }
  ]
}

B2C Commerce Bundle

{
  "components": [
    {
      "type": "DataStreamBundle",
      "config": {
        "connectorType": "COMMERCE",
        "bundleName": "commercebundle1",
        "bundleConfig": {
          "instanceId": "bjmp_prd"
        }
      }
    }
  ]
}

Batch Data Transform

{
  "components": [
    {
      "type": "DataTransform",
      "config": {
        "dataTransformType": "BATCH",
        "dataTransformDevName": "Namespace__BatchTransformAccount",
        "apiName":"BatchTransformAccount",
        "label" : "BatchTransformAccount",
        "dataSpaceName": "default",
        "dataObjectOverrides": [
          {
            "nameOfObjInPublishingOrg": "Contacts__dll",
            "nameOfObjInSubscriberOrg": "Contacts_2_companion__dll"
          },
          {
            "nameOfObjInPublishingOrg": "output_dlo_2__dll",
            "nameOfObjInSubscriberOrg": "output_dlo_2_copy__dll"
          }
        ],
        "definitionOverrides": [
          {
            "templateDevName": "DefinitionDeveloperNameInDatakit_1",
            "devName": "Renamed_DefinitionName_1",
            "label": "Renamed_Label_1"
          },
          {
            "templateDevName": "DefinitionDeveloperNameInDatakit_2",
            "devName": "Renamed_DefinitionName_2",
            "label": "Renamed_Label_2"
          }
        ]
      }
    }
  ]
}

BYOL Bundle

{
  "components": [
    {
      "type": "DataStreamBundle",
      "config": {
        "connectorType": "EXTERNAL",
        "bundleName": "testsnowflake",
        "bundleConfig": {
          "connectionName": "testsnowflake"
        }
      }
    }
  ]
}

Calculated Insight

{
  "components": [
    {
      "type": "CalculatedInsight",
      "config": {
        "apiName": "Namespace__testCI",
        "apiNameOverride": "CiTest1",
        "label": "CiTest1",
        "publishInterval":"NotScheduled"
      }
    }
  ]
}

Connector Framework

{
  "components": [
    {
      "type": "DataStreamBundle",
      "config": {
        "connectorType": "MORECONNECTORS",
        "bundleName": "BundleName",
        "forceNoRefresh": true,
        "bundleConfig": {
          "connectionName": "connectionName"
        }
      }
    }
  ]
}

CRM Bundle

{
  "components": [
    {
      "type": "DataStreamBundle",
      "config": {
        "connectorType": "CRM",
        "bundleName": "BundleName",
        "forceNoRefresh": true,
        "bundleConfig": {
          "orgId": "org123"
        }
      }
    }
  ]
}

Data Action

{
  "components": [
    {
      "type": "DataAction",
      "config": {
        "developerName": "developerName",
        "label": "label",
        "dataSpaceName": "dataSpaceName"
      }
    }
  ]
}

Data Action Target

{
  "components": [
    {
      "type": "DataActionTarget",
      "config": {
        "apiName": "apiName",
        "label": "label",
        "endPointUrlOverride": "endPointUrlOverride"
      }
    }
  ]
}

Data Clean Room

{
  "components": [
    {
      "type": "DataCleanRoomProvider",
      "config": {
        "packageName": "packageFromProvider",
        "componentName": "X00Dxx0000006GpL_Hulu1746441961199"
      }
    }
  ]
}

Data Connection

{
  "components": [
    {
      "type": "DataConnection",
      "config": {
        "name": "testsnowflake",
        "newCredentials": [
          {
            "paramName": "user",
            "value": "abc"
          },
          {
            "paramName": "privateKey",
            "value": "xyz"
          }
        ]
      }
    }
  ]
}

Data Lake Object (DLO)

{
  "components": [
    {
      "type": "DataLakeObject",
      "config": {
        "dataSourceObjectDevName": "Namespace__DLOname",
        "apiName": "hello",
        "label": "lab",
        "dataSpaceName": "default"
      }
    }
  ]
}

Document AI

{
  "components": [
    {
      "type": "IdpConfiguration",
      "config": {
        "templateDevName": "Test_Document_Processing22"
      }
    }
  ]
}

Identity Resolution

{
  "components": [
    {
      "type": "IdentityResolution",
      "config": {
        "dataSpaceName": "default",
        "templateDevName": "Individual_1111",
        "dataKitDevName": "DK6"
      }
    }
  ]
}

Ingestion API Bundle

{
  "components": [
    {
      "type": "DataStreamBundle",
      "config": {
        "connectorType": "INGESTAPI",
        "bundleName": "IngestionDataStreams",
        "bundleConfig": {
          "connectorName": "NewIngestionConnector"
        }
      }
    }
  ]
}

ML Prediction Job

{
  "components": [
    {
      "type": "MlPredictionJob",
      "config": {
        "dataKitDevName": "test datakit",
        "predictionJobDevName": "test_prediction_job_name",
        "apiName":"test_prediction_job_name",
        "label" : "test prediction job name",
        "dataSpaceName": "default"
      }
    }
  ]
}

Related List Enrichment

 {
  "components": [
    {
      "type": "IrRelatedListEnrichment",
      "config": {
        "developerName": "IRRLDevName",
        "label": "IRRLLabel"
      }
    }
  ]
}

Segment

{
  "components": [
    {
      "type": "MarketSegment",
      "config": {
        "name": "datakitSegment",
        "dataKitName": "kit01"
      }
    }
  ]
}

Semantic Data Model

{
  "components": [
    {
      "type": "SemanticModel",
      "config": {
        "apiName": "testmodel",
        "dataSpaceName": "default"
      }
    }
  ]
}

Semantic Search/Search Index

{
  "components": [
    {
      "type": "DataSemanticSearch",
      "config": {
        "dataSpaceName": "DATASPACE",
        "searchIndexName": "SEARCH_INDEX_DEVELOPER_NAME_PRESENT_IN_DATA_KIT",
        "dataKitName": "DATAKIT_NAME"
      }
    }
  ]
}

Streaming App Bundle

{
  "components": [
    {
      "type": "DataStreamBundle",
      "config": {
        "connectorType": "STREAMINGAPP",
        "bundleName": "BundleName",
        "forceNoRefresh": true,
        "bundleConfig": {
          "connectorName": "connectorName",
          "streamingAppDataConnectorType" : "MobileApp"
        }
      }
    }
  ]
}

Streaming Data Transform

{
  "components": [
    {
      "type": "DataTransform",
      "config": {
        "dataTransformType": "STREAMING",
        "dataSpaceName": "default",
        "dataTransformDevName": "singe_def_dmo_sdt1",
        "label": "singe_def_dmo_sdt",
        "apiName": "singe_def_dmo_sdt",
        "componentProperties": {
          "targetDmo": "Output_dmo_4__dlm"
        }
      }
    }
  ]
}

Other Supported Component Types

  • AI Retriever
  • Activation
  • Activation Target
  • Copy Field Enrichment
  • Data Custom Code
  • Data Share
  • Engagement Signal
  • ML AI Model
  • Personalization Objective
  • Personalization Point
  • Personalization Recommender
  • Personalization Schema