> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Adobe Customer Journey Analytics

> How to set up the Adobe Customer Journey Analytics connector, plus the actions that are available.

![Adobe Customer Journey Analytics](https://stackone-logos.com/api/adobe/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/changelog.md)

[70 actions](#actions) · 3 auth methods

Analytics
Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/guides/connector-profile/oauth-2-0.md)
>
> Delegated access on behalf of a signed-in Adobe user, so the connection sees exactly what that person sees in Customer J...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> App-only access through a technical account, with no signed-in user, so the connection is scoped to the Customer Journey...

> [card] [No Authentication · Connector Profile](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/guides/connector-profile/no-authentication.md)
>
> Scratch method for local testing that performs no authentication and no token exchange. Customer Journey Analytics rejec...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [No Authentication · Link Account](https://docs.stackone.com/connectors/adobecustomerjourneyanalytics/guides/link-account/no-authentication.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

No Authentication

OAuth 2.0

OAuth 2.0 (Client Credentials)

No auth methods found

Scopes

Select all
|
Clear

AdobeID

additional\_info.projectedProductContext

openid

read\_organizations

No scopes found

70 actions

ActionDescriptionRequired scopes

Retrieve Multiple Annotations`adobecustomerjourneyanalytics_retrieve_multiple_annotations`

Retrieve a list of annotations that the user can access.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Retrieve A Single Annotation`adobecustomerjourneyanalytics_retrieve_a_single_annotation`

Retrieve details around a single annotation if you know the annotation ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create An Annotation`adobecustomerjourneyanalytics_create_an_annotation`

Create annotations using POST API calls.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Update An Annotation`adobecustomerjourneyanalytics_update_an_annotation`

Edit annotations using PUT API calls. It supports partial updates, meaning that instead of sending an entire annotation...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete An Annotation`adobecustomerjourneyanalytics_delete_an_annotation`

When you delete an annotation, it is hidden from all users in all menus. It is also hidden from API calls to the multipl...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Asset Counts`adobecustomerjourneyanalytics_get_asset_counts`

Retrieves the number of assets owned by a specified user.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Transfer Assets`adobecustomerjourneyanalytics_transfer_assets`

Transfers assets to the specified recipient user.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Audit Logs`adobecustomerjourneyanalytics_get_audit_logs`

This API returns a filterable list of audit log records.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Search Audit Logs`adobecustomerjourneyanalytics_search_audit_logs`

Retrieves a filterable list of audit log records.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find One Calculated Metric`adobecustomerjourneyanalytics_find_one_calculated_metric`

Retrieve a calculated metric by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Update Calculated Metric`adobecustomerjourneyanalytics_update_calculated_metric`

Update an existing calculated metric.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Calculated Metric`adobecustomerjourneyanalytics_delete_calculated_metric`

Delete calculated metric.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find Calculated Metrics`adobecustomerjourneyanalytics_find_calculated_metrics`

Retrieve multiple calculated metrics.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Calculated Metric Functions`adobecustomerjourneyanalytics_get_calculated_metric_functions`

Calculated metrics can use mathematic functions in combination with metrics available in a data view. You can call the \`...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Calculated Metric Function`adobecustomerjourneyanalytics_get_calculated_metric_function`

If you want information on a single function, append the ID to the endpoint URL. (Spec) Retrieves a calculated metric fu...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Validate Calculated Metric`adobecustomerjourneyanalytics_validate_calculated_metric`

Data views have different dimensions and metrics available. A calculated metric that's valid in one data view might not...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create A Calculated Metric`adobecustomerjourneyanalytics_create_a_calculated_metric`

Create a calculated metric with the desired definition for use in reporting.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Connections For Company`adobecustomerjourneyanalytics_get_connections_for_company`

Retrieves all connections for the organization.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Search Connections`adobecustomerjourneyanalytics_search_connections`

Retrieves connections for the organization based on connection ID or name.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Connection`adobecustomerjourneyanalytics_get_connection`

Retrieves a connection by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Backfills`adobecustomerjourneyanalytics_get_backfills`

Use this endpoint to retrieve the backfills for a specified connection and dataset.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Data Source Types`adobecustomerjourneyanalytics_get_data_source_types`

Use this endpoint to retrive the data source types used by an organization.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Data Views For Company`adobecustomerjourneyanalytics_get_data_views_for_company`

Retrieve all dataviews for an organization.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create Data View`adobecustomerjourneyanalytics_create_data_view`

Creates and saves a specified dataview.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Data View By Id`adobecustomerjourneyanalytics_get_data_view_by_id`

Retrieve a dataview by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Update Data View By Id`adobecustomerjourneyanalytics_update_data_view_by_id`

Update a dataview by ID with the specified dataview data.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Remove Data View By Id`adobecustomerjourneyanalytics_remove_data_view_by_id`

Deletes a dataview by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Copy Data View`adobecustomerjourneyanalytics_copy_data_view`

Copy a dataview.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Validate Data View`adobecustomerjourneyanalytics_validate_data_view`

Validates a Data View.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Date Ranges`adobecustomerjourneyanalytics_get_date_ranges`

Retrieves commonly used date ranges by the user so that they can be reused throughout the product.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create Date Range`adobecustomerjourneyanalytics_create_date_range`

Creates a configuration for a date range.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Date Range`adobecustomerjourneyanalytics_get_date_range`

Retrieves configuration for a specified date range.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Update Date Range`adobecustomerjourneyanalytics_update_date_range`

Updates configuration for a specified date range.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Date Range`adobecustomerjourneyanalytics_delete_date_range`

Deletes a date range by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Dimensions For Dataview`adobecustomerjourneyanalytics_get_dimensions_for_dataview`

Retrieves dimensions for a specified dataview.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Dimension By Id`adobecustomerjourneyanalytics_get_dimension_by_id`

Retrieves a specific dimension for a specified dataview.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Metrics For Dataview`adobecustomerjourneyanalytics_get_metrics_for_dataview`

Retrieves metrics for a specified dataview.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Metric By Id`adobecustomerjourneyanalytics_get_metric_by_id`

Retrieves a specific metric for a specified dataview.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Project`adobecustomerjourneyanalytics_get_project`

Retrieves configuration for a specified project.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Update Project`adobecustomerjourneyanalytics_update_project`

Updates configuration for a specified project.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Project`adobecustomerjourneyanalytics_delete_project`

Deletes a project by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Validate Project`adobecustomerjourneyanalytics_validate_project`

Check whether a project definition is compatible with a target data view.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Projects`adobecustomerjourneyanalytics_get_projects`

Retrieves a list of projects associated with the user.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create Project`adobecustomerjourneyanalytics_create_project`

Creates a single project.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Run Report`adobecustomerjourneyanalytics_run_report`

See the Reporting User Guide ([https://developer.adobe.com/cja-apis/docs/endpoints/reporting/](https://developer.adobe.com/cja-apis/docs/endpoints/reporting/)) for more information.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Top Items`adobecustomerjourneyanalytics_get_top_items`

Retrieves the top items (based on paging restriction) for the specified dimension and Data ID. Defaults to last 90 days....

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find All Segments`adobecustomerjourneyanalytics_find_all_segments`

A segment response includes these default items: ID. Other attributes can be optionally requested through the 'expansion...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create Segment`adobecustomerjourneyanalytics_create_segment`

Creates a configuration for a segment.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Validate Segment`adobecustomerjourneyanalytics_validate_segment`

Returns a segment validation for the segment contained in the post body of the report.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find One Segment`adobecustomerjourneyanalytics_find_one_segment`

A segment response will always include these default items: ID. Other attributes can be optionally requested through the...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Update Segment`adobecustomerjourneyanalytics_update_segment`

The following fields can be modified through this endpoint: name, description, definition, owner, dataview ID, aamStatus...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Segment`adobecustomerjourneyanalytics_delete_segment`

Deletion of a Segment by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find All Shares For Current User`adobecustomerjourneyanalytics_find_all_shares_for_current_user`

Retrieves all components that have been shared by the current user (meeting the paging restriction).

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Modify Shares`adobecustomerjourneyanalytics_modify_shares`

WARNING: Deletes/overwrites all pre-existing shares for the specified components. Creates shares for components in singl...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Share`adobecustomerjourneyanalytics_get_share`

Retrieves details about a specific share.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Share`adobecustomerjourneyanalytics_delete_share`

Deletes a share by ID and removes that share from all associated components.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find All Shares To Current User`adobecustomerjourneyanalytics_find_all_shares_to_current_user`

Retrieves all component IDs that have been shared with the current user.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Search Component Shares`adobecustomerjourneyanalytics_search_component_shares`

Searches for shares of multiple components in a single request.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Create Shares`adobecustomerjourneyanalytics_create_shares`

Share a component with a user or group.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Find All Tags For Company`adobecustomerjourneyanalytics_find_all_tags_for_company`

Retrieves a list of tags for the organization of the current user.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Save Tag List`adobecustomerjourneyanalytics_save_tag_list`

Allows creation of new tags and saves to specified component.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Tag Items`adobecustomerjourneyanalytics_delete_tag_items`

Removes all tags from the specified component IDs. Note that currently this is done in a single request, so there is a s...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Tag By Id`adobecustomerjourneyanalytics_get_tag_by_id`

Retrieves a tag by ID.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Delete Tag`adobecustomerjourneyanalytics_delete_tag`

Deletes a tag by ID and all associations of that tag to any components.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Search Component Tags`adobecustomerjourneyanalytics_search_component_tags`

Searches for tags associated with multiple components in a single request.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Tag List By Component Id And Component Type`adobecustomerjourneyanalytics_get_tag_list_by_component_id_and_component_type`

Retrieves tags associated with a specified component ID and component type.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Components By Tag Name`adobecustomerjourneyanalytics_get_components_by_tag_name`

Retreives component IDs from a comma separated list of tag names asociated with the components.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Save Tag Component List`adobecustomerjourneyanalytics_save_tag_component_list`

WARNING: Deletes all pre-existing associations. This endpoint allows update of multiple tags in single request. Any tags...

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Ims Users`adobecustomerjourneyanalytics_get_ims_users`

Retrieves information for all users associated with the organization.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`

Get Current User`adobecustomerjourneyanalytics_get_current_user`

Retrieves information of the current user.

`openid``AdobeID``read_organizations``additional_info.projectedProductContext`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.