Component Migration API

Use the Component Migration APIs to migrate components, including segments, calculated metrics, and date ranges in Analytics to data views in Customer Journey Anaytics. You can also migrate dimensions and metrics to CJA data views if you have already mapped them with the Dimensions mappings APIs or Metrics mappings APIs.

Component Migration services

Component Migration APIs consist of three services for migrating components from Adobe Analytics to Customer Journey Analytics:

If you plan to migrate Analytics dimensions or metrics, you must first map them with the Dimensions Mappings API or the Metrics Mappings API and then use the Component Migration APIs described in this guide to finalize the migration. This allows the dimensions or metrics to be migrated into an XDM schema within a CJA data view. For other components, you can use the Component Migration APIs described in this guide directly to migrate them. For more inforation, see the Component Migration overview.

Before using the Component Migration APIs, create a profile named Component Migration in the Adobe Admin Console (admin permissions required). Add Component Migration and Analysis Workspace access permissions to the profile. Also, make sure to auto-include all report suites to the profile. For complete information, see the admin instructions for preparing to migrate your components and projects from Adobe Analytics to Customer Journey Analytics.

The endpoints described in this guide are routed through analytics.adobe.io. To use them, you must first create a client with access to the Adobe Developer Console. Create a new project in the console and add Adobe Analytics APIs. Make sure to select the Component Migration profile you created when preparing your components for migration, as described above. For more information, see Getting started with the Analytics API.

The two migration endpoints below provide methods for migrating project components from Adobe Analytics to Customer Journey Analytics. This includes segments, calculated metrics, and date ranges in Analysis Workspace. It also includes dimensions and metrics if you have mapped them before using these two Migration APIs. If you plan to also migrate dimensions and metrics, use the mappings APIs first so that the project ID can be associated with those mappings when you migrate the project. To use the following two migration endpoints, you will need the Adobe Analytics project ID and report suite ID, as well as the Customer Journey Analytics data view ID.

POST migrate project: Creates a migration project
GET migration project summary: Retrieves migration summary for a project
GET bulk migration projects status: Retrieves status of multiple migration projects

data-variant=info

data-slots=text

Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

POST migrate projects

Use this endpoint to migrate component projects from Adobe Analytics to Customer Journey Analytics. You will need the Analytics Project ID to make this call. If you are migrating Analytics dimensions or metrics, first map them to CJA with the mapping APIs.

POST https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/cjamigration/projects/{projectId}/migrate

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

              data-slots=heading, code

            

              data-repeat=2

            

              data-languages=CURL,JSON

            

              Request
            

              curl -X 'POST' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/cjamigration/projects/{projectId}/migrate" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "aaId": "exampleproject",
    "globalCompanyId": "example-analytics-org",
    "imsOrgId": "cja-exampleowner-org",
    "imsUserId": "cja-exampleowner-id",
    "imsUserName": "cja-exampleowner-name",
    "rsidDataIdMap": {
      "examplersid1": "dataview-id1",
      "examplersid2": "dataview-id2"
    }
  }'

            

              Response
            

              {
  "result": "success",
  "method": "POST",
  "message": "Components migrated successfully"
}

            

Request example details

The example request above shows the following details:

The Adobe Analytics project ID (aaId) is exampleproject. This is the project that contains the components to be transferred from Analytics to CJA.

data-variant=info

data-slots=text

The aaId parameter, as shown in the JSON example request above, has different meanings, depending upon endpoint or API service. In a request body for these Component Migration APIs, it is the project ID that is required for a successful call. In the related dimension mapping or metric mapping services, aaId is a label with a different meaning and a different function. For more information on the difference, see the description for aaId in dimensions mappings or metrics mappings services.

The globalCompanyId is example-analytics-org. This is the organization that has ownership of the Analtyics project identified in the project ID.
The imsOrgId, imsUserId, and imsUserName all apply to the exampleowner of the CJA data view where the components are to be transferred.
The rsidDataIdMap object contains object members that map the Analytics report suite to the CJA dataview. This includes the Analytics report suite examplersid1 mapped to the CJA data view dataview-id1. You can add as many pairs as necessary to the object to map the report suites to the data views, as indicated by the next line mapping examplersid2 to dataview-id2. The rsidDataIdMap object is optional but including it can improve migration precision.

Request Parameters

The following table describes the migrate components request parameters:

Name

Required

Type

Description

aaId or projectId

required

string

The Adobe Analytics project ID, as reflected by {projectId} in the URL of the cURL request above

globalCompanyId

required

string

The global company ID of the Analytics org

imsOrgId

required

string

The IMS organization ID for the CJA owner

imsUserId

required

string

The IMS user ID for the CJA owner

imsUserName

required

string

The IMS user name for the CJA owner

rsidDataIdMap

optional

object

This object includes key pairs that map Analytics report suites to CJA data views in the following format: {REPORT_SUITE_ID}: {DATA_VIEW_ID}. The parameter additionalProp1 is shown as the first mapping in the object. Additional mappings can also be added in subsequent lines, as indicated by the parameters additionalProp2 and additionalProp3.

Response Parameters

The following table describes the response parameters:

Name

Type

Description

result

string

The result of the operation (success/failure/partialSuccess)

method

string

The HTTP method used

message

string

A message describing the result

GET migration project summary

Use this endpoint to retrieve the migration summary for a single project.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/cjamigration/projects/{projectId}/summary

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

              data-slots=heading, code

              data-repeat=2

              data-languages=CURL,JSON

              Request
            
              curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/cjamigration/projects/{projectId}/summary" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

              Response
            
              {
  "result": "success",
  "method": "GET",
  "message": "Migration summary retrieved successfully",
  "summary": {
    "totalComponents": 10,
    "migratedComponents": 8,
    "failedComponents": 2
  }
}

Request Parameters

The request parameters are the same as those shown above in POST migrate projects endpoint.

Response Parameters

The following table describes the GET migration project summary response parameters:

Name

Type

Description

result

string

The result of the operation (success/failure/partialSuccess)

method

string

The HTTP method used

message

string

A message describing the result

summary

object

The migration summary details

totalComponents

integer

Total number of components

migratedComponents

integer

Number of successfully migrated components

failedComponents

integer

Number of failed component migrations

GET bulk migration projects status

Use this endpoint to retrieve migration statuses for multiple projects.

GET https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/cjamigration/projects/{projectId}/summary

Request and Response Examples

Click the Request tab in the following example to see a cURL request for this endpoint. Click the Response tab to see a successful JSON response for the request.

              data-slots=heading, code

              data-repeat=2

              data-languages=CURL,JSON

              Request
            
              curl -X 'GET' \
  "https://analytics.adobe.io/api/{GLOBAL_COMPANY_ID}/cjamigration/projects/bulk/status" \
  -H "accept: application/json" \
  -H "x-api-key: {CLIENT_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

              Response
            
The following shows the response body for each project status:

{
  "cjaId": "string",
  "aaId": "string",
  "migrationStatus": "STARTED",
  "migratedTime": "YYYY-08-24T14:15:22Z",
  "type": "string",
  "globalCompanyId": "string",
  "imsOrgId": "string"
}

Request Parameters

The request parameters are the same as those shown above in POST projects migrate endpoint.

Response Parameters

The following table describes the GET migration projects bulk status response parameters not previously described above:

Name

Type

Description

migrationStatus

string

Status of project migration. Includes STARTED, COMPLETED, or FAILED.

migratedTime

string

The date and time of beginning of current status

Status codes

Each API request returns an HTTP status code that reflects the result, as follows:

HTTP code

Meaning

Description

200

Success

The request is successful.

400

Bad Request

The request was improperly constructed, missing key information, and/or contained incorrect syntax. This error code could indicate a problem such as a missing required parameter or the supplied data did not pass validation.

401

Authentication failed

The request did not pass an authentication check. Your access token may be missing or invalid. Similarly, you may have attempted to access an object that requires administrator permissions.

403

Forbidden

The resource was found, but you do not have the right credentials to view it. You might not have the required permissions to access or edit the resource for reasons not applicable to status code 401.

404

Not found

The requested resource could not be found on the server. The resource may have been deleted, or the requested path was entered incorrectly.

500

Internal server errors

This is a server-side error. If you are making many simultaneous calls, you may be reaching the API limit and need to filter your results. Try your request again in a few minutes, and contact your administrator if the problem persists.