Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Customer Journey Analytics APIs.

CJA APIs (0.1.0)

Download OpenAPI specification:Download

Open API specification for Customer Journey Analytics APIs.

Note: 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.

Interactive API: You can interact with CJA APIs directly from this reference page. Use the Try it function below and the Get credentials feature above to get authenticated for calls from this site. For more information, see Tips for calling endpoints on the CJA API Reference.

Related documentation: CJA API endpoint guides

Configuration API

Returns the current user

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional metadata fields to include on response.

Items Value: "admin"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

get/configuration/users/me
Response samples
application/json
{
  • "countryCode": "string",
  • "mrktPermEmail": true,
  • "emailVerified": true,
  • "first_name": "string",
  • "organization": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "userId": "string",
  • "name": "string",
  • "last_name": "string",
  • "utcOffset": "string",
  • "mrktPerm": "string",
  • "displayName": "string",
  • "roles": [
    ]
}

Returns all CJA IMS Users associated with the provided organization

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Value: "images"
useCache
boolean
Default: true

useCache

limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

get/configuration/org/users
Response samples
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "pageable": {
    },
  • "first": true,
  • "last": true,
  • "sort": {
    },
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "empty": true
}

Calculated Metrics API

Retrieve a single calculated metric by id

A calculated metric response will always include these default items: id, name, description, rsid, owner, polarity, precision, type

Other attributes can be optionally requested through the 'expansion' field:

  • modified: Date that the metric was last modified (ISO 8601)
  • definition: Calculated metric definition as JSON object
  • compatibility: Products that the metric is compatible with
  • reportSuiteName: Also return the friendly Report Suite name for the RSID
  • tags: Gives all existing tags associated with the calculated metric

For more information about calculated metrics go here

Request
path Parameters
id
required
string

The calculated metric ID to retrieve

query Parameters
expansion
Array of strings

Comma-delimited list of additional calculated metric metadata fields to include on response.

Items Enum: "approved" "favorite" "shares" "tags" "sharesFullName" "usageSummary" "usageSummaryWithRelevancyScore" "reportSuiteName" "siteTitle" "ownerFullName" "modified" "migratedIds" "isDeleted" "definition" "authorization" "compatibility" "legacyId" "internal" "dataGroup" "categories" "reportTimeAttribution" "warning"
includeHidden
boolean
Default: false

Whether to include variables that are hidden in the UI or that the user doesn't have permission to.

toBeUsedInRsid
string

The report suite where the calculated metric is intended to be used. This report suite will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved.

locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

403

Requesting non-shared calculated metrics for other users is restricted to admin users

500

External API error; calculated metric retrieval failed

get/calculatedmetrics/{id}
Response samples
application/json
{
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "dataId": "string",
  • "dataName": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isDeleted": true,
  • "migratedIds": [
    ],
  • "internal": true,
  • "owner": { },
  • "polarity": "positive",
  • "alternateVariableNames": {
    },
  • "precision": 0,
  • "type": "CURRENCY",
  • "definition": { },
  • "compatibility": {
    },
  • "legacyId": "string",
  • "template": true,
  • "authorization": {
    },
  • "dataGroup": "string",
  • "solution": true,
  • "curatedItem": true,
  • "categories": [
    ],
  • "reportTimeAttribution": true,
  • "warning": {
    },
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    },
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z"
}

Update an existing calculated metric

The following fields can be modified through this endpoint:
name, description, definition, owner, rsid Example "defintion" for use in testing API below ("Visits per visitor"):
"definition": { "formula": { "func": "divide", "col1": { "func": "metric", "name": "metrics/visits", "description": "Visits" }, "col2": { "func": "metric", "name": "metrics/visitors", "description": "Unique Visitors" } }, "func": "calc-metric", "version": [ 1, 0, 0 ] }

Response will be the newly modified calculated metric object after the update request completes.

CalculatedMetricResponse
A calculated metric response will always include these default items:* id, name, description, rsid, owner*

Other attributes can be optionally requested through the 'expansion' field as defined/documented in the GET endpoints (see GET "/calculatedmetrics" or GET "/calculatedmetrics/{id}" for more documentation).

Request
path Parameters
id
required
string

Calculated Metric ID to be updated

query Parameters
expansion
Array of strings

Comma-delimited list of additional calculated metric metadata fields to include on response.

Items Enum: "approved" "favorite" "shares" "tags" "sharesFullName" "usageSummary" "usageSummaryWithRelevancyScore" "reportSuiteName" "siteTitle" "ownerFullName" "modified" "migratedIds" "isDeleted" "definition" "authorization" "compatibility" "legacyId" "internal" "dataGroup" "categories" "reportTimeAttribution" "warning"
locale
string
Default: "en_US"

Locale

cached
boolean
Default: true

Use cached results

Enum: true false
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted Object containing key/value pairs to be updated.

rsid
string
reportSuiteName
string
dataId
string
dataName
string
id
string
name
string
description
string
isDeleted
boolean
migratedIds
Array of strings
internal
boolean
owner
object
polarity
string

Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive

Enum: "positive" "negative"
object
precision
integer <int32>

Number of decimal places to include in calculated metric result

type
string
Enum: "CURRENCY" "TIME" "DECIMAL" "PERCENT"
definition
required
object

Calculated metric definition object

object
legacyId
string
template
boolean
object
dataGroup
string
solution
boolean
curatedItem
boolean
categories
Array of strings
reportTimeAttribution
boolean
object
Array of objects
Array of objects
approved
boolean
favorite
boolean
object
siteTitle
string
modified
string <date-time>
Responses
200

Successful operation

400

Definition must be formatted as a JSON Object

401

Company mismatch; calculated metric ownership can only be transferred within the same organization

403

User does not have permission to update this calculated metric

500

External API error; Calculated metric update or retrieval failed

put/calculatedmetrics/{id}
Request samples
application/json
{
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "dataId": "string",
  • "dataName": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isDeleted": true,
  • "migratedIds": [
    ],
  • "internal": true,
  • "owner": { },
  • "polarity": "positive",
  • "alternateVariableNames": {
    },
  • "precision": 0,
  • "type": "CURRENCY",
  • "definition": { },
  • "compatibility": {
    },
  • "legacyId": "string",
  • "template": true,
  • "authorization": {
    },
  • "dataGroup": "string",
  • "solution": true,
  • "curatedItem": true,
  • "categories": [
    ],
  • "reportTimeAttribution": true,
  • "warning": {
    },
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    },
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "dataId": "string",
  • "dataName": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isDeleted": true,
  • "migratedIds": [
    ],
  • "internal": true,
  • "owner": { },
  • "polarity": "positive",
  • "alternateVariableNames": {
    },
  • "precision": 0,
  • "type": "CURRENCY",
  • "definition": { },
  • "compatibility": {
    },
  • "legacyId": "string",
  • "template": true,
  • "authorization": {
    },
  • "dataGroup": "string",
  • "solution": true,
  • "curatedItem": true,
  • "categories": [
    ],
  • "reportTimeAttribution": true,
  • "warning": {
    },
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    },
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z"
}

Deletion of Calculated Metrics by Id

Request
path Parameters
id
required
string

The calculated metric ID to be deleted

query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

500

External API error; Calculated metric delete failed

delete/calculatedmetrics/{id}
Response samples
application/json
{
  • "result": "string",
  • "message": "string"
}

Retrieve many calculated metrics

A calculated metric response will always include these default items: id, name, description, rsid, owner, polarity, precision, type

Other attributes can be optionally requested through the 'expansion' field:

  • modified: Date that the metric was last modified (ISO 8601)
  • definition: Calculated metric definition as JSON object
  • compatibility: Products that the metric is compatible with
  • reportSuiteName: Also return the friendly Report Suite name for the RSID
  • tags: Gives all existing tags associated with the calculated metric

For more information about calculated metrics go here

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional calculated metric metadata fields to include on response.

Items Enum: "dataName" "approved" "favorite" "shares" "tags" "sharesFullName" "usageSummary" "usageSummaryWithRelevancyScore" "reportSuiteName" "siteTitle" "ownerFullName" "modified" "migratedIds" "isDeleted" "definition" "authorization" "compatibility" "legacyId" "internal" "dataGroup" "categories"
includeType
Array of strings

Include additional calculated metrics not owned by user. The "all" option takes precedence over "shared"

Items Enum: "all" "shared" "templates" "unauthorized" "deleted" "internal" "curatedItem"
dataIds
string

Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)

ownerId
string

Filter list to only include calculated metrics owned by the specified loginId

filterByIds
string

Filter list to only include calculated metrics in the specified list (comma-delimited list of IDs) (this is the same as calculatedMetricFilter, and is overwritten by calculatedMetricFilter

toBeUsedInRsid
string

The data view where the calculated metric intended to be used. This data view will be used to determine things like compatibility and permissions. If it is not specified then the permissions will be calculated based on the union of all metrics authorized in all groups the user belongs to. If the compatibility expansion is specified and toBeUsedInRsid is not then the compatibility returned is based off the compatibility from the last time the calculated metric was saved.

locale
string
Default: "en_US"

Locale

favorite
boolean

Filter list to only include calculated metrics that are favorites

approved
boolean

Filter list to only include calculated metrics that are approved

pagination
string
Default: "true"

return paginated results

Enum: "true" "false"
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

sortDirection
string
Default: "ASC"

Sort direction (ASC or DESC)

sortProperty
string
Default: "id"

Property to sort by (name, modified_date, id is currently allowed)

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

400

Unable to retrieve list of calculated metrics shared with user

401

Owner filter error; user specified is not in the same company as the requesting user

403

Requesting non-shared calculated metrics for other users is restricted to admin users

500

External API error; Calculated metric retrieval failed

get/calculatedmetrics
Response samples
application/json
[
  • {
    }
]

Retrieve calculated metric functions

Request
query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

500

External API error; Calculated metric functions retrieval failed

get/calculatedmetrics/functions
Response samples
application/json
[
  • {
    }
]

Retrieve a calculated metric function by id

Request
path Parameters
id
required
string

The function ID to retrieve

query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Calculated metric function not found

500

External API error; Calculated metric function retrieval failed

get/calculatedmetrics/functions/{id}
Response samples
application/json
{
  • "id": "string",
  • "category": "string",
  • "persistable": true,
  • "name": "string",
  • "namespace": "string",
  • "description": "string",
  • "exampleKey": "string",
  • "example": "string",
  • "definition": {
    }
}

Validate a calculated metric definition

Request
query Parameters
locale
string
Default: "en_US"

Locale

migrating
boolean
Default: false

Include migration functions in validation

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted Object containing key/value pairs for calculated metric validation.

rsid
string
reportSuiteName
string
dataId
string
dataName
string
id
string
name
string
description
string
isDeleted
boolean
migratedIds
Array of strings
internal
boolean
owner
object
polarity
string

Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive

Enum: "positive" "negative"
object
precision
integer <int32>

Number of decimal places to include in calculated metric result

type
string
Enum: "CURRENCY" "TIME" "DECIMAL" "PERCENT"
definition
required
object

Calculated metric definition object

object
legacyId
string
template
boolean
object
dataGroup
string
solution
boolean
curatedItem
boolean
categories
Array of strings
reportTimeAttribution
boolean
object
Array of objects
Array of objects
approved
boolean
favorite
boolean
object
siteTitle
string
modified
string <date-time>
Responses
200

Successful operation

400

Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object.

500

External API error; Calculated metric validation failed

post/calculatedmetrics/validate
Request samples
application/json
{
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "dataId": "string",
  • "dataName": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isDeleted": true,
  • "migratedIds": [
    ],
  • "internal": true,
  • "owner": { },
  • "polarity": "positive",
  • "alternateVariableNames": {
    },
  • "precision": 0,
  • "type": "CURRENCY",
  • "definition": { },
  • "compatibility": {
    },
  • "legacyId": "string",
  • "template": true,
  • "authorization": {
    },
  • "dataGroup": "string",
  • "solution": true,
  • "curatedItem": true,
  • "categories": [
    ],
  • "reportTimeAttribution": true,
  • "warning": {
    },
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    },
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "dataId": "string",
  • "dataName": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isDeleted": true,
  • "migratedIds": [
    ],
  • "internal": true,
  • "owner": { },
  • "polarity": "positive",
  • "alternateVariableNames": {
    },
  • "precision": 0,
  • "type": "CURRENCY",
  • "definition": { },
  • "compatibility": {
    },
  • "legacyId": "string",
  • "template": true,
  • "authorization": {
    },
  • "dataGroup": "string",
  • "solution": true,
  • "curatedItem": true,
  • "categories": [
    ],
  • "reportTimeAttribution": true,
  • "warning": {
    },
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    },
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z"
}

Shares API

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

Request
query Parameters
includeType
Array of strings

Include additional shares not owned by the user

Items Value: "sharedTo"
userid
string

The user ID to return details for. Only admins may user this option.

limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

500

Unable to retrieve list of components.

get/componentmetadata/shares
Response samples
application/json
[
  • {
    }
]

Share components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components

Create one/many shares for one/many components at once. For each component object in the passed list, the given shares will replace the current set of shares for each component. For example, if one of the components was previously shared with additional users, and that share is not passed in here, it will no longer be shared with them.

Request
query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted ARRAY of objects containing key-value pairs that conform to the schema

Array
componentType
string
componentId
string
Array of objects
Responses
200

Successful operation

400

Invalid component type, or mixed component types on request (only one type per request)

403

Permission error; user does not have access for the requested operation

500

Unable to save list of component shares

put/componentmetadata/shares
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "componentType": "string",
  • "componentId": "string",
  • "shares": [
    ]
}

Returns details about a specific share

Request
path Parameters
id
required
integer <int64>

The share ID to return details for

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

400

Invalid component type

403

Permission error; user does not have access to the share

500

Unable to retrieve share

get/componentmetadata/shares/{id}
Response samples
application/json
{
  • "shareId": 0,
  • "imsOrgId": "string",
  • "shareToId": 0,
  • "shareToImsId": "string",
  • "shareToType": "string",
  • "shareFromImsId": "string",
  • "componentType": "string",
  • "componentId": "string",
  • "shareToDisplayName": "string",
  • "shareToLogin": "string",
  • "accessLevel": "string"
}

Deletes the share with the given id

Delete by shareId and remove that share from all associated components.

Request
path Parameters
id
required
integer <int64>

The shareId to be deleted

query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

403

Permission error; user does not have access to delete the component

500

Unable to delete share

delete/componentmetadata/shares/{id}
Response samples
application/json
{
  • "property1": { },
  • "property2": { }
}

Returns all component ids that have shared to the current user

Request
query Parameters
componentType
required
string

ComponentType to return

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

get/componentmetadata/shares/sharedto/me
Response samples
application/json
[
  • "string"
]

search for shares for several components at once

Request
query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional project metadata fields to include on response.

Items Value: "sharesFullName"
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

items to search for

componentType
string
componentIds
Array of strings unique
dataId
string
Responses
200

Successful operation

post/componentmetadata/shares/component/search
Request samples
application/json
{
  • "componentType": "string",
  • "componentIds": [
    ],
  • "dataId": "string"
}
Response samples
application/json
{
  • "componentType": "string",
  • "componentId": "string",
  • "shares": [
    ]
}

Tags API

Returns a list of tags for the current user's company

Request
query Parameters
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

500

Unable to retrieve list of tags for user.

get/componentmetadata/tags
Response samples
application/json
[
  • {
    }
]

Saves the given tag(s) for the current user's company

Allows creation of a new tag and applies that new tag to the passed component

Request
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted array of Tag objects containing key-value pairs

Array
id
integer <int32>

the tag id

name
string

the tag name

description
string

the tag description

components
Array of objects unique

the list of components that have been tagged with this tag

Responses
200

Successful operation

500

Unable to save list of tags.

post/componentmetadata/tags
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]

Disassociates all tags from the given components

Removes all tags from the passed componentIds. Note that currently this is done in a single DB query, so there is a single combined response for the entire operation.

Request
query Parameters
componentIds
required
string

Comma-separated list of componentIds to operate on.

componentType
required
string

The component type to operate on.

Enum: "segment" "dashboard" "bookmark" "calculatedMetric" "project" "dateRange" "metric" "dimension" "virtualReportSuite" "scheduledJob" "alert" "classificationSet" "dataView"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

400

Invalid component type.

500

Unable to remove tags for given components.

delete/componentmetadata/tags
Response samples
application/json
[
  • {
    }
]

Retrieves an tag by its id

Request
path Parameters
id
required
integer <int32>

Tag ID to be retrieved

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Unable to find a tag with the given ID

500

Unexpected server error while trying to retrieve tag

get/componentmetadata/tags/{id}
Response samples
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "components": [
    ]
}

Removes the tagId and all associations from that tag to any components

Delete by tagId. Will un-tag any/all components that were associated with the passed tagId.

Request
path Parameters
id
required
integer <int32>

The tagId to be deleted

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

The given tagId does not exist

500

Unable to delete the given tagId.

delete/componentmetadata/tags/{id}
Response samples
application/json
[
  • {
    }
]

search for tags for several components at once

Request
query Parameters
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

items to search for

componentType
string
componentIds
Array of strings unique
dataId
string
Responses
200

Successful operation

post/componentmetadata/tags/component/search
Request samples
application/json
{
  • "componentType": "string",
  • "componentIds": [
    ],
  • "dataId": "string"
}
Response samples
application/json
{
  • "componentType": "string",
  • "componentId": "string",
  • "tags": [
    ]
}

Retrieves a tags for a given component by componentId and componentType

Given a componentId, return all tags associated with that component

Request
query Parameters
componentId
required
string

The componentId to operate on. Currently this is just the segmentId.

componentType
required
string

The component type to operate on.

Enum: "segment" "dashboard" "bookmark" "calculatedMetric" "project" "dateRange" "metric" "dimension" "virtualReportSuite" "scheduledJob" "alert" "classificationSet" "dataView"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

400

Invalid component type.

500

Unable to retrieve tags for given component.

get/componentmetadata/tags/search
Response samples
application/json
[
  • {
    }
]

Retrieves component ids associated with the given tag names

Given a comma separated list of tag names, return component ids associated with them.

Request
query Parameters
tagNames
required
string

Comma separated list of tag names.

componentType
required
string

The component type to operate on.

Enum: "segment" "dashboard" "bookmark" "calculatedMetric" "project" "dateRange" "metric" "dimension" "virtualReportSuite" "scheduledJob" "alert" "classificationSet" "dataView"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

400

Invalid component type.

500

Unable to retrieve tags for given component.

get/componentmetadata/tags/tagnames
Response samples
application/json
[
  • "string"
]

Tag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations

This endpoint allows many tags at once to be created/deleted. Any tags passed to this endpoint will become the only tags for that componentId (all other tags will be removed).

Request
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted object containing key-value pairs that conform to the schema

Array
componentType
string
componentId
string
Array of objects
Responses
200

Successful operation

500

Unable to save tag list.

put/componentmetadata/tags/tagitems
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
[
  • {
    }
]

Asset Management API

Retrieve counts of assets owned by a user

Request
path Parameters
imsUserId
required
string

The IMS user ID of the user

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

404

IMS User does not exist

get/componentmetadata/assets/{imsUserId}/counts
Response samples
application/json
[
  • {
    }
]

Transfer assets to the recipient user

Request
path Parameters
recipientImsUserId
required
string

The IMS user ID of the recipient user

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

The transfer data; maximum of 100 component IDs

Array
componentType
string
componentIds
Array of strings
Responses
200

Asset transfer completed with the status indicated in the response body

403

User is not authorized to transfer assets

404

Recipient User does not exist

put/componentmetadata/assets/{recipientImsUserId}/transfer
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "errors": [
    ],
  • "status": "status_partial_success"
}

Reporting API

Runs a report for the request in the post body

See the Reporting User Guide for details.

Request
query Parameters
includeOberonXml
boolean
Default: false

Controls if Oberon XML should be returned in the response - DEBUG ONLY

Enum: true false
includePlatformPredictiveObjects
boolean
Default: false

Controls if platform Predictive Objects should be returned in the response. Only available when using Anomaly Detection or Forecasting- DEBUG ONLY

Enum: true false
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional
rsid
string
dataId
string
dimension
string
object
Array of objects
object
object
object
object
object
object
anchorDate
string
Responses
200

Successful operation

400

Invalid input; name, dataId, and definition are all required. Definition must be formatted as a JSON Object.

post/reports
Request samples
application/json
{
  • "rsid": "string",
  • "dataId": "string",
  • "dimension": "string",
  • "locale": {
    },
  • "globalFilters": [
    ],
  • "search": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "metricContainer": {
    },
  • "rowContainer": {
    },
  • "globalPredictiveSettings": {
    },
  • "anchorDate": "string"
}
Response samples
application/json
{
  • "totalPages": 0,
  • "firstPage": true,
  • "lastPage": true,
  • "numberOfElements": 0,
  • "number": 0,
  • "totalElements": 0,
  • "message": "string",
  • "request": {
    },
  • "reportId": "string",
  • "columns": {
    },
  • "rows": [
    ],
  • "summaryData": { },
  • "oberonRequestXML": [
    ],
  • "oberonResponseXML": [
    ],
  • "predictiveRequestObjects": [
    ],
  • "predictiveResponseObjects": [
    ]
}

Returns a top items report for the given dimension

Get the top X items (based on paging restriction) for the specified dimension and dataId. Defaults to last 90 days.

Search Clause examples: contains test: 'test'

contains test or test1: 'test' OR 'test1'

contains test and test1: 'test' AND 'test1'

contains test and not (test1 or test2): 'test' AND NOT ('test1' OR 'test2')

does not contain test: NOT 'test'

Request
query Parameters
dataId
required
string

Data Group or Data View to run the report against

dimension
required
string

Dimension to run the report against. Example: "variables/page"

locale
string
Default: "en_US"

Locale

dateRange
string

Format: YYYY-MM-DD/YYYY-MM-DD

search-clause
string

General search string; wrap with single quotes. Example: 'PageABC'

startDate
string

Format: YYYY-MM-DD

endDate
string

Format: YYYY-MM-DD

searchAnd
string

Search terms that will be AND-ed together. Space delimited.

searchOr
string

Search terms that will be OR-ed together. Space delimited.

searchNot
string

Search terms that will be treated as NOT including. Space delimited.

searchPhrase
string

A full search phrase that will be searched for.

includeOberonXml
boolean
Default: false

Controls if Oberon XML should be returned in the response - DEBUG ONLY

Enum: true false
lookupNoneValues
boolean
Default: true

Controls None values to be included

Enum: true false
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

403

User does not have access to run this report

500

Unexpected error; failed to run report

get/reports/topItems
Response samples
application/json
{
  • "totalPages": 0,
  • "firstPage": true,
  • "lastPage": true,
  • "numberOfElements": 0,
  • "number": 0,
  • "totalElements": 0,
  • "message": "string",
  • "reportId": "string",
  • "searchAnd": "string",
  • "searchOr": "string",
  • "searchNot": "string",
  • "searchPhrase": "string",
  • "rows": [
    ],
  • "oberonRequestXML": "string",
  • "oberonResponseXML": "string"
}

Dimensions API

Retrieval of dimensions for a dataview

Used to retrieve dimensions for a dataview

Request
path Parameters
dataviewId
required
string

The id of the DataView for which to retrieve Dimensions

query Parameters
includeType
Array of strings

Comma separated list of include types

Items Value: "hidden"
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "approved" "favorite" "tags" "usageSummary" "usageSummaryWithRelevancyScore" "description" "sourceFieldId" "segmentable" "required" "hideFromReporting" "hidden" "includeExcludeSetting" "fieldDefinition" "bucketingSetting" "noValueOptionsSetting" "defaultDimensionSort" "persistenceSetting" "storageId" "tableName" "dataSetIds" "dataSetType" "type" "schemaPath" "hasData" "sourceFieldName" "schemaType" "sourceFieldType" "fromGlobalLookup" "multiValued" "precision"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Could not find dimensions for dataview with given parameters

500

Internal error while retrieving dimensions

get/data/dataviews/{dataviewId}/dimensions
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "sourceFieldId": "string",
  • "sourceFieldName": "string",
  • "storageId": "string",
  • "dataSetIds": [
    ],
  • "dataSetType": "EVENT",
  • "schemaType": "string",
  • "sourceFieldType": "string",
  • "tableName": "string",
  • "type": "STRING",
  • "required": true,
  • "hideFromReporting": true,
  • "schemaPath": "string",
  • "hasData": true,
  • "segmentable": true,
  • "favorite": true,
  • "approved": true,
  • "tags": [
    ],
  • "shares": [
    ],
  • "usageSummary": {
    },
  • "notFound": true,
  • "hidden": true,
  • "fromGlobalLookup": true,
  • "multiValued": true,
  • "includeExcludeSetting": {
    },
  • "fieldDefinition": [
    ],
  • "bucketingSetting": {
    },
  • "noValueOptionsSetting": {
    },
  • "defaultDimensionSort": true,
  • "persistenceSetting": {
    },
  • "isDeleted": true
}

Retrieval of a specific dimension for a dataview

Used to retrieve a specific dimension for a dataview

Request
path Parameters
dataviewId
required
string

The id of the DataView the dimension is tied to

dimensionId
required
string

The id of the dimension to retrieve, must have the variables/ removed from the ID. For example "daterangeday", not "variables/daterangeday"

query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "approved" "favorite" "tags" "usageSummary" "usageSummaryWithRelevancyScore" "description" "sourceFieldId" "segmentable" "required" "hideFromReporting" "hidden" "includeExcludeSetting" "fieldDefinition" "bucketingSetting" "noValueOptionsSetting" "defaultDimensionSort" "persistenceSetting" "storageId" "tableName" "dataSetIds" "dataSetType" "type" "schemaPath" "hasData" "sourceFieldName" "schemaType" "sourceFieldType" "fromGlobalLookup" "multiValued" "precision"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Could not find dimensions for dataview with given parameters

500

Internal error while retrieving dimensions

get/data/dataviews/{dataviewId}/dimensions/{dimensionId}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "sourceFieldId": "string",
  • "sourceFieldName": "string",
  • "storageId": "string",
  • "dataSetIds": [
    ],
  • "dataSetType": "EVENT",
  • "schemaType": "string",
  • "sourceFieldType": "string",
  • "tableName": "string",
  • "type": "STRING",
  • "required": true,
  • "hideFromReporting": true,
  • "schemaPath": "string",
  • "hasData": true,
  • "segmentable": true,
  • "favorite": true,
  • "approved": true,
  • "tags": [
    ],
  • "shares": [
    ],
  • "usageSummary": {
    },
  • "notFound": true,
  • "hidden": true,
  • "fromGlobalLookup": true,
  • "multiValued": true,
  • "includeExcludeSetting": {
    },
  • "fieldDefinition": [
    ],
  • "bucketingSetting": {
    },
  • "noValueOptionsSetting": {
    },
  • "defaultDimensionSort": true,
  • "persistenceSetting": {
    },
  • "isDeleted": true
}

Metrics API

Retrieval of metrics for a dataview

Used to retrieve metrics for a dataview

Request
path Parameters
dataviewId
required
string

The id of the DataView for which to retrieve Metrics

query Parameters
includeType
Array of strings

Comma separated list of include types

Items Value: "hidden"
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "approved" "favorite" "tags" "usageSummary" "usageSummaryWithRelevancyScore" "description" "sourceFieldId" "segmentable" "required" "hideFromReporting" "hidden" "includeExcludeSetting" "fieldDefinition" "countType" "formatSetting" "attributionSetting" "storageId" "tableName" "dataSetIds" "dataSetType" "type" "schemaPath" "hasData" "sourceFieldName" "schemaType" "sourceFieldType" "fromGlobalLookup" "multiValued" "precision"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Could not find metrics for dataview with given parameters

500

Internal error while retrieving metrics

get/data/dataviews/{dataviewId}/metrics
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "sourceFieldId": "string",
  • "sourceFieldName": "string",
  • "storageId": "string",
  • "dataSetIds": [
    ],
  • "dataSetType": "EVENT",
  • "schemaType": "string",
  • "sourceFieldType": "string",
  • "tableName": "string",
  • "type": "STRING",
  • "required": true,
  • "hideFromReporting": true,
  • "schemaPath": "string",
  • "hasData": true,
  • "segmentable": true,
  • "favorite": true,
  • "approved": true,
  • "tags": [
    ],
  • "shares": [
    ],
  • "usageSummary": {
    },
  • "notFound": true,
  • "hidden": true,
  • "fromGlobalLookup": true,
  • "multiValued": true,
  • "includeExcludeSetting": {
    },
  • "fieldDefinition": [
    ],
  • "countType": "instances",
  • "formatSetting": {
    },
  • "attributionSetting": {
    },
  • "precision": 0,
  • "isDeleted": true
}

Retrieval of a specific metric for a dataview

Used to retrieve a specific metric for a dataview

Request
path Parameters
dataviewId
required
string

The id of the DataView the metric is tied to

metricId
required
string

The id of the metric to retrieve, must have the metrics/ removed from the ID. For example "visitors", not "metrics/visitors"

query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "approved" "favorite" "tags" "usageSummary" "usageSummaryWithRelevancyScore" "description" "sourceFieldId" "segmentable" "required" "hideFromReporting" "hidden" "includeExcludeSetting" "fieldDefinition" "countType" "formatSetting" "attributionSetting" "storageId" "tableName" "dataSetIds" "dataSetType" "type" "schemaPath" "hasData" "sourceFieldName" "schemaType" "sourceFieldType" "fromGlobalLookup" "multiValued" "precision"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Could not find metrics for dataview with given parameters

500

Internal error while retrieving metrics

get/data/dataviews/{dataviewId}/metrics/{metricId}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "sourceFieldId": "string",
  • "sourceFieldName": "string",
  • "storageId": "string",
  • "dataSetIds": [
    ],
  • "dataSetType": "EVENT",
  • "schemaType": "string",
  • "sourceFieldType": "string",
  • "tableName": "string",
  • "type": "STRING",
  • "required": true,
  • "hideFromReporting": true,
  • "schemaPath": "string",
  • "hasData": true,
  • "segmentable": true,
  • "favorite": true,
  • "approved": true,
  • "tags": [
    ],
  • "shares": [
    ],
  • "usageSummary": {
    },
  • "notFound": true,
  • "hidden": true,
  • "fromGlobalLookup": true,
  • "multiValued": true,
  • "includeExcludeSetting": {
    },
  • "fieldDefinition": [
    ],
  • "countType": "instances",
  • "formatSetting": {
    },
  • "attributionSetting": {
    },
  • "precision": 0,
  • "isDeleted": true
}

Dataviews API

Retrieval of Data Views for a Company

Used to retrieve Data Views for a company.

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"
parentDataGroupId
string

Filters data views by a single parentDataGroupId

externalIds
string

Comma-delimited list of external ids to limit the response with.

externalParentIds
string

Comma-delimited list of external parent ids to limit the response with.

dataViewIds
string

Comma-delimited list of data view ids to limit the response with.

includeType
Array of strings

Include additional DataViews not owned by user.

Items Value: "deleted"
cached
boolean
Default: true

return cached results

Enum: true false
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

sortDirection
string
Default: "ASC"

Sort direction (ASC or DESC

sortProperty
string
Default: "id"

Property to sort by (only modifiedDate and id are currently allowed)

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

404

Could not find dataViews for company with given parameters

500

Internal error while retrieving Data Views list

get/data/dataviews
Response samples
application/json
{
  • "content": [
    ],
  • "pageable": {
    },
  • "totalElements": 0,
  • "totalPages": 0,
  • "last": true,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "size": 0,
  • "number": 0,
  • "empty": true
}

Creation of Data Views

Stores the given Data View in the db.

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

JSON-formatted object representing a Data View

name
string
description
string
object
isDeleted
boolean
parentDataGroupId
string
segmentList
Array of strings
currentTimezoneOffset
number <float>
timezoneDesignator
string
modifiedDate
string <date-time>
createdDate
string <date-time>
organization
string
modifiedBy
string
curationEnabled
boolean
recentRecordedAccess
string <date>
Array of objects
object
object
id
string
Responses
200

Successful operation

400

Data View body is invalid

401

Unauthorized

404

Unable to find parentDataGroup

500

Unable to communicate with database

post/data/dataviews
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}

Retrieval of a Data View by dataViewId

Used to retrieve a Data View by id

Request
path Parameters
dataViewId
required
string

The Data View id to lookup

query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

401

Unauthorized

404

Unable to find Data View ID

500

Internal error while retrieving Data View

get/data/dataviews/{dataViewId}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}

Modification of a Data View by dataViewId

Used to update a Data View by id with the given Data View data

Request
path Parameters
dataViewId
required
string

The Data View id to update

query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

JSON-formatted object representing a Data View

name
string
description
string
object
isDeleted
boolean
parentDataGroupId
string
segmentList
Array of strings
currentTimezoneOffset
number <float>
timezoneDesignator
string
modifiedDate
string <date-time>
createdDate
string <date-time>
organization
string
modifiedBy
string
curationEnabled
boolean
recentRecordedAccess
string <date>
Array of objects
object
object
id
string
Responses
200

Successful operation

401

Unauthorized

404

Could not find Data View with given dataViewId

500

Internal error while updating the Data View

put/data/dataviews/{dataViewId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}

Deletion of a Data View by dataViewId

Used to remove a Data View by id

Request
path Parameters
dataViewId
required
string

The Data View id to remove

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

401

Unauthorized

404

Could not find Data View with given dataViewId

500

Internal error while removing the Data View

delete/data/dataviews/{dataViewId}
Response samples
application/json
{
  • "result": "string",
  • "message": "string"
}

Copy a data view

Copy a Data View.

Request
path Parameters
dataViewId
required
string

The Data View id to lookup

query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "description" "owner" "isDeleted" "parentDataGroupId" "segmentList" "currentTimezoneOffset" "timezoneDesignator" "modified" "createdDate" "organization" "curationEnabled" "recentRecordedAccess" "sessionDefinition" "externalData" "containerNames"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

401

Unauthorized

404

Unable to find Data View ID

500

Internal error while retrieving Data View

put/data/dataviews/copy/{dataViewId}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}

Validates a data view

Validates a Data View.

Request
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted Object containing key/value pairs for virtual report suite creation.

name
string
description
string
object
isDeleted
boolean
parentDataGroupId
string
segmentList
Array of strings
currentTimezoneOffset
number <float>
timezoneDesignator
string
modifiedDate
string <date-time>
createdDate
string <date-time>
organization
string
modifiedBy
string
curationEnabled
boolean
recentRecordedAccess
string <date>
Array of objects
object
object
id
string
Responses
200

Successful operation

post/data/dataviews/validate
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "parentDataGroupId": "string",
  • "segmentList": [
    ],
  • "currentTimezoneOffset": 0,
  • "timezoneDesignator": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "curationEnabled": true,
  • "recentRecordedAccess": "2019-08-24",
  • "sessionDefinition": [
    ],
  • "externalData": {
    },
  • "containerNames": {
    },
  • "id": "string"
}
Response samples
application/json
{
  • "valid": true,
  • "message": "string",
  • "validator_version": "string"
}

Connections API

Retrieval of a connection by connectionId

Used to retrieve a connection by id

Request
path Parameters
connectionId
required
string

The id of the connection to lookup

query Parameters
expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "primaryIdType" "configuredContainers" "description" "owner" "isDeleted" "isDisabled" "dataSets" "createdDate" "modified" "caseSensitive" "organization" "components" "numDailyEvents" "externalData" "backfillEnabled" "granularBackfills" "granularStreaming" "backfillsSummaryConnection" "backfillsSummaryDataSets" "dataSetLastIngested" "componentType" "sandboxName" "sandboxId" "fieldsId" "floatPrecision" "dataRetentionMonths" "validationErrors" "resolveIdentityNamespace" "stitchedDataSets" "ownerFullName" "schemaInfo" "tags" "internalLabels"
locale
string
Default: "en_US"

Locale

includeHiddenDataSets
boolean
Default: false

Include hidden data sets

Enum: true false
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

404

resource_not_found - could not find connection with given parameters

500

unexpected_error - internal error while retrieving connection

get/data/connections/{connectionId}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "dataSets": [
    ],
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "organization": "string",
  • "modifiedBy": "string",
  • "modifiedByFullName": "string",
  • "backfillEnabled": true,
  • "sandboxId": "string",
  • "sandboxName": "string",
  • "floatPrecision": 0,
  • "dataRetentionMonths": 0,
  • "connectionValidationErrors": [
    ],
  • "tags": [
    ],
  • "backfillSummary": {
    },
  • "idWithoutPrefix": "ff873abe-5700-45f8-a5cb-8b777b7c7333",
  • "id": "string"
}

Retrieval of connections for an org

Used to retrieve connections for an org.

Request
query Parameters
dataSetIds
string

Comma-delimited list of dataSet ids to limit the response with

connectionIds
string

Comma-delimited list of connectionIds to limit the response with

sandboxId
string

Filter by sandbox id

sandboxName
string

Filter by sandbox name

expansion
Array of strings

Comma-delimited list of additional fields to include on response

Items Enum: "name" "primaryIdType" "configuredContainers" "description" "owner" "isDeleted" "isDisabled" "dataSets" "createdDate" "modified" "caseSensitive" "organization" "components" "numDailyEvents" "externalData" "backfillEnabled" "granularBackfills" "granularStreaming" "backfillsSummaryConnection" "backfillsSummaryDataSets" "dataSetLastIngested" "componentType" "sandboxName" "sandboxId" "fieldsId" "floatPrecision" "dataRetentionMonths" "validationErrors" "resolveIdentityNamespace" "stitchedDataSets"
includeType
Array of strings

Include additional connections

Items Enum: "systemUserOwned" "disabled"
filterByModifiedAfter
string

Filter list to only include connections modified since this date (ISO8601 format)

cached
boolean
Default: true

return cached results

Enum: true false
locale
string
Default: "en_US"

Locale

includeHiddenDataSets
boolean
Default: false

Include hidden data sets

Enum: true false
internalLabel
string

Filter by internal label

internalLabelNamespace
string

Filter by internal label namespace

limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

sortDirection
string
Default: "ASC"

Sort direction (ASC or DESC

sortProperty
string
Default: "id"

Property to sort by (only modifiedDate and id are currently allowed)

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

404

resource_not_found - could not find connections for company with given parameters

500

internal error while retrieving connections

get/data/connections
Response samples
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "pageable": {
    },
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "empty": true
}

Retrieval of connections for an org by connection

Used to retrieve connections for an org based on connectionId or connection name.

Request
query Parameters
query
string

Search by connection name or connectionId.

expansion
Array of strings

Comma-delimited list of additional fields to include on response.

Items Enum: "name" "primaryIdType" "configuredContainers" "description" "owner" "isDeleted" "isDisabled" "dataSets" "createdDate" "modified" "caseSensitive" "organization" "components" "numDailyEvents" "externalData" "backfillEnabled" "granularBackfills" "granularStreaming" "backfillsSummaryConnection" "backfillsSummaryDataSets" "dataSetLastIngested" "componentType" "sandboxName" "sandboxId" "fieldsId" "floatPrecision" "dataRetentionMonths" "validationErrors" "resolveIdentityNamespace" "stitchedDataSets" "ownerFullName" "schemaInfo" "tags" "internalLabels"
locale
string
Default: "en_US"

Locale

includeHiddenDataSets
boolean
Default: false

Include hidden data sets

Enum: true false
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

Responses
200

successful operation

404

resource_not_found - could not find connections for company with given parameters

500

unexpected_error - internal error while retrieving connections

get/data/connections/search
Response samples
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "pageable": {
    },
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "empty": true
}

Filters API

Retrieves paginated segments

A segment response will always include these default items:
id

Other attributes can be optionally requested through the 'expansion' field:
name: Name of the segment
description: Description of the segment
dataId: Associated Data ID of the segment
owner: Owner of the segment
modified: Date that the segment was last modified (ISO 8601)
definition: Segment definition as JSON object
compatibility: Products that the segment is compatible with
isDeleted: Returns whether or not the segment is 'Deleted' (note that deleted segments are only returned if requested by ID)

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional segment metadata fields to include on response.

Items Enum: "compatibility" "definition" "internal" "modified" "isDeleted" "definitionLastModified" "createdDate" "recentRecordedAccess" "performanceScore" "owner" "dataId" "ownerFullName" "dataName" "sharesFullName" "approved" "favorite" "shares" "tags" "usageSummary" "usageSummaryWithRelevancyScore"
includeType
Array of strings

Include additional segments not owned by user.

Items Enum: "shared" "templates" "deleted" "internal"
dataIds
string

Filter list to only include segments tied to the specified data group ID list (comma-delimited)

ownerId
string

Filter list to only include segments owned by the specified imsUserId

filterByIds
string

Filter list to only include segments in the specified list (comma-delimited list of IDs). This has filtered Ids from tags, approved, favorites and user specified Ids list.

toBeUsedInRsid
string

The report suite where the segment is intended to be used. This report suite will be used to determine things like compatibility and permissions.

locale
string
Default: "en_US"

Locale

name
string

Filter list to only include segments that contains the Name

filterByModifiedAfter
string

Filter list to only include segments modified since this date (ISO8601 format)

cached
boolean
Default: true

return cached results

Enum: true false
pagination
string
Default: "true"

Return paginated results

Enum: "true" "false"
limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

sortDirection
any
Default: "ASC"

Sort direction (ASC or DESC

sortProperty
string
Default: "id"

Property to sort by (name, modified_date, performanceScore, id is currently allowed)

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

400

Unable to retrieve list of segments shared with user

401

Owner filter error; user specified is not in the same organization as the requesting user

403

Requesting non-shared segments for other users is restricted to admin users

500

External API error; Segment retrieval failed

get/filters
Response samples
application/json
{
  • "property1": { },
  • "property2": { }
}

Creates configuration for a Filters.

Request
query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional segment metadata fields to include on response.

Items Enum: "compatibility" "definition" "internal" "modified" "isDeleted" "definitionLastModified" "createdDate" "recentRecordedAccess" "performanceScore" "owner" "dataId" "ownerFullName" "dataName" "sharesFullName" "approved" "favorite" "shares" "tags" "usageSummary" "usageSummaryWithRelevancyScore"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted Object containing key/value pairs to be updated.

name
string
description
string
modified
string <date-time>
report_suite
string
modifiedById
string
object
object
createDate
string <date-time>
createdBy
string
disabled
boolean
internal
boolean
organization
string
template
boolean
recentRecordedAccess
string <date-time>
performanceScore
string
performanceScoreWeightVersion
string
id
string
definitionLastModified
string <date-time>
dataId
string
object
isDeleted
boolean
dataName
string
Array of objects
Array of objects
approved
boolean
favorite
boolean
object
Responses
200

Successful operation

post/filters
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "report_suite": "string",
  • "modifiedById": "string",
  • "definition": {
    },
  • "compatibility": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "disabled": true,
  • "internal": true,
  • "organization": "string",
  • "template": true,
  • "recentRecordedAccess": "2019-08-24T14:15:22Z",
  • "performanceScore": "string",
  • "performanceScoreWeightVersion": "string",
  • "id": "string",
  • "definitionLastModified": "2019-08-24T14:15:22Z",
  • "dataId": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "dataName": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    }
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "report_suite": "string",
  • "modifiedById": "string",
  • "definition": {
    },
  • "compatibility": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "disabled": true,
  • "internal": true,
  • "organization": "string",
  • "template": true,
  • "recentRecordedAccess": "2019-08-24T14:15:22Z",
  • "performanceScore": "string",
  • "performanceScoreWeightVersion": "string",
  • "id": "string",
  • "definitionLastModified": "2019-08-24T14:15:22Z",
  • "dataId": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "dataName": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    }
}

Validate a Segment

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

Request
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

Segment definition

string
Responses
200

Successful operation

400

Bad JSON input; request not formatted correctly

500

Unexpected error;

post/filters/validate
Request samples
application/json
"string"
Response samples
application/json
{
  • "valid": true,
  • "message": "string",
  • "validator_version": "string",
  • "supported_products": [
    ],
  • "supported_schema": [
    ],
  • "supported_features": [
    ],
  • "errors": [
    ]
}

Retrieves a single segment by ID

A segment response will always include these default items:
id

Other attributes can be optionally requested through the 'expansion' field:
name: Name of the segment
description: Description of the segment
dataId: Associated Data ID of the segment
owner: Owner of the segment
modified: Date that the segment was last modified (ISO 8601)
definition: Segment definition as JSON object
compatibility: Products that the segment is compatible with
isDeleted: Returns whether or not the segment is 'Deleted' (note that deleted segments are only returned if requested by ID)

Request
path Parameters
id
required
string

The segment ID to retrieve

query Parameters
toBeUsedInRsid
string

The report suite where the segment is intended to be used. This report suite will be used to determine things like compatibility and permissions.

locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional segment metadata fields to include on response.

Items Enum: "compatibility" "definition" "internal" "modified" "isDeleted" "definitionLastModified" "createdDate" "recentRecordedAccess" "performanceScore" "owner" "dataId" "ownerFullName" "dataName" "sharesFullName" "approved" "favorite" "shares" "tags" "usageSummary" "usageSummaryWithRelevancyScore"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

403

Requesting non-shared segments for other users is restricted to admin users

500

External API error; segment retrieval failed

get/filters/{id}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "report_suite": "string",
  • "modifiedById": "string",
  • "definition": {
    },
  • "compatibility": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "disabled": true,
  • "internal": true,
  • "organization": "string",
  • "template": true,
  • "recentRecordedAccess": "2019-08-24T14:15:22Z",
  • "performanceScore": "string",
  • "performanceScoreWeightVersion": "string",
  • "id": "string",
  • "definitionLastModified": "2019-08-24T14:15:22Z",
  • "dataId": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "dataName": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    }
}

Make changes or updates to an existing segment

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

Note: "aamStatus" is used to "publish" a report suite segment to other products in the Experience Cloud. Description is always required when publishing with aamStatus. The report suite must already be pre-configured for AAM for publishing to succeed (see the "/segments/aamStatus/" endpoint for more information).
Format for aamStatus object:
"aamStatus":{"published":["rsid1","rsid2"]}

Example "defintion" for use in testing API below ("Page exists"):
"definition":{"func":"segment","container":{"func":"container","context":"hits","pred":{"func":"exists","description":"Page","val":{"func":"attr","name":"variables/page"}}},"version":[1,0,0]}

Response will be the newly modified segment object after the update request completes.

SegmentResponse
A segment response will always include these default items:
id

Other attributes can be optionally requested through the 'expansion' field:
name: Name of the segment
description: Description of the segment
dataId: Associated Data ID of the segment
owner: Owner of the segment
modified: Date that the segment was last modified (ISO 8601)
definition: Segment definition as JSON object
compatibility: Products that the segment is compatible with
isDeleted: Returns whether or not the segment is 'Deleted' (note that deleted segments are only returned if requested by ID)

Request
path Parameters
id
required
string

Segment ID to be updated

query Parameters
expansion
Array of strings

Comma-delimited list of additional segment metadata fields to include on response.

Items Enum: "compatibility" "definition" "internal" "modified" "isDeleted" "definitionLastModified" "createdDate" "recentRecordedAccess" "performanceScore" "owner" "dataId" "ownerFullName" "dataName" "sharesFullName"
locale
string
Default: "en_US"

Locale

cached
boolean
Default: true

Use cached results

Enum: true false
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
optional

JSON-formatted Object containing key/value pairs to be updated.

name
string
description
string
modified
string <date-time>
report_suite
string
modifiedById
string
object
object
createDate
string <date-time>
createdBy
string
disabled
boolean
internal
boolean
organization
string
template
boolean
recentRecordedAccess
string <date-time>
performanceScore
string
performanceScoreWeightVersion
string
id
string
definitionLastModified
string <date-time>
dataId
string
object
isDeleted
boolean
dataName
string
Array of objects
Array of objects
approved
boolean
favorite
boolean
object
Responses
200

Successful operation

400

Definition must be formatted as a JSON Object

401

Company mismatch; segment ownership can only be transferred within the same organization

403

User does not have permission to update this segment

500

External API error; Segment update or retrieval failed

put/filters/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "report_suite": "string",
  • "modifiedById": "string",
  • "definition": {
    },
  • "compatibility": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "disabled": true,
  • "internal": true,
  • "organization": "string",
  • "template": true,
  • "recentRecordedAccess": "2019-08-24T14:15:22Z",
  • "performanceScore": "string",
  • "performanceScoreWeightVersion": "string",
  • "id": "string",
  • "definitionLastModified": "2019-08-24T14:15:22Z",
  • "dataId": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "dataName": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    }
}
Response samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "report_suite": "string",
  • "modifiedById": "string",
  • "definition": {
    },
  • "compatibility": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "disabled": true,
  • "internal": true,
  • "organization": "string",
  • "template": true,
  • "recentRecordedAccess": "2019-08-24T14:15:22Z",
  • "performanceScore": "string",
  • "performanceScoreWeightVersion": "string",
  • "id": "string",
  • "definitionLastModified": "2019-08-24T14:15:22Z",
  • "dataId": "string",
  • "owner": {
    },
  • "isDeleted": true,
  • "dataName": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "approved": true,
  • "favorite": true,
  • "usageSummary": {
    }
}

Deletion of a Segment by Id

Request
path Parameters
id
required
string

ID of segment to be deleted

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

500

Segment delete failed

delete/filters/{id}
Response samples
application/json
{
  • "result": "string",
  • "message": "string"
}

Audit Logs

Retrieve audit logs for Customer Journey Analytics.

This API returns a filterable list of audit log records.

Request
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-user-auth
required
any

IMS User Access Token

Responses
200

Successful operation

400

Validation errors.

500

Unexpected error; Searching audit logs failed due to an internal error.

post/auditlogs/api/v1/auditlogs/search

Get audit logs for Customer Journey Analytics.

This API returns a filterable list of audit log records.

Request
query Parameters
startDate
any

Date is not required, but if you filter by date, both start & end date must be set. When date range is undefined, start date defaults to 3 months ago.

endDate
any

Date is not required, but if you filter by date, both start & end date must be set. When date range is undefined, end date defaults to today.

action
any

The action you want to filter by.

component
any

The type of component you want to filter by.

componentId
any

The ID of the component.

userType
any

The type of user.

userId
any

The ID of the user.

userEmail
any

The email address of the user.

description
any

The log description you want to filter by.

pageSize
any

Number of results per page. If left null, the default size will be set to 100.

pageNumber
any

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-user-auth
required
any

IMS User Access Token

Responses
200

Successful operation

400

Validation errors.

500

Unexpected error; Searching audit logs failed due to an internal error.

get/auditlogs/api/v1/auditlogs

Date Range APIs

Returns a list of dateranges for the user

This API allows users to store commonly used date ranges so that they can be reused throughout the product.

Request
query Parameters
locale
string
Default: "en_US"

Locale

filterByIds
string

Filter list to only include date ranges in the specified list (comma-delimited list of IDs). This has filtered Ids from tags, approved, favorites and user specified Ids list.

limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

expansion
Array of strings

Comma-delimited list of additional date range metadata fields to include on response.

Items Enum: "definition" "modified" "ownerFullName" "sharesFullName" "shares" "tags"
includeType
Array of strings

Include additional date ranges not owned by user.

Items Enum: "shared" "templates"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

get/dateranges
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "definition": { },
  • "tags": [
    ],
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

Creates configuration for a DateRange.

Request
query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional date range metadata fields to include on response.

Items Enum: "definition" "modified" "ownerFullName" "sharesFullName" "shares" "tags"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

Date Range request body

name
string
description
string
rsid
string

The report suite id for which the component was created/updated

object (Owner)
definition
object
Array of objects (Tag)
siteTitle
string
modified
string <date-time>
created
string <date-time>
Responses
200

successful operation

post/dateranges
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "owner": {
    },
  • "definition": { },
  • "tags": [
    ],
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "definition": { },
  • "tags": [
    ],
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

Retrieves configuration for a DateRange.

Request
path Parameters
id
required
string

Date Range ID to be retrieved

query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional date range metadata fields to include on response.

Items Enum: "definition" "modified" "ownerFullName" "sharesFullName" "shares" "tags"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

get/dateranges/{id}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "definition": { },
  • "tags": [
    ],
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

Updates configuration for a DateRange.

Request
path Parameters
id
required
string

Date Range ID to be updated

query Parameters
locale
string
Default: "en_US"

Locale

expansion
Array of strings

Comma-delimited list of additional date range metadata fields to include on response.

Items Enum: "definition" "modified" "ownerFullName" "sharesFullName" "shares" "tags"
header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

Date Range request body

name
string
description
string
rsid
string

The report suite id for which the component was created/updated

object (Owner)
definition
object
Array of objects (Tag)
siteTitle
string
modified
string <date-time>
created
string <date-time>
Responses
200

successful operation

put/dateranges/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "owner": {
    },
  • "definition": { },
  • "tags": [
    ],
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "definition": { },
  • "tags": [
    ],
  • "siteTitle": "string",
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

Deletes a DateRange.

Request
path Parameters
id
required
string

Date Range ID to be deleted

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

Successful operation

delete/dateranges/{id}
Response samples
application/json
{
  • "result": "string",
  • "message": "string"
}

Projects APIs

Retrieves configuration for a Project.

Request
path Parameters
id
required
string

The Project id for which to retrieve information

query Parameters
expansion
Array of strings

Comma-delimited list of additional project metadata fields to include on response.

Items Enum: "shares" "tags" "accessLevel" "modified" "externalReferences" "definition"
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

get/projects/{id}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "type": "project",
  • "definition": { },
  • "externalReferences": {
    },
  • "accessLevel": "string",
  • "versionNotes": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

Updates configuration for a project.

Request
path Parameters
id
required
string

The Project id for which to retrieve information

query Parameters
expansion
Array of strings

Comma-delimited list of additional project metadata fields to include on response.

Items Enum: "shares" "tags" "accessLevel" "modified" "externalReferences" "definition"
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

Project request body

name
string
description
string
rsid
string

The report suite id for which the component was created/updated

object (Owner)
type
string
Enum: "project" "mobileScorecard"
definition
object (JsonNode)
object
accessLevel
string
versionNotes
string
Array of objects
Array of objects
modified
string <date-time>
created
string <date-time>
Responses
200

successful operation

put/projects/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "owner": {
    },
  • "type": "project",
  • "definition": { },
  • "externalReferences": {
    },
  • "accessLevel": "string",
  • "versionNotes": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "type": "project",
  • "definition": { },
  • "externalReferences": {
    },
  • "accessLevel": "string",
  • "versionNotes": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}

deletes a project.

Request
path Parameters
id
required
string

The Project id for which to retrieve information

query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

delete/projects/{id}
Response samples
application/json
{
  • "result": "string",
  • "message": "string"
}

Validates a Project definition

Request
query Parameters
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

Project request body

object (AnalyticsProject)
Responses
200

successful operation

400

Invalid input; definition is required. Definition must be formatted as a JSON Object.

500

External API error; Project validation failed

post/projects/validate
Request samples
application/json
{
  • "project": {
    }
}
Response samples
application/json
{
  • "valid": true,
  • "validatorVersion": "string",
  • "message": "string"
}

Returns a list of projects for the user

This Returns the projects list primarily for the Analytics product.

Request
query Parameters
includeType
Array of strings

Include additional segments not owned by user.

Items Enum: "all" "shared"
expansion
Array of strings

Comma-delimited list of additional project metadata fields to include on response.

Items Enum: "shares" "tags" "accessLevel" "modified" "externalReferences" "definition"
locale
string
Default: "en_US"

Locale

filterByIds
string

Filter list to only include projects in the specified list (comma-delimited list of IDs)

pagination
string
Default: "true"

return paginated results

Enum: "true" "false"
ownerId
string

Filter list to only include projects owned by the specified imsUserId

limit
integer
Default: 10

Number of results per page

page
integer
Default: 0

Page number (base 0 - first page is "0")

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Responses
200

successful operation

get/projects
Response samples
application/json
[
  • {
    }
]

Creates a single project.

Request
query Parameters
expansion
Array of strings

Comma-delimited list of additional project metadata fields to include on response.

Items Enum: "shares" "tags" "accessLevel" "modified" "externalReferences" "definition"
locale
string
Default: "en_US"

Locale

header Parameters
Authorization
required
string

The access token copied from your CJA API client integration, prefixed with "Bearer ". For more information on how to obtain this value, see Getting started with the CJA API.

x-api-key
required
string

The API key copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

x-gw-ims-org-id
required
string

The Organization ID copied from your CJA API client integration. For more information on how to obtain this value, see Getting started with the CJA API.

Request Body schema: application/json
required

Project request body

name
string
description
string
rsid
string

The report suite id for which the component was created/updated

object (Owner)
type
string
Enum: "project" "mobileScorecard"
definition
object (JsonNode)
object
accessLevel
string
versionNotes
string
Array of objects
Array of objects
modified
string <date-time>
created
string <date-time>
Responses
200

successful operation

post/projects
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "owner": {
    },
  • "type": "project",
  • "definition": { },
  • "externalReferences": {
    },
  • "accessLevel": "string",
  • "versionNotes": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "rsid": "string",
  • "reportSuiteName": "string",
  • "owner": {
    },
  • "type": "project",
  • "definition": { },
  • "externalReferences": {
    },
  • "accessLevel": "string",
  • "versionNotes": "string",
  • "tags": [
    ],
  • "shares": [
    ],
  • "modified": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z"
}