Skip to main content
Adobe Customer Journey Analytics
Betav0.1.0
70 actions · 3 auth methods
AnalyticsMarketing

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

OAuth 2.0 · Connector Profile

Delegated access on behalf of a signed-in Adobe user, so the connection sees exactly what that person sees in Customer J…

OAuth 2.0 (Client Credentials) · Connector Profile

App-only access through a technical account, with no signed-in user, so the connection is scoped to the Customer Journey…

No Authentication · Connector Profile

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

OAuth 2.0 · Link Account

OAuth 2.0 (Client Credentials) · Link Account

No Authentication · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
|
70 actions
Action
Description
Required scopes
Retrieve Multiple Annotations
Retrieve a list of annotations that the user can access.
Retrieve A Single Annotation
Retrieve details around a single annotation if you know the annotation ID.
Create An Annotation
Create annotations using POST API calls.
Update An Annotation
Edit annotations using PUT API calls. It supports partial updates, meaning that instead of sending an entire annotation…
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…
Get Asset Counts
Retrieves the number of assets owned by a specified user.
Transfer Assets
Transfers assets to the specified recipient user.
Get Audit Logs
This API returns a filterable list of audit log records.
Search Audit Logs
Retrieves a filterable list of audit log records.
Find One Calculated Metric
Retrieve a calculated metric by ID.
Update Calculated Metric
Update an existing calculated metric.
Delete Calculated Metric
Delete calculated metric.
Find Calculated Metrics
Retrieve multiple calculated metrics.
Get Calculated Metric Functions
Calculated metrics can use mathematic functions in combination with metrics available in a data view. You can call the `…
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…
Validate Calculated Metric
Data views have different dimensions and metrics available. A calculated metric that’s valid in one data view might not…
Create A Calculated Metric
Create a calculated metric with the desired definition for use in reporting.
Get Connections For Company
Retrieves all connections for the organization.
Search Connections
Retrieves connections for the organization based on connection ID or name.
Get Connection
Retrieves a connection by ID.
Get Backfills
Use this endpoint to retrieve the backfills for a specified connection and dataset.
Get Data Source Types
Use this endpoint to retrive the data source types used by an organization.
Get Data Views For Company
Retrieve all dataviews for an organization.
Create Data View
Creates and saves a specified dataview.
Get Data View By Id
Retrieve a dataview by ID.
Update Data View By Id
Update a dataview by ID with the specified dataview data.
Remove Data View By Id
Deletes a dataview by ID.
Copy Data View
Copy a dataview.
Validate Data View
Validates a Data View.
Get Date Ranges
Retrieves commonly used date ranges by the user so that they can be reused throughout the product.
Create Date Range
Creates a configuration for a date range.
Get Date Range
Retrieves configuration for a specified date range.
Update Date Range
Updates configuration for a specified date range.
Delete Date Range
Deletes a date range by ID.
Get Dimensions For Dataview
Retrieves dimensions for a specified dataview.
Get Dimension By Id
Retrieves a specific dimension for a specified dataview.
Get Metrics For Dataview
Retrieves metrics for a specified dataview.
Get Metric By Id
Retrieves a specific metric for a specified dataview.
Get Project
Retrieves configuration for a specified project.
Update Project
Updates configuration for a specified project.
Delete Project
Deletes a project by ID.
Validate Project
Check whether a project definition is compatible with a target data view.
Get Projects
Retrieves a list of projects associated with the user.
Create Project
Creates a single project.
Run Report
See the Reporting User Guide (https://developer.adobe.com/cja-apis/docs/endpoints/reporting/) for more information.
Get Top Items
Retrieves the top items (based on paging restriction) for the specified dimension and Data ID. Defaults to last 90 days…
Find All Segments
A segment response includes these default items: ID. Other attributes can be optionally requested through the ‘expansion…
Create Segment
Creates a configuration for a segment.
Validate Segment
Returns a segment validation for the segment contained in the post body of the report.
Find One Segment
A segment response will always include these default items: ID. Other attributes can be optionally requested through the…
Update Segment
The following fields can be modified through this endpoint: name, description, definition, owner, dataview ID, aamStatus…
Delete Segment
Deletion of a Segment by ID.
Find All Shares For Current User
Retrieves all components that have been shared by the current user (meeting the paging restriction).
Modify Shares
WARNING: Deletes/overwrites all pre-existing shares for the specified components. Creates shares for components in singl…
Get Share
Retrieves details about a specific share.
Delete Share
Deletes a share by ID and removes that share from all associated components.
Find All Shares To Current User
Retrieves all component IDs that have been shared with the current user.
Search Component Shares
Searches for shares of multiple components in a single request.
Create Shares
Share a component with a user or group.
Find All Tags For Company
Retrieves a list of tags for the organization of the current user.
Save Tag List
Allows creation of new tags and saves to specified component.
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…
Get Tag By Id
Retrieves a tag by ID.
Delete Tag
Deletes a tag by ID and all associations of that tag to any components.
Search Component Tags
Searches for tags associated with multiple components in a single request.
Get Tag List By Component Id And Component Type
Retrieves tags associated with a specified component ID and component type.
Get Components By Tag Name
Retreives component IDs from a comma separated list of tag names asociated with the components.
Save Tag Component List
WARNING: Deletes all pre-existing associations. This endpoint allows update of multiple tags in single request. Any tags…
Get Ims Users
Retrieves information for all users associated with the organization.
Get Current User
Retrieves information of the current user.