{
"openapi": "3.0.1",
"info": {
"title": "CJA APIs",
"description": "Open API specification for Customer Journey Analytics APIs. \n\n 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. \n\n **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](https://developer.adobe.com/cja-apis/docs/credentials/). \n\n **Related documentation**: [CJA API endpoint guides](https://developer.adobe.com/cja-apis/docs/endpoints/)",
"version": "0.1.0"
},
"servers": [
{
"url": "https://cja.adobe.io"
}
],
"paths": {
"/configuration/users/me": {
"get": {
"tags": [
"Configuration API"
],
"summary": "Returns the current user",
"operationId": "getCurrentUser",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"admin"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"countryCode": {
"type": "string"
},
"mrktPermEmail": {
"type": "boolean"
},
"emailVerified": {
"type": "boolean"
},
"first_name": {
"type": "string"
},
"organization": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"email": {
"type": "string"
},
"userId": {
"type": "string"
},
"name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"utcOffset": {
"type": "string"
},
"mrktPerm": {
"type": "string"
},
"displayName": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"principal": {
"type": "string"
},
"organization": {
"type": "string"
},
"named_role": {
"type": "string"
},
"target": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"/configuration/org/users": {
"get": {
"tags": [
"Configuration API"
],
"summary": "Returns all CJA IMS Users associated with the provided organization",
"operationId": "getImsUsers_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"images"
]
}
}
},
{
"name": "useCache",
"in": "query",
"description": "useCache",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageImsUser"
}
}
}
}
}
}
},
"/calculatedmetrics/{id}": {
"get": {
"tags": [
"Calculated Metrics API"
],
"summary": "Retrieve a single calculated metric by id",
"description": "A calculated metric response will always include these default items: *id, name, description, rsid, owner, polarity, precision, type* \n\nOther attributes can be optionally requested through the 'expansion' field:\n\n* *modified*: Date that the metric was last modified (ISO 8601)\n* *definition*: Calculated metric definition as JSON object\n* *compatibility*: Products that the metric is compatible with\n* *reportSuiteName*: Also return the friendly Report Suite name for the RSID\n* *tags*: Gives all existing tags associated with the calculated metric\n\nFor more information about calculated metrics go [here](https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/calculatedmetrics.md)\n\n",
"operationId": "findOneCalculatedMetric_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The calculated metric ID to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"approved",
"favorite",
"shares",
"tags",
"sharesFullName",
"usageSummary",
"usageSummaryWithRelevancyScore",
"reportSuiteName",
"siteTitle",
"ownerFullName",
"modified",
"migratedIds",
"isDeleted",
"definition",
"authorization",
"compatibility",
"legacyId",
"internal",
"dataGroup",
"categories",
"reportTimeAttribution",
"warning"
]
}
}
},
{
"name": "includeHidden",
"in": "query",
"description": "Whether to include variables that are hidden in the UI or that the user doesn't have permission to.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "toBeUsedInRsid",
"in": "query",
"description": "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.",
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"required": [
"definition"
],
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"reportSuiteName": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dataName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"migratedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"internal": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {}
},
"polarity": {
"type": "string",
"description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
"enum": [
"positive",
"negative"
]
},
"alternateVariableNames": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"baseName": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"precision": {
"type": "integer",
"description": "Number of decimal places to include in calculated metric result",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"CURRENCY",
"TIME",
"DECIMAL",
"PERCENT"
]
},
"definition": {
"type": "object",
"properties": {},
"description": "Calculated metric definition object"
},
"compatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"identityMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"dimensionView": {
"type": "string",
"enum": [
"LINEAR_ALLOCATION",
"PARTICIPATION_ALLOCATION",
"LAST_TOUCH_ALLOCATION",
"MC_FIRST_TOUCH_ALLOCATION",
"MC_LAST_TOUCH_ALLOCATION"
]
},
"allocationModel": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
}
}
}
},
"identityDimensions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"segments": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"legacyId": {
"type": "string"
},
"template": {
"type": "boolean"
},
"authorization": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"permissioned": {
"type": "boolean"
},
"unAuthorizedMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"unAuthorizedSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"notAllowedForReportingMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedForReporting": {
"type": "boolean"
}
}
},
"dataGroup": {
"type": "string"
},
"solution": {
"type": "boolean"
},
"curatedItem": {
"type": "boolean"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reportTimeAttribution": {
"type": "boolean"
},
"warning": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"helpLink": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"403": {
"description": "Requesting non-shared calculated metrics for other users is restricted to admin users",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "External API error; calculated metric retrieval failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
},
"put": {
"tags": [
"Calculated Metrics API"
],
"summary": "Update an existing calculated metric",
"description": "The following fields can be modified through this endpoint:
name, description, definition, owner, rsid\nExample \"defintion\" for use in testing API below (\"Visits per visitor\"):
\n\"definition\": {\r\n \"formula\": {\r\n \"func\": \"divide\",\r\n \"col1\": {\r\n \"func\": \"metric\",\r\n \"name\": \"metrics/visits\",\r\n \"description\": \"Visits\"\r\n },\r\n \"col2\": {\r\n \"func\": \"metric\",\r\n \"name\": \"metrics/visitors\",\r\n \"description\": \"Unique Visitors\"\r\n }\r\n },\r\n \"func\": \"calc-metric\",\r\n \"version\": [\r\n 1,\r\n 0,\r\n 0\r\n ]\r\n }
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* \n\nOther 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).",
"operationId": "calculatedmetrics_updateCalculatedMetric",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"approved",
"favorite",
"shares",
"tags",
"sharesFullName",
"usageSummary",
"usageSummaryWithRelevancyScore",
"reportSuiteName",
"siteTitle",
"ownerFullName",
"modified",
"migratedIds",
"isDeleted",
"definition",
"authorization",
"compatibility",
"legacyId",
"internal",
"dataGroup",
"categories",
"reportTimeAttribution",
"warning"
]
}
}
},
{
"name": "id",
"in": "path",
"description": "Calculated Metric ID to be updated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "cached",
"in": "query",
"description": "Use cached results",
"schema": {
"type": "boolean",
"default": true,
"enum": [
true,
false
]
}
}
],
"requestBody": {
"description": "JSON-formatted Object containing key/value pairs to be updated.",
"content": {
"application/json": {
"schema": {
"required": [
"definition"
],
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"reportSuiteName": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dataName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"migratedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"internal": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {}
},
"polarity": {
"type": "string",
"description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
"enum": [
"positive",
"negative"
]
},
"alternateVariableNames": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"baseName": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"precision": {
"type": "integer",
"description": "Number of decimal places to include in calculated metric result",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"CURRENCY",
"TIME",
"DECIMAL",
"PERCENT"
]
},
"definition": {
"type": "object",
"properties": {},
"description": "Calculated metric definition object"
},
"compatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"identityMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"dimensionView": {
"type": "string",
"enum": [
"LINEAR_ALLOCATION",
"PARTICIPATION_ALLOCATION",
"LAST_TOUCH_ALLOCATION",
"MC_FIRST_TOUCH_ALLOCATION",
"MC_LAST_TOUCH_ALLOCATION"
]
},
"allocationModel": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
}
}
}
},
"identityDimensions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"segments": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"legacyId": {
"type": "string"
},
"template": {
"type": "boolean"
},
"authorization": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"permissioned": {
"type": "boolean"
},
"unAuthorizedMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"unAuthorizedSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"notAllowedForReportingMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedForReporting": {
"type": "boolean"
}
}
},
"dataGroup": {
"type": "string"
},
"solution": {
"type": "boolean"
},
"curatedItem": {
"type": "boolean"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reportTimeAttribution": {
"type": "boolean"
},
"warning": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"helpLink": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"required": [
"definition"
],
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"reportSuiteName": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dataName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"migratedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"internal": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {}
},
"polarity": {
"type": "string",
"description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
"enum": [
"positive",
"negative"
]
},
"alternateVariableNames": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"baseName": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"precision": {
"type": "integer",
"description": "Number of decimal places to include in calculated metric result",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"CURRENCY",
"TIME",
"DECIMAL",
"PERCENT"
]
},
"definition": {
"type": "object",
"properties": {},
"description": "Calculated metric definition object"
},
"compatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"identityMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"dimensionView": {
"type": "string",
"enum": [
"LINEAR_ALLOCATION",
"PARTICIPATION_ALLOCATION",
"LAST_TOUCH_ALLOCATION",
"MC_FIRST_TOUCH_ALLOCATION",
"MC_LAST_TOUCH_ALLOCATION"
]
},
"allocationModel": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
}
}
}
},
"identityDimensions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"segments": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"legacyId": {
"type": "string"
},
"template": {
"type": "boolean"
},
"authorization": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"permissioned": {
"type": "boolean"
},
"unAuthorizedMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"unAuthorizedSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"notAllowedForReportingMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedForReporting": {
"type": "boolean"
}
}
},
"dataGroup": {
"type": "string"
},
"solution": {
"type": "boolean"
},
"curatedItem": {
"type": "boolean"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reportTimeAttribution": {
"type": "boolean"
},
"warning": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"helpLink": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"400": {
"description": "Definition must be formatted as a JSON Object",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Company mismatch; calculated metric ownership can only be transferred within the same organization",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"403": {
"description": "User does not have permission to update this calculated metric",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "External API error; Calculated metric update or retrieval failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"Calculated Metrics API"
],
"summary": "Deletion of Calculated Metrics by Id",
"operationId": "calculatedmetrics_deleteCalculatedMetric",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The calculated metric ID to be deleted",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "External API error; Calculated metric delete failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/calculatedmetrics": {
"get": {
"tags": [
"Calculated Metrics API"
],
"summary": "Retrieve many calculated metrics",
"description": "A calculated metric response will always include these default items: *id, name, description, rsid, owner, polarity, precision, type* \n\nOther attributes can be optionally requested through the 'expansion' field:\n\n* *modified*: Date that the metric was last modified (ISO 8601)\n* *definition*: Calculated metric definition as JSON object\n* *compatibility*: Products that the metric is compatible with\n* *reportSuiteName*: Also return the friendly Report Suite name for the RSID\n* *tags*: Gives all existing tags associated with the calculated metric\n\nFor more information about calculated metrics go [here](https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/calculatedmetrics.md)\n\n",
"operationId": "findCalculatedMetrics_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"dataName",
"approved",
"favorite",
"shares",
"tags",
"sharesFullName",
"usageSummary",
"usageSummaryWithRelevancyScore",
"reportSuiteName",
"siteTitle",
"ownerFullName",
"modified",
"migratedIds",
"isDeleted",
"definition",
"authorization",
"compatibility",
"legacyId",
"internal",
"dataGroup",
"categories"
]
}
}
},
{
"name": "includeType",
"in": "query",
"description": "Include additional calculated metrics not owned by user. The \"all\" option takes precedence over \"shared\"",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"shared",
"templates",
"unauthorized",
"deleted",
"internal",
"curatedItem"
]
}
}
},
{
"name": "dataIds",
"in": "query",
"description": "Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)",
"schema": {
"type": "string"
}
},
{
"name": "ownerId",
"in": "query",
"description": "Filter list to only include calculated metrics owned by the specified loginId",
"schema": {
"type": "string"
}
},
{
"name": "filterByIds",
"in": "query",
"description": "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",
"schema": {
"type": "string"
}
},
{
"name": "toBeUsedInRsid",
"in": "query",
"description": "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.",
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "favorite",
"in": "query",
"description": "Filter list to only include calculated metrics that are favorites",
"schema": {
"type": "boolean"
}
},
{
"name": "approved",
"in": "query",
"description": "Filter list to only include calculated metrics that are approved",
"schema": {
"type": "boolean"
}
},
{
"name": "pagination",
"in": "query",
"description": "return paginated results",
"schema": {
"type": "string",
"default": "true",
"enum": [
"true",
"false"
]
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (ASC or DESC)",
"schema": {
"type": "string",
"default": "ASC"
}
},
{
"name": "sortProperty",
"in": "query",
"description": "Property to sort by (name, modified_date, id is currently allowed)",
"schema": {
"type": "string",
"default": "id"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"required": [
"definition"
],
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"reportSuiteName": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dataName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"migratedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"internal": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {}
},
"polarity": {
"type": "string",
"description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
"enum": [
"positive",
"negative"
]
},
"alternateVariableNames": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"baseName": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"precision": {
"type": "integer",
"description": "Number of decimal places to include in calculated metric result",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"CURRENCY",
"TIME",
"DECIMAL",
"PERCENT"
]
},
"definition": {
"type": "object",
"properties": {},
"description": "Calculated metric definition object"
},
"compatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"identityMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"dimensionView": {
"type": "string",
"enum": [
"LINEAR_ALLOCATION",
"PARTICIPATION_ALLOCATION",
"LAST_TOUCH_ALLOCATION",
"MC_FIRST_TOUCH_ALLOCATION",
"MC_LAST_TOUCH_ALLOCATION"
]
},
"allocationModel": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
}
}
}
},
"identityDimensions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"segments": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"legacyId": {
"type": "string"
},
"template": {
"type": "boolean"
},
"authorization": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"permissioned": {
"type": "boolean"
},
"unAuthorizedMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"unAuthorizedSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"notAllowedForReportingMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedForReporting": {
"type": "boolean"
}
}
},
"dataGroup": {
"type": "string"
},
"solution": {
"type": "boolean"
},
"curatedItem": {
"type": "boolean"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reportTimeAttribution": {
"type": "boolean"
},
"warning": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"helpLink": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
},
"400": {
"description": "Unable to retrieve list of calculated metrics shared with user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Owner filter error; user specified is not in the same company as the requesting user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"403": {
"description": "Requesting non-shared calculated metrics for other users is restricted to admin users",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "External API error; Calculated metric retrieval failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/calculatedmetrics/functions": {
"get": {
"tags": [
"Calculated Metrics API"
],
"summary": "Retrieve calculated metric functions",
"operationId": "calculatedmetrics_getCalculatedMetricFunctions",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"category": {
"type": "string"
},
"persistable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"description": {
"type": "string"
},
"exampleKey": {
"type": "string"
},
"example": {
"type": "string"
},
"definition": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"friendlyNameKey": {
"type": "string"
},
"descKey": {
"type": "string"
},
"friendlyName": {
"type": "string"
},
"description": {
"type": "string"
},
"default-value": {
"type": "object",
"properties": {}
}
}
}
},
"formula": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"version": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
}
}
},
"500": {
"description": "External API error; Calculated metric functions retrieval failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/calculatedmetrics/functions/{id}": {
"get": {
"tags": [
"Calculated Metrics API"
],
"summary": "Retrieve a calculated metric function by id",
"operationId": "calculatedmetrics_getCalculatedMetricFunction",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The function ID to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"category": {
"type": "string"
},
"persistable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"description": {
"type": "string"
},
"exampleKey": {
"type": "string"
},
"example": {
"type": "string"
},
"definition": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"friendlyNameKey": {
"type": "string"
},
"descKey": {
"type": "string"
},
"friendlyName": {
"type": "string"
},
"description": {
"type": "string"
},
"default-value": {
"type": "object",
"properties": {}
}
}
}
},
"formula": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"version": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
}
},
"404": {
"description": "Calculated metric function not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "External API error; Calculated metric function retrieval failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/calculatedmetrics/validate": {
"post": {
"tags": [
"Calculated Metrics API"
],
"summary": "Validate a calculated metric definition",
"operationId": "calculatedmetrics_validateCalculatedMetric",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "migrating",
"in": "query",
"description": "Include migration functions in validation",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "JSON-formatted Object containing key/value pairs for calculated metric validation.",
"content": {
"application/json": {
"schema": {
"required": [
"definition"
],
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"reportSuiteName": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dataName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"migratedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"internal": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {}
},
"polarity": {
"type": "string",
"description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
"enum": [
"positive",
"negative"
]
},
"alternateVariableNames": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"baseName": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"precision": {
"type": "integer",
"description": "Number of decimal places to include in calculated metric result",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"CURRENCY",
"TIME",
"DECIMAL",
"PERCENT"
]
},
"definition": {
"type": "object",
"properties": {},
"description": "Calculated metric definition object"
},
"compatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"identityMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"dimensionView": {
"type": "string",
"enum": [
"LINEAR_ALLOCATION",
"PARTICIPATION_ALLOCATION",
"LAST_TOUCH_ALLOCATION",
"MC_FIRST_TOUCH_ALLOCATION",
"MC_LAST_TOUCH_ALLOCATION"
]
},
"allocationModel": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
}
}
}
},
"identityDimensions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"segments": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"legacyId": {
"type": "string"
},
"template": {
"type": "boolean"
},
"authorization": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"permissioned": {
"type": "boolean"
},
"unAuthorizedMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"unAuthorizedSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"notAllowedForReportingMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedForReporting": {
"type": "boolean"
}
}
},
"dataGroup": {
"type": "string"
},
"solution": {
"type": "boolean"
},
"curatedItem": {
"type": "boolean"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reportTimeAttribution": {
"type": "boolean"
},
"warning": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"helpLink": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"required": [
"definition"
],
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"reportSuiteName": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dataName": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"migratedIds": {
"type": "array",
"items": {
"type": "string"
}
},
"internal": {
"type": "boolean"
},
"owner": {
"type": "object",
"properties": {}
},
"polarity": {
"type": "string",
"description": "Set metric polarity, which indicates whether it's good or bad if a given metric goes up. Default=positive",
"enum": [
"positive",
"negative"
]
},
"alternateVariableNames": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"baseName": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"precision": {
"type": "integer",
"description": "Number of decimal places to include in calculated metric result",
"format": "int32"
},
"type": {
"type": "string",
"enum": [
"CURRENCY",
"TIME",
"DECIMAL",
"PERCENT"
]
},
"definition": {
"type": "object",
"properties": {},
"description": "Calculated metric definition object"
},
"compatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"identityMetrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"dimensionView": {
"type": "string",
"enum": [
"LINEAR_ALLOCATION",
"PARTICIPATION_ALLOCATION",
"LAST_TOUCH_ALLOCATION",
"MC_FIRST_TOUCH_ALLOCATION",
"MC_LAST_TOUCH_ALLOCATION"
]
},
"allocationModel": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
}
}
}
},
"identityDimensions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"segments": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"functions": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"legacyId": {
"type": "string"
},
"template": {
"type": "boolean"
},
"authorization": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
},
"permissioned": {
"type": "boolean"
},
"unAuthorizedMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"unAuthorizedSegmentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"notAllowedForReportingMetricIdentities": {
"type": "array",
"items": {
"type": "string"
}
},
"allowedForReporting": {
"type": "boolean"
}
}
},
"dataGroup": {
"type": "string"
},
"solution": {
"type": "boolean"
},
"curatedItem": {
"type": "boolean"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"reportTimeAttribution": {
"type": "boolean"
},
"warning": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"helpLink": {
"type": "string"
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"400": {
"description": "Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "External API error; Calculated metric validation failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"no_feature_access_to_advanced_calculated_metrics",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/componentmetadata/shares": {
"get": {
"tags": [
"Shares API"
],
"summary": "Returns all components that have been shared by the current user (meeting the paging restriction)",
"operationId": "findAllForCurrentUser_3",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "includeType",
"in": "query",
"description": "Include additional shares not owned by the user",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sharedTo"
]
}
}
},
{
"name": "userid",
"in": "query",
"description": "The user ID to return details for. Only admins may user this option.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareId": {
"type": "integer",
"format": "int64"
},
"imsOrgId": {
"type": "string"
},
"shareToId": {
"type": "integer",
"format": "int32"
},
"shareToImsId": {
"type": "string"
},
"shareToType": {
"type": "string"
},
"shareFromImsId": {
"type": "string"
},
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"shareToDisplayName": {
"type": "string"
},
"shareToLogin": {
"type": "string"
},
"accessLevel": {
"type": "string"
}
}
}
}
}
}
},
"500": {
"description": "Unable to retrieve list of components.",
"content": {}
}
}
},
"put": {
"tags": [
"Shares API"
],
"summary": "Share components with users. WARNING: Authoritative; deletes/overwrites all pre-existing shares for the given components",
"description": "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.
",
"operationId": "modifyShares_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"requestBody": {
"description": "JSON-formatted ARRAY of objects containing key-value pairs that conform to the schema",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"shares": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareToId": {
"type": "integer",
"format": "int32"
},
"shareToImsId": {
"type": "string"
},
"shareToType": {
"type": "string"
},
"accessLevel": {
"type": "string"
}
}
}
}
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"shares": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareToId": {
"type": "integer",
"format": "int32"
},
"shareToImsId": {
"type": "string"
},
"shareToType": {
"type": "string"
},
"accessLevel": {
"type": "string"
}
}
}
}
}
}
}
}
},
"400": {
"description": "Invalid component type, or mixed component types on request (only one type per request)",
"content": {}
},
"403": {
"description": "Permission error; user does not have access for the requested operation",
"content": {}
},
"500": {
"description": "Unable to save list of component shares",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/componentmetadata/shares/{id}": {
"get": {
"tags": [
"Shares API"
],
"summary": "Returns details about a specific share",
"operationId": "getShare_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The share ID to return details for",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"shareId": {
"type": "integer",
"format": "int64"
},
"imsOrgId": {
"type": "string"
},
"shareToId": {
"type": "integer",
"format": "int32"
},
"shareToImsId": {
"type": "string"
},
"shareToType": {
"type": "string"
},
"shareFromImsId": {
"type": "string"
},
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"shareToDisplayName": {
"type": "string"
},
"shareToLogin": {
"type": "string"
},
"accessLevel": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Invalid component type",
"content": {}
},
"403": {
"description": "Permission error; user does not have access to the share",
"content": {}
},
"500": {
"description": "Unable to retrieve share",
"content": {}
}
}
},
"delete": {
"tags": [
"Shares API"
],
"summary": "Deletes the share with the given id",
"description": "Delete by shareId and remove that share from all associated components.",
"operationId": "deleteShare_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The shareId to be deleted",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
},
"403": {
"description": "Permission error; user does not have access to delete the component",
"content": {}
},
"500": {
"description": "Unable to delete share",
"content": {}
}
}
}
},
"/componentmetadata/shares/sharedto/me": {
"get": {
"tags": [
"Shares API"
],
"summary": "Returns all component ids that have shared to the current user",
"operationId": "findAllSharesToCurrentUser_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "componentType",
"in": "query",
"description": "ComponentType to return",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/componentmetadata/shares/component/search": {
"post": {
"tags": [
"Shares API"
],
"summary": "search for shares for several components at once",
"operationId": "searchComponentTags_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional project metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"sharesFullName"
]
}
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"requestBody": {
"description": "items to search for",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"dataId": {
"type": "string"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"shares": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shareId": {
"type": "integer",
"format": "int64"
},
"imsOrgId": {
"type": "string"
},
"shareToId": {
"type": "integer",
"format": "int32"
},
"shareToImsId": {
"type": "string"
},
"shareToType": {
"type": "string"
},
"shareFromImsId": {
"type": "string"
},
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"shareToDisplayName": {
"type": "string"
},
"shareToLogin": {
"type": "string"
},
"accessLevel": {
"type": "string"
}
}
}
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/componentmetadata/tags": {
"get": {
"tags": [
"Tags API"
],
"summary": "Returns a list of tags for the current user's company",
"operationId": "findAllForCompany_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
}
},
"500": {
"description": "Unable to retrieve list of tags for user.",
"content": {}
}
}
},
"post": {
"tags": [
"Tags API"
],
"summary": "Saves the given tag(s) for the current user's company",
"description": "Allows creation of a new tag and applies that new tag to the passed component",
"operationId": "saveTagList_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
}
],
"requestBody": {
"description": "JSON-formatted array of Tag objects containing key-value pairs",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
}
},
"500": {
"description": "Unable to save list of tags.",
"content": {}
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"Tags API"
],
"summary": "Disassociates all tags from the given components",
"description": "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.",
"operationId": "deleteTagItems_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "componentIds",
"in": "query",
"description": "Comma-separated list of componentIds to operate on.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "componentType",
"in": "query",
"description": "The component type to operate on.",
"required": true,
"schema": {
"type": "string",
"enum": [
"segment",
"dashboard",
"bookmark",
"calculatedMetric",
"project",
"dateRange",
"metric",
"dimension",
"virtualReportSuite",
"scheduledJob",
"alert",
"classificationSet",
"dataView"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
},
"400": {
"description": "Invalid component type.",
"content": {}
},
"500": {
"description": "Unable to remove tags for given components.",
"content": {}
}
}
}
},
"/componentmetadata/tags/{id}": {
"get": {
"tags": [
"Tags API"
],
"summary": "Retrieves an tag by its id",
"operationId": "getTagById_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "Tag ID to be retrieved",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
},
"404": {
"description": "Unable to find a tag with the given ID",
"content": {}
},
"500": {
"description": "Unexpected server error while trying to retrieve tag",
"content": {}
}
}
},
"delete": {
"tags": [
"Tags API"
],
"summary": "Removes the tagId and all associations from that tag to any components",
"description": "Delete by tagId. Will un-tag any/all components that were associated with the passed tagId.",
"operationId": "deleteTag_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The tagId to be deleted",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
},
"404": {
"description": "The given tagId does not exist",
"content": {}
},
"500": {
"description": "Unable to delete the given tagId.",
"content": {}
}
}
}
},
"/componentmetadata/tags/component/search": {
"post": {
"tags": [
"Tags API"
],
"summary": "search for tags for several components at once",
"operationId": "searchComponentTags_3",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"requestBody": {
"description": "items to search for",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"dataId": {
"type": "string"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/componentmetadata/tags/search": {
"get": {
"tags": [
"Tags API"
],
"summary": "Retrieves a tags for a given component by componentId and componentType",
"description": "Given a componentId, return all tags associated with that component",
"operationId": "getTagListByComponentIdAndComponentType_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "componentId",
"in": "query",
"description": "The componentId to operate on. Currently this is just the segmentId.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "componentType",
"in": "query",
"description": "The component type to operate on.",
"required": true,
"schema": {
"type": "string",
"enum": [
"segment",
"dashboard",
"bookmark",
"calculatedMetric",
"project",
"dateRange",
"metric",
"dimension",
"virtualReportSuite",
"scheduledJob",
"alert",
"classificationSet",
"dataView"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
}
},
"400": {
"description": "Invalid component type.",
"content": {}
},
"500": {
"description": "Unable to retrieve tags for given component.",
"content": {}
}
}
}
},
"/componentmetadata/tags/tagnames": {
"get": {
"tags": [
"Tags API"
],
"summary": "Retrieves component ids associated with the given tag names",
"description": "Given a comma separated list of tag names, return component ids associated with them.",
"operationId": "getComponentsByTagName_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "tagNames",
"in": "query",
"description": "Comma separated list of tag names.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "componentType",
"in": "query",
"description": "The component type to operate on.",
"required": true,
"schema": {
"type": "string",
"enum": [
"segment",
"dashboard",
"bookmark",
"calculatedMetric",
"project",
"dateRange",
"metric",
"dimension",
"virtualReportSuite",
"scheduledJob",
"alert",
"classificationSet",
"dataView"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"description": "Invalid component type.",
"content": {}
},
"500": {
"description": "Unable to retrieve tags for given component.",
"content": {}
}
}
}
},
"/componentmetadata/tags/tagitems": {
"put": {
"tags": [
"Tags API"
],
"summary": "Tag a component with one or many tags at once. WARNING: Authoritative; deletes/overwrites all pre-existing associations",
"description": "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).",
"operationId": "saveTagComponentList_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
}
],
"requestBody": {
"description": "JSON-formatted object containing key-value pairs that conform to the schema",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the tag id",
"format": "int32"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"uniqueItems": true,
"type": "array",
"description": "the list of components that have been tagged with this tag",
"items": {
"type": "object"
}
}
},
"description": "Tag Model"
}
}
}
}
}
}
}
},
"500": {
"description": "Unable to save tag list.",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/componentmetadata/assets/{imsUserId}/counts": {
"get": {
"tags": [
"Asset Management API"
],
"summary": "Retrieve counts of assets owned by a user",
"operationId": "getAssetCounts_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "imsUserId",
"in": "path",
"description": "The IMS user ID of the user",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssetCount"
}
}
}
}
},
"404": {
"description": "IMS User does not exist",
"content": {}
}
}
}
},
"/componentmetadata/assets/{recipientImsUserId}/transfer": {
"put": {
"tags": [
"Asset Management API"
],
"summary": "Transfer assets to the recipient user",
"operationId": "transferAssets_2",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "recipientImsUserId",
"in": "path",
"description": "The IMS user ID of the recipient user",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The transfer data; maximum of 100 component IDs",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransferData"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Asset transfer completed with the status indicated in the response body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferResults"
}
}
}
},
"403": {
"description": "User is not authorized to transfer assets",
"content": {}
},
"404": {
"description": "Recipient User does not exist",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/reports": {
"post": {
"tags": [
"Reporting API"
],
"summary": "Runs a report for the request in the post body",
"description": "See the [Reporting User Guide](https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/reporting-guide.md) for details.",
"operationId": "runReport_2",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "includeOberonXml",
"in": "query",
"description": "Controls if Oberon XML should be returned in the response - DEBUG ONLY",
"schema": {
"type": "boolean",
"default": false,
"enum": [
true,
false
]
}
},
{
"name": "includePlatformPredictiveObjects",
"in": "query",
"description": "Controls if platform Predictive Objects should be returned in the response. Only available when using Anomaly Detection or Forecasting- DEBUG ONLY",
"schema": {
"type": "boolean",
"default": false,
"enum": [
true,
false
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dimension": {
"type": "string"
},
"locale": {
"type": "object",
"properties": {
"script": {
"type": "string"
},
"country": {
"type": "string"
},
"variant": {
"type": "string"
},
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"iso3Language": {
"type": "string"
},
"iso3Country": {
"type": "string"
},
"displayLanguage": {
"type": "string"
},
"displayScript": {
"type": "string"
},
"displayCountry": {
"type": "string"
},
"displayVariant": {
"type": "string"
},
"displayName": {
"type": "string"
},
"language": {
"type": "string"
}
}
},
"globalFilters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"DATE_RANGE",
"BREAKDOWN",
"SEGMENT",
"EXCLUDE_ITEM_IDS"
]
},
"dimension": {
"type": "string"
},
"itemId": {
"type": "string"
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"segmentId": {
"type": "string"
},
"segmentDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"dateRange": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"search": {
"type": "object",
"properties": {
"clause": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"empty": {
"type": "boolean"
}
}
},
"settings": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"dimensionSort": {
"type": "string"
},
"countRepeatInstances": {
"type": "boolean"
},
"reflectRequest": {
"type": "boolean"
},
"suiteReportingContext": {
"type": "string",
"enum": [
"DEVICE",
"TROMMEL_COMBINED"
]
},
"includeAnomalyDetection": {
"type": "boolean"
},
"includeForecasting": {
"type": "boolean"
},
"includePercentChange": {
"type": "boolean"
},
"sessionExpiration": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"inactivity",
"container",
"beforeEvents"
]
},
"events": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"containerName": {
"type": "string"
}
}
}
},
"darkSessionsEnabled": {
"type": "boolean"
},
"includeLatLong": {
"type": "boolean"
},
"dataSchema": {
"type": "string"
},
"justStitchedDataSchema": {
"type": "boolean"
},
"sampling": {
"type": "number",
"format": "double"
},
"samplingSeed": {
"type": "integer",
"format": "int32"
},
"samplingUpSample": {
"type": "boolean"
},
"nonesBehavior": {
"type": "string"
}
}
},
"statistics": {
"type": "object",
"properties": {
"functions": {
"type": "array",
"items": {
"type": "string"
}
},
"ignoreZeroes": {
"type": "boolean"
}
}
},
"metricContainer": {
"type": "object",
"properties": {
"metricFilters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"DATE_RANGE",
"BREAKDOWN",
"SEGMENT",
"EXCLUDE_ITEM_IDS"
]
},
"dimension": {
"type": "string"
},
"itemId": {
"type": "string"
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"segmentId": {
"type": "string"
},
"segmentDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"dateRange": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"columnId": {
"type": "string"
},
"allocationType": {
"type": "string"
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
},
"lookback": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"filters": {
"type": "array",
"items": {
"type": "string"
}
},
"sort": {
"type": "string"
},
"metricDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"metricView": {
"type": "string"
},
"predictive": {
"type": "object",
"properties": {
"anomalyConfidence": {
"type": "number",
"format": "double"
}
}
}
}
}
}
}
},
"rowContainer": {
"type": "object",
"properties": {
"rowFilters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"DATE_RANGE",
"BREAKDOWN",
"SEGMENT",
"EXCLUDE_ITEM_IDS"
]
},
"dimension": {
"type": "string"
},
"itemId": {
"type": "string"
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"segmentId": {
"type": "string"
},
"segmentDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"dateRange": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rowId": {
"type": "string"
},
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"globalPredictiveSettings": {
"type": "object",
"properties": {
"trainingPeriods": {
"type": "integer",
"format": "int32"
},
"highAnomalies": {
"type": "boolean"
},
"lowAnomalies": {
"type": "boolean"
}
}
},
"anchorDate": {
"type": "string"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"firstPage": {
"type": "boolean"
},
"lastPage": {
"type": "boolean"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"number": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"request": {
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"dataId": {
"type": "string"
},
"dimension": {
"type": "string"
},
"locale": {
"type": "object",
"properties": {
"script": {
"type": "string"
},
"country": {
"type": "string"
},
"variant": {
"type": "string"
},
"extensionKeys": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"unicodeLocaleAttributes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"unicodeLocaleKeys": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"iso3Language": {
"type": "string"
},
"iso3Country": {
"type": "string"
},
"displayLanguage": {
"type": "string"
},
"displayScript": {
"type": "string"
},
"displayCountry": {
"type": "string"
},
"displayVariant": {
"type": "string"
},
"displayName": {
"type": "string"
},
"language": {
"type": "string"
}
}
},
"globalFilters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"DATE_RANGE",
"BREAKDOWN",
"SEGMENT",
"EXCLUDE_ITEM_IDS"
]
},
"dimension": {
"type": "string"
},
"itemId": {
"type": "string"
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"segmentId": {
"type": "string"
},
"segmentDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"dateRange": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"search": {
"type": "object",
"properties": {
"clause": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"empty": {
"type": "boolean"
}
}
},
"settings": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"dimensionSort": {
"type": "string"
},
"countRepeatInstances": {
"type": "boolean"
},
"reflectRequest": {
"type": "boolean"
},
"suiteReportingContext": {
"type": "string",
"enum": [
"DEVICE",
"TROMMEL_COMBINED"
]
},
"includeAnomalyDetection": {
"type": "boolean"
},
"includePercentChange": {
"type": "boolean"
},
"sessionExpiration": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"inactivity",
"container",
"beforeEvents"
]
},
"events": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"containerName": {
"type": "string"
}
}
}
},
"darkSessionsEnabled": {
"type": "boolean"
},
"includeLatLong": {
"type": "boolean"
},
"dataSchema": {
"type": "string"
},
"justStitchedDataSchema": {
"type": "boolean"
},
"sampling": {
"type": "number",
"format": "double"
},
"samplingSeed": {
"type": "integer",
"format": "int32"
},
"samplingUpSample": {
"type": "boolean"
},
"nonesBehavior": {
"type": "string"
}
}
},
"statistics": {
"type": "object",
"properties": {
"functions": {
"type": "array",
"items": {
"type": "string"
}
},
"ignoreZeroes": {
"type": "boolean"
}
}
},
"metricContainer": {
"type": "object",
"properties": {
"metricFilters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"DATE_RANGE",
"BREAKDOWN",
"SEGMENT",
"EXCLUDE_ITEM_IDS"
]
},
"dimension": {
"type": "string"
},
"itemId": {
"type": "string"
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"segmentId": {
"type": "string"
},
"segmentDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"dateRange": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"columnId": {
"type": "string"
},
"allocationType": {
"type": "string"
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
},
"lookback": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"filters": {
"type": "array",
"items": {
"type": "string"
}
},
"sort": {
"type": "string"
},
"metricDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"metricView": {
"type": "string"
},
"predictive": {
"type": "object",
"properties": {
"anomalyConfidence": {
"type": "number",
"format": "double"
}
}
}
}
}
}
}
},
"rowContainer": {
"type": "object",
"properties": {
"rowFilters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"DATE_RANGE",
"BREAKDOWN",
"SEGMENT",
"EXCLUDE_ITEM_IDS"
]
},
"dimension": {
"type": "string"
},
"itemId": {
"type": "string"
},
"itemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"segmentId": {
"type": "string"
},
"segmentDefinition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"dateRange": {
"type": "string"
},
"excludeItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"enabled": {
"type": "boolean"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rowId": {
"type": "string"
},
"filters": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"globalPredictiveSettings": {
"type": "object",
"properties": {
"trainingPeriods": {
"type": "integer",
"format": "int32"
},
"highAnomalies": {
"type": "boolean"
},
"lowAnomalies": {
"type": "boolean"
}
}
},
"anchorDate": {
"type": "string"
}
}
},
"reportId": {
"type": "string"
},
"columns": {
"type": "object",
"properties": {
"dimension": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STRING",
"BOOLEAN",
"INT",
"DECIMAL",
"CURRENCY",
"PERCENT",
"TIME",
"ENUM",
"ORDERED_ENUM"
]
}
}
},
"columnIds": {
"type": "array",
"items": {
"type": "string"
}
},
"columnErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"columnId": {
"type": "string"
},
"errorCode": {
"type": "string",
"enum": [
"unauthorized_metric",
"unauthorized_dimension",
"unauthorized_dimension_global",
"unauthorized_segment",
"anomaly_detection_failure_unexpected_item_count",
"anomaly_detection_failure_tsa_service",
"not_enabled_metric",
"not_enabled_dimension",
"not_enabled_dimension_global"
]
},
"errorId": {
"type": "string"
},
"errorDescription": {
"type": "string"
}
}
}
}
}
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemId": {
"type": "string"
},
"value": {
"type": "string"
},
"rowId": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"dataExpected": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"dataUpperBound": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"dataLowerBound": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"dataAnomalyDetected": {
"type": "array",
"items": {
"type": "boolean"
}
},
"percentChange": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
},
"dataForecasted": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"dataForecastedUpperBound": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"dataForecastedLowerBound": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
}
}
}
},
"summaryData": {
"type": "object",
"properties": {}
},
"oberonRequestXML": {
"type": "array",
"items": {
"type": "string"
}
},
"oberonResponseXML": {
"type": "array",
"items": {
"type": "string"
}
},
"predictiveRequestObjects": {
"type": "array",
"items": {
"type": "string"
}
},
"predictiveResponseObjects": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"400": {
"description": "Invalid input; name, dataId, and definition are all required. Definition must be formatted as a JSON Object.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_segment_ids_found",
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/reports/topItems": {
"get": {
"tags": [
"Reporting API"
],
"summary": "Returns a top items report for the given dimension",
"description": "Get the top X items (based on paging restriction) for the specified dimension and dataId. Defaults to last 90 days.\n\nSearch Clause examples:\ncontains test: 'test'\n\n contains test or test1: 'test' OR 'test1'\n\ncontains test and test1: 'test' AND 'test1'\n\ncontains test and not (test1 or test2): 'test' AND NOT ('test1' OR 'test2')\n\ndoes not contain test: NOT 'test'\n\n",
"operationId": "NonCustomerFacingDoc",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataId",
"in": "query",
"description": "Data Group or Data View to run the report against",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dimension",
"in": "query",
"description": "Dimension to run the report against. Example: \"variables/page\"",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "dateRange",
"in": "query",
"description": "Format: YYYY-MM-DD/YYYY-MM-DD",
"schema": {
"type": "string"
}
},
{
"name": "search-clause",
"in": "query",
"description": "General search string; wrap with single quotes. Example: 'PageABC'",
"schema": {
"type": "string"
}
},
{
"name": "startDate",
"in": "query",
"description": "Format: YYYY-MM-DD",
"schema": {
"type": "string"
}
},
{
"name": "endDate",
"in": "query",
"description": "Format: YYYY-MM-DD",
"schema": {
"type": "string"
}
},
{
"name": "searchAnd",
"in": "query",
"description": "Search terms that will be AND-ed together. Space delimited.",
"schema": {
"type": "string"
}
},
{
"name": "searchOr",
"in": "query",
"description": "Search terms that will be OR-ed together. Space delimited.",
"schema": {
"type": "string"
}
},
{
"name": "searchNot",
"in": "query",
"description": "Search terms that will be treated as NOT including. Space delimited.",
"schema": {
"type": "string"
}
},
{
"name": "searchPhrase",
"in": "query",
"description": "A full search phrase that will be searched for.",
"schema": {
"type": "string"
}
},
{
"name": "includeOberonXml",
"in": "query",
"description": "Controls if Oberon XML should be returned in the response - DEBUG ONLY",
"schema": {
"type": "boolean",
"default": false,
"enum": [
true,
false
]
}
},
{
"name": "lookupNoneValues",
"in": "query",
"description": "Controls None values to be included",
"schema": {
"type": "boolean",
"default": true,
"enum": [
true,
false
]
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"firstPage": {
"type": "boolean"
},
"lastPage": {
"type": "boolean"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"number": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"reportId": {
"type": "string"
},
"searchAnd": {
"type": "string"
},
"searchOr": {
"type": "string"
},
"searchNot": {
"type": "string"
},
"searchPhrase": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"itemId": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"oberonRequestXML": {
"type": "string"
},
"oberonResponseXML": {
"type": "string"
}
}
}
}
}
},
"403": {
"description": "User does not have access to run this report",
"content": {}
},
"500": {
"description": "Unexpected error; failed to run report",
"content": {}
}
}
}
},
"/data/dataviews/{dataviewId}/dimensions": {
"get": {
"tags": [
"Dimensions API"
],
"summary": "Retrieval of dimensions for a dataview",
"description": "Used to retrieve dimensions for a dataview",
"operationId": "getDimensionsForDataview_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataviewId",
"in": "path",
"description": "The id of the DataView for which to retrieve Dimensions",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "includeType",
"in": "query",
"description": "Comma separated list of include types",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"hidden"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"sourceFieldId": {
"type": "string"
},
"sourceFieldName": {
"type": "string"
},
"storageId": {
"type": "string"
},
"dataSetIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"dataSetType": {
"type": "string",
"enum": [
"EVENT",
"LOOKUP",
"PROFILE"
]
},
"schemaType": {
"type": "string"
},
"sourceFieldType": {
"type": "string"
},
"tableName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STRING",
"BOOLEAN",
"INT",
"DECIMAL",
"CURRENCY",
"PERCENT",
"TIME",
"ENUM",
"ORDERED_ENUM"
]
},
"required": {
"type": "boolean"
},
"hideFromReporting": {
"type": "boolean"
},
"schemaPath": {
"type": "string"
},
"hasData": {
"type": "boolean"
},
"segmentable": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"approved": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"notFound": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"fromGlobalLookup": {
"type": "boolean"
},
"multiValued": {
"type": "boolean"
},
"includeExcludeSetting": {
"type": "object",
"properties": {
"caseSensitive": {
"type": "boolean"
},
"match": {
"type": "string",
"enum": [
"and",
"or"
]
},
"type": {
"type": "string",
"enum": [
"string",
"numeric",
"date"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clause": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"enabled": {
"type": "boolean"
}
}
},
"fieldDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"RAW_FIELD",
"MATCH",
"FLOOR"
]
},
"id": {
"type": "string"
},
"field": {
"type": "string"
},
"label": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pred": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT",
"ISSET",
true,
"EQ",
"GE",
"GT",
"LE",
"LT",
"CONTAINS",
"STREQ",
"STARTS_WITH",
"ENDS_WITH"
]
},
"preds": {
"type": "array",
"items": {
"type": "object"
}
},
"pred": {
"type": "object"
},
"val": {
"type": "object",
"properties": {}
}
}
},
"map-to": {
"type": "object",
"properties": {}
}
}
}
},
"oberon-storage-type": {
"type": "string"
},
"oberon-table": {
"type": "string"
},
"oberon-field": {
"type": "string"
},
"oberon-storage-id": {
"type": "string"
},
"case-sensitive": {
"type": "boolean"
},
"mapped-type": {
"type": "string"
}
}
}
},
"bucketingSetting": {
"type": "object",
"properties": {
"bucketSettings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "number"
},
"to": {
"type": "number"
}
}
}
},
"enabled": {
"type": "boolean"
}
}
},
"noValueOptionsSetting": {
"type": "object",
"properties": {
"option": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"defaultDimensionSort": {
"type": "boolean"
},
"persistenceSetting": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
}
}
},
"lookback": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"isDeleted": {
"type": "boolean"
}
}
}
}
}
},
"404": {
"description": "Could not find dimensions for dataview with given parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving dimensions",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/data/dataviews/{dataviewId}/dimensions/{dimensionId}": {
"get": {
"tags": [
"Dimensions API"
],
"summary": "Retrieval of a specific dimension for a dataview",
"description": "Used to retrieve a specific dimension for a dataview",
"operationId": "getDimensionById_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataviewId",
"in": "path",
"description": "The id of the DataView the dimension is tied to",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dimensionId",
"in": "path",
"description": "The id of the dimension to retrieve, must have the variables/ removed from the ID. For example \"daterangeday\", not \"variables/daterangeday\"",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"sourceFieldId": {
"type": "string"
},
"sourceFieldName": {
"type": "string"
},
"storageId": {
"type": "string"
},
"dataSetIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"dataSetType": {
"type": "string",
"enum": [
"EVENT",
"LOOKUP",
"PROFILE"
]
},
"schemaType": {
"type": "string"
},
"sourceFieldType": {
"type": "string"
},
"tableName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STRING",
"BOOLEAN",
"INT",
"DECIMAL",
"CURRENCY",
"PERCENT",
"TIME",
"ENUM",
"ORDERED_ENUM"
]
},
"required": {
"type": "boolean"
},
"hideFromReporting": {
"type": "boolean"
},
"schemaPath": {
"type": "string"
},
"hasData": {
"type": "boolean"
},
"segmentable": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"approved": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"notFound": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"fromGlobalLookup": {
"type": "boolean"
},
"multiValued": {
"type": "boolean"
},
"includeExcludeSetting": {
"type": "object",
"properties": {
"caseSensitive": {
"type": "boolean"
},
"match": {
"type": "string",
"enum": [
"and",
"or"
]
},
"type": {
"type": "string",
"enum": [
"string",
"numeric",
"date"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clause": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"enabled": {
"type": "boolean"
}
}
},
"fieldDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"RAW_FIELD",
"MATCH",
"FLOOR"
]
},
"id": {
"type": "string"
},
"field": {
"type": "string"
},
"label": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pred": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT",
"ISSET",
true,
"EQ",
"GE",
"GT",
"LE",
"LT",
"CONTAINS",
"STREQ",
"STARTS_WITH",
"ENDS_WITH"
]
},
"preds": {
"type": "array",
"items": {
"type": "object"
}
},
"pred": {
"type": "object"
},
"val": {
"type": "object",
"properties": {}
}
}
},
"map-to": {
"type": "object",
"properties": {}
}
}
}
},
"oberon-storage-type": {
"type": "string"
},
"oberon-table": {
"type": "string"
},
"oberon-field": {
"type": "string"
},
"oberon-storage-id": {
"type": "string"
},
"case-sensitive": {
"type": "boolean"
},
"mapped-type": {
"type": "string"
}
}
}
},
"bucketingSetting": {
"type": "object",
"properties": {
"bucketSettings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "number"
},
"to": {
"type": "number"
}
}
}
},
"enabled": {
"type": "boolean"
}
}
},
"noValueOptionsSetting": {
"type": "object",
"properties": {
"option": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"defaultDimensionSort": {
"type": "boolean"
},
"persistenceSetting": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"allocationModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
}
}
},
"lookback": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"isDeleted": {
"type": "boolean"
}
}
}
}
}
},
"404": {
"description": "Could not find dimensions for dataview with given parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving dimensions",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/data/dataviews/{dataviewId}/metrics": {
"get": {
"tags": [
"Metrics API"
],
"summary": "Retrieval of metrics for a dataview",
"description": "Used to retrieve metrics for a dataview",
"operationId": "getMetricsForDataview_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataviewId",
"in": "path",
"description": "The id of the DataView for which to retrieve Metrics",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "includeType",
"in": "query",
"description": "Comma separated list of include types",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"hidden"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"sourceFieldId": {
"type": "string"
},
"sourceFieldName": {
"type": "string"
},
"storageId": {
"type": "string"
},
"dataSetIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"dataSetType": {
"type": "string",
"enum": [
"EVENT",
"LOOKUP",
"PROFILE"
]
},
"schemaType": {
"type": "string"
},
"sourceFieldType": {
"type": "string"
},
"tableName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STRING",
"BOOLEAN",
"INT",
"DECIMAL",
"CURRENCY",
"PERCENT",
"TIME",
"ENUM",
"ORDERED_ENUM"
]
},
"required": {
"type": "boolean"
},
"hideFromReporting": {
"type": "boolean"
},
"schemaPath": {
"type": "string"
},
"hasData": {
"type": "boolean"
},
"segmentable": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"approved": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"notFound": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"fromGlobalLookup": {
"type": "boolean"
},
"multiValued": {
"type": "boolean"
},
"includeExcludeSetting": {
"type": "object",
"properties": {
"caseSensitive": {
"type": "boolean"
},
"match": {
"type": "string",
"enum": [
"and",
"or"
]
},
"type": {
"type": "string",
"enum": [
"string",
"numeric",
"date"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clause": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"enabled": {
"type": "boolean"
}
}
},
"fieldDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"RAW_FIELD",
"MATCH",
"FLOOR"
]
},
"id": {
"type": "string"
},
"field": {
"type": "string"
},
"label": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pred": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT",
"ISSET",
true,
"EQ",
"GE",
"GT",
"LE",
"LT",
"CONTAINS",
"STREQ",
"STARTS_WITH",
"ENDS_WITH"
]
},
"preds": {
"type": "array",
"items": {
"type": "object"
}
},
"pred": {
"type": "object"
},
"val": {
"type": "object",
"properties": {}
}
}
},
"map-to": {
"type": "object",
"properties": {}
}
}
}
},
"oberon-storage-type": {
"type": "string"
},
"oberon-table": {
"type": "string"
},
"oberon-field": {
"type": "string"
},
"oberon-storage-id": {
"type": "string"
},
"case-sensitive": {
"type": "boolean"
},
"mapped-type": {
"type": "string"
}
}
}
},
"countType": {
"type": "string",
"enum": [
"instances",
"values"
]
},
"formatSetting": {
"type": "object",
"properties": {
"polarity": {
"type": "string"
},
"formatType": {
"type": "string"
},
"decimalPlaces": {
"type": "integer",
"format": "int32"
},
"currency": {
"type": "string"
}
}
},
"attributionSetting": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"attributionModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
}
}
},
"lookback": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"precision": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
}
}
}
},
"404": {
"description": "Could not find metrics for dataview with given parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving metrics",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/data/dataviews/{dataviewId}/metrics/{metricId}": {
"get": {
"tags": [
"Metrics API"
],
"summary": "Retrieval of a specific metric for a dataview",
"description": "Used to retrieve a specific metric for a dataview",
"operationId": "getMetricById_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataviewId",
"in": "path",
"description": "The id of the DataView the metric is tied to",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "metricId",
"in": "path",
"description": "The id of the metric to retrieve, must have the metrics/ removed from the ID. For example \"visitors\", not \"metrics/visitors\"",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"sourceFieldId": {
"type": "string"
},
"sourceFieldName": {
"type": "string"
},
"storageId": {
"type": "string"
},
"dataSetIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"dataSetType": {
"type": "string",
"enum": [
"EVENT",
"LOOKUP",
"PROFILE"
]
},
"schemaType": {
"type": "string"
},
"sourceFieldType": {
"type": "string"
},
"tableName": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"STRING",
"BOOLEAN",
"INT",
"DECIMAL",
"CURRENCY",
"PERCENT",
"TIME",
"ENUM",
"ORDERED_ENUM"
]
},
"required": {
"type": "boolean"
},
"hideFromReporting": {
"type": "boolean"
},
"schemaPath": {
"type": "string"
},
"hasData": {
"type": "boolean"
},
"segmentable": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"approved": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"notFound": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"fromGlobalLookup": {
"type": "boolean"
},
"multiValued": {
"type": "boolean"
},
"includeExcludeSetting": {
"type": "object",
"properties": {
"caseSensitive": {
"type": "boolean"
},
"match": {
"type": "string",
"enum": [
"and",
"or"
]
},
"type": {
"type": "string",
"enum": [
"string",
"numeric",
"date"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clause": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"enabled": {
"type": "boolean"
}
}
},
"fieldDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"RAW_FIELD",
"MATCH",
"FLOOR"
]
},
"id": {
"type": "string"
},
"field": {
"type": "string"
},
"label": {
"type": "string"
},
"branches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pred": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT",
"ISSET",
true,
"EQ",
"GE",
"GT",
"LE",
"LT",
"CONTAINS",
"STREQ",
"STARTS_WITH",
"ENDS_WITH"
]
},
"preds": {
"type": "array",
"items": {
"type": "object"
}
},
"pred": {
"type": "object"
},
"val": {
"type": "object",
"properties": {}
}
}
},
"map-to": {
"type": "object",
"properties": {}
}
}
}
},
"oberon-storage-type": {
"type": "string"
},
"oberon-table": {
"type": "string"
},
"oberon-field": {
"type": "string"
},
"oberon-storage-id": {
"type": "string"
},
"case-sensitive": {
"type": "boolean"
},
"mapped-type": {
"type": "string"
}
}
}
},
"countType": {
"type": "string",
"enum": [
"instances",
"values"
]
},
"formatSetting": {
"type": "object",
"properties": {
"polarity": {
"type": "string"
},
"formatType": {
"type": "string"
},
"decimalPlaces": {
"type": "integer",
"format": "int32"
},
"currency": {
"type": "string"
}
}
},
"attributionSetting": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"attributionModel": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"ALLOCATION_FIRST_TOUCH",
"ALLOCATION_FIRST_TOUCH_DIM",
"ALLOCATION_LAST_TOUCH",
"ALLOCATION_LAST_TOUCH_DIM",
"ALLOCATION_INSTANCE",
"ALLOCATION_DEDUPED_INSTANCE",
"ALLOCATION_LAST_KNOWN",
"ALLOCATION_LEGACY",
"ALLOCATION_LINEAR",
"ALLOCATION_PARTICIPATION",
"ALLOCATION_PARTICIPATION_DIM",
"ALLOCATION_POSITION_BASED",
"ALLOCATION_TIME_DECAY",
"ALLOCATION_U_SHAPED",
"ALLOCATION_J_SHAPED",
"ALLOCATION_REVERSE_J_SHAPED",
"ALLOCATION_DEDUPED_LINEAR",
"ALLOCATION_ALGORITHMIC"
]
},
"expiration": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"afterEvents",
"beforeEvents",
"inactivity",
"container"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
},
"context": {
"type": "string"
}
}
},
"lookbackExpiration": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
},
"merchandising": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"nonMerchandising",
"forced",
"auto"
]
},
"bindingCriteria": {
"type": "object",
"properties": {
"func": {
"type": "string",
"enum": [
"always",
"events"
]
},
"bindingEvents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"context": {
"type": "string"
},
"firstWeight": {
"type": "integer",
"format": "int32"
},
"middleWeight": {
"type": "integer",
"format": "int32"
},
"lastWeight": {
"type": "integer",
"format": "int32"
},
"halfLifeNumPeriods": {
"type": "integer",
"format": "int32"
},
"halfLifeGranularity": {
"type": "string"
}
}
},
"lookback": {
"type": "object",
"properties": {
"func": {
"type": "string"
},
"granularity": {
"type": "string"
},
"numPeriods": {
"type": "integer",
"format": "int32"
}
}
}
}
},
"precision": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
}
}
}
},
"404": {
"description": "Could not find metrics for dataview with given parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving metrics",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/data/dataviews": {
"get": {
"tags": [
"Dataviews API"
],
"summary": "Retrieval of Data Views for a Company",
"description": "Used to retrieve Data Views for a company.",
"operationId": "getDataViewsForCompany",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"description",
"owner",
"isDeleted",
"parentDataGroupId",
"segmentList",
"currentTimezoneOffset",
"timezoneDesignator",
"modified",
"createdDate",
"organization",
"curationEnabled",
"recentRecordedAccess",
"sessionDefinition",
"externalData",
"containerNames"
]
}
}
},
{
"name": "parentDataGroupId",
"in": "query",
"description": "Filters data views by a single parentDataGroupId",
"schema": {
"type": "string"
}
},
{
"name": "externalIds",
"in": "query",
"description": "Comma-delimited list of external ids to limit the response with.",
"schema": {
"type": "string"
}
},
{
"name": "externalParentIds",
"in": "query",
"description": "Comma-delimited list of external parent ids to limit the response with.",
"schema": {
"type": "string"
}
},
{
"name": "dataViewIds",
"in": "query",
"description": "Comma-delimited list of data view ids to limit the response with.",
"schema": {
"type": "string"
}
},
{
"name": "includeType",
"in": "query",
"description": "Include additional DataViews not owned by user.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"deleted"
]
}
}
},
{
"name": "cached",
"in": "query",
"description": "return cached results",
"schema": {
"type": "boolean",
"default": true,
"enum": [
true,
false
]
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (ASC or DESC",
"schema": {
"type": "string",
"default": "ASC"
}
},
{
"name": "sortProperty",
"in": "query",
"description": "Property to sort by (only modifiedDate and id are currently allowed)",
"schema": {
"type": "string",
"default": "id"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
},
"pageable": {
"type": "object",
"properties": {
"sort": {
"type": "object",
"properties": {
"sorted": {
"type": "boolean"
},
"unsorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
},
"paged": {
"type": "boolean"
},
"unpaged": {
"type": "boolean"
},
"pageNumber": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int64"
}
}
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int32"
},
"last": {
"type": "boolean"
},
"sort": {
"type": "object",
"properties": {
"sorted": {
"type": "boolean"
},
"unsorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
},
"first": {
"type": "boolean"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"number": {
"type": "integer",
"format": "int32"
},
"empty": {
"type": "boolean"
}
},
"description": "List of Data Views"
}
}
}
},
"404": {
"description": "Could not find dataViews for company with given parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving Data Views list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
},
"post": {
"tags": [
"Dataviews API"
],
"summary": "Creation of Data Views",
"description": "Stores the given Data View in the db.",
"operationId": "createDataView",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"description",
"owner",
"isDeleted",
"parentDataGroupId",
"segmentList",
"currentTimezoneOffset",
"timezoneDesignator",
"modified",
"createdDate",
"organization",
"curationEnabled",
"recentRecordedAccess",
"sessionDefinition",
"externalData",
"containerNames"
]
}
}
}
],
"requestBody": {
"description": "JSON-formatted object representing a Data View",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Data View body is invalid",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Unable to find parentDataGroup",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Unable to communicate with database",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/data/dataviews/{dataViewId}": {
"get": {
"tags": [
"Dataviews API"
],
"summary": "Retrieval of a Data View by dataViewId",
"description": "Used to retrieve a Data View by id",
"operationId": "getDataViewById",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataViewId",
"in": "path",
"description": "The Data View id to lookup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"description",
"owner",
"isDeleted",
"parentDataGroupId",
"segmentList",
"currentTimezoneOffset",
"timezoneDesignator",
"modified",
"createdDate",
"organization",
"curationEnabled",
"recentRecordedAccess",
"sessionDefinition",
"externalData",
"containerNames"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Unable to find Data View ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving Data View",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
},
"put": {
"tags": [
"Dataviews API"
],
"summary": "Modification of a Data View by dataViewId",
"description": "Used to update a Data View by id with the given Data View data",
"operationId": "updateDataViewById",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataViewId",
"in": "path",
"description": "The Data View id to update",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"description",
"owner",
"isDeleted",
"parentDataGroupId",
"segmentList",
"currentTimezoneOffset",
"timezoneDesignator",
"modified",
"createdDate",
"organization",
"curationEnabled",
"recentRecordedAccess",
"sessionDefinition",
"externalData",
"containerNames"
]
}
}
}
],
"requestBody": {
"description": "JSON-formatted object representing a Data View",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Could not find Data View with given dataViewId",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while updating the Data View",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"Dataviews API"
],
"summary": "Deletion of a Data View by dataViewId",
"description": "Used to remove a Data View by id",
"operationId": "removeDataViewById",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataViewId",
"in": "path",
"description": "The Data View id to remove",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Could not find Data View with given dataViewId",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while removing the Data View",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/data/dataviews/copy/{dataViewId}": {
"put": {
"tags": [
"Dataviews API"
],
"summary": "Copy a data view",
"description": "Copy a Data View.",
"operationId": "copy",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataViewId",
"in": "path",
"description": "The Data View id to lookup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"description",
"owner",
"isDeleted",
"parentDataGroupId",
"segmentList",
"currentTimezoneOffset",
"timezoneDesignator",
"modified",
"createdDate",
"organization",
"curationEnabled",
"recentRecordedAccess",
"sessionDefinition",
"externalData",
"containerNames"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Unable to find Data View ID",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal error while retrieving Data View",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"rootCauseService": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/data/dataviews/validate": {
"post": {
"tags": [
"Dataviews API"
],
"summary": "Validates a data view",
"description": "Validates a Data View.",
"operationId": "validate",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
}
],
"requestBody": {
"description": "JSON-formatted Object containing key/value pairs for virtual report suite creation.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"parentDataGroupId": {
"type": "string"
},
"segmentList": {
"type": "array",
"items": {
"type": "string"
}
},
"currentTimezoneOffset": {
"type": "number",
"format": "float"
},
"timezoneDesignator": {
"type": "string"
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"curationEnabled": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date"
},
"sessionDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"numPeriods": {
"type": "integer",
"format": "int32"
},
"granularity": {
"type": "string",
"enum": [
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"func": {
"type": "string",
"enum": [
"INACTIVITY",
"BEFORE_EVENTS"
]
},
"events": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"externalData": {
"type": "object",
"properties": {
"externalId": {
"type": "string"
},
"externalParentId": {
"type": "string"
}
}
},
"containerNames": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"session": {
"type": "string"
},
"people": {
"type": "string"
}
}
},
"id": {
"type": "string"
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"validator_version": {
"type": "string"
}
}
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/data/connections/{connectionId}": {
"get": {
"tags": [
"Connections API"
],
"summary": "Retrieval of a connection by connectionId",
"description": "Used to retrieve a connection by id",
"operationId": "getConnection_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "connectionId",
"in": "path",
"description": "The id of the connection to lookup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "includeHiddenDataSets",
"in": "query",
"description": "Include hidden data sets",
"schema": {
"type": "boolean",
"default": false,
"enum": [
true,
false
]
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Connection"
}
}
}
},
"404": {
"description": "resource_not_found - could not find connection with given parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorStatus"
}
}
}
},
"500": {
"description": "unexpected_error - internal error while retrieving connection",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorStatus"
}
}
}
}
}
}
},
"/data/connections": {
"get": {
"tags": [
"Connections API"
],
"summary": "Retrieval of connections for an org",
"description": "Used to retrieve connections for an org.",
"operationId": "getConnectionsForCompany_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "dataSetIds",
"in": "query",
"description": "Comma-delimited list of dataSet ids to limit the response with",
"schema": {
"type": "string"
}
},
{
"name": "connectionIds",
"in": "query",
"description": "Comma-delimited list of connectionIds to limit the response with",
"schema": {
"type": "string"
}
},
{
"name": "sandboxId",
"in": "query",
"description": "Filter by sandbox id",
"schema": {
"type": "string"
}
},
{
"name": "sandboxName",
"in": "query",
"description": "Filter by sandbox name",
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
},
{
"name": "includeType",
"in": "query",
"description": "Include additional connections",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"systemUserOwned",
"disabled"
]
}
}
},
{
"name": "filterByModifiedAfter",
"in": "query",
"description": "Filter list to only include connections modified since this date (ISO8601 format)",
"schema": {
"type": "string"
}
},
{
"name": "cached",
"in": "query",
"description": "return cached results",
"schema": {
"type": "boolean",
"default": true,
"enum": [
true,
false
]
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "includeHiddenDataSets",
"in": "query",
"description": "Include hidden data sets",
"schema": {
"type": "boolean",
"default": false,
"enum": [
true,
false
]
}
},
{
"name": "internalLabel",
"in": "query",
"description": "Filter by internal label",
"schema": {
"type": "string"
}
},
{
"name": "internalLabelNamespace",
"in": "query",
"description": "Filter by internal label namespace",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (ASC or DESC",
"schema": {
"type": "string",
"default": "ASC"
}
},
{
"name": "sortProperty",
"in": "query",
"description": "Property to sort by (only modifiedDate and id are currently allowed)",
"schema": {
"type": "string",
"default": "id"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageConnection"
}
}
}
},
"404": {
"description": "resource_not_found - could not find connections for company with given parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorStatus"
}
}
}
},
"500": {
"description": "internal error while retrieving connections",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorStatus"
}
}
}
}
}
}
},
"/data/connections/search": {
"get": {
"tags": [
"Connections API"
],
"summary": "Retrieval of connections for an org by connection",
"description": "Used to retrieve connections for an org based on connectionId or connection name.",
"operationId": "search_1",
"parameters": [
{
"name": "query",
"in": "query",
"description": "Search by connection name or connectionId.",
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "includeHiddenDataSets",
"in": "query",
"description": "Include hidden data sets",
"schema": {
"type": "boolean",
"default": false,
"enum": [
true,
false
]
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageConnection"
}
}
}
},
"404": {
"description": "resource_not_found - could not find connections for company with given parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorStatus"
}
}
}
},
"500": {
"description": "unexpected_error - internal error while retrieving connections",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorStatus"
}
}
}
}
}
}
},
"/segments": {
"get": {
"tags": [
"Segments API"
],
"summary": "Retrieves paginated segments",
"description": "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)",
"operationId": "findAll_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional segment metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"compatibility",
"definition",
"internal",
"modified",
"isDeleted",
"definitionLastModified",
"createdDate",
"recentRecordedAccess",
"performanceScore",
"owner",
"dataId",
"ownerFullName",
"dataName",
"sharesFullName",
"approved",
"favorite",
"shares",
"tags",
"usageSummary",
"usageSummaryWithRelevancyScore"
]
}
}
},
{
"name": "includeType",
"in": "query",
"description": "Include additional segments not owned by user.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"shared",
"templates",
"deleted",
"internal"
]
}
}
},
{
"name": "dataIds",
"in": "query",
"description": "Filter list to only include segments tied to the specified data group ID list (comma-delimited)",
"schema": {
"type": "string"
}
},
{
"name": "ownerId",
"in": "query",
"description": "Filter list to only include segments owned by the specified imsUserId",
"schema": {
"type": "string"
}
},
{
"name": "filterByIds",
"in": "query",
"description": "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.",
"schema": {
"type": "string"
}
},
{
"name": "toBeUsedInRsid",
"in": "query",
"description": "The report suite where the segment is intended to be used. This report suite will be used to determine things like compatibility and permissions.",
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "name",
"in": "query",
"description": "Filter list to only include segments that contains the Name",
"schema": {
"type": "string"
}
},
{
"name": "filterByModifiedAfter",
"in": "query",
"description": "Filter list to only include segments modified since this date (ISO8601 format)",
"schema": {
"type": "string"
}
},
{
"name": "cached",
"in": "query",
"description": "return cached results",
"schema": {
"type": "boolean",
"default": true,
"enum": [
true,
false
]
}
},
{
"name": "pagination",
"in": "query",
"description": "Return paginated results",
"schema": {
"type": "string",
"default": "true",
"enum": [
"true",
"false"
]
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort direction (ASC or DESC",
"schema": {
"default": "ASC"
}
},
{
"name": "sortProperty",
"in": "query",
"description": "Property to sort by (name, modified_date, performanceScore, id is currently allowed)",
"schema": {
"type": "string",
"default": "id"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
},
"400": {
"description": "Unable to retrieve list of segments shared with user",
"content": {}
},
"401": {
"description": "Owner filter error; user specified is not in the same organization as the requesting user",
"content": {}
},
"403": {
"description": "Requesting non-shared segments for other users is restricted to admin users",
"content": {}
},
"500": {
"description": "External API error; Segment retrieval failed",
"content": {}
}
}
},
"post": {
"tags": [
"Segments API"
],
"summary": "Creates configuration for a segment.",
"description": "",
"operationId": "createFilter",
"requestBody": {
"description": "JSON-formatted Object containing key/value pairs to be updated.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"report_suite": {
"type": "string"
},
"modifiedById": {
"type": "string"
},
"definition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"compatibility": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"createDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"organization": {
"type": "string"
},
"template": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date-time"
},
"performanceScore": {
"type": "string"
},
"performanceScoreWeightVersion": {
"type": "string"
},
"id": {
"type": "string"
},
"definitionLastModified": {
"type": "string",
"format": "date-time"
},
"dataId": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "The IMS org ID of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"dataName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
},
"required": false
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional segment metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"compatibility",
"definition",
"internal",
"modified",
"isDeleted",
"definitionLastModified",
"createdDate",
"recentRecordedAccess",
"performanceScore",
"owner",
"dataId",
"ownerFullName",
"dataName",
"sharesFullName",
"approved",
"favorite",
"shares",
"tags",
"usageSummary",
"usageSummaryWithRelevancyScore"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"report_suite": {
"type": "string"
},
"modifiedById": {
"type": "string"
},
"definition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"compatibility": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"createDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"organization": {
"type": "string"
},
"template": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date-time"
},
"performanceScore": {
"type": "string"
},
"performanceScoreWeightVersion": {
"type": "string"
},
"id": {
"type": "string"
},
"definitionLastModified": {
"type": "string",
"format": "date-time"
},
"dataId": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "The IMS org ID of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"dataName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
}
}
}
}
},
"/segments/validate": {
"post": {
"tags": [
"Segments API"
],
"summary": "Validate a Segment",
"description": "Returns a segment validation for the segment contained in the post body of the report.",
"operationId": "segments_validateSegment",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
}
],
"requestBody": {
"description": "Segment definition",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"message": {
"type": "string"
},
"validator_version": {
"type": "string"
},
"supported_products": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_schema": {
"type": "array",
"items": {
"type": "string"
}
},
"supported_features": {
"type": "array",
"items": {
"type": "string"
}
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"400": {
"description": "Bad JSON input; request not formatted correctly",
"content": {}
},
"500": {
"description": "Unexpected error;",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/segments/{ID}": {
"get": {
"tags": [
"Segments API"
],
"summary": "Retrieves a single segment by ID",
"description": "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)",
"operationId": "findOne_2",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The segment ID to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "toBeUsedInRsid",
"in": "query",
"description": "The report suite where the segment is intended to be used. This report suite will be used to determine things like compatibility and permissions.",
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional segment metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"compatibility",
"definition",
"internal",
"modified",
"isDeleted",
"definitionLastModified",
"createdDate",
"recentRecordedAccess",
"performanceScore",
"owner",
"dataId",
"ownerFullName",
"dataName",
"sharesFullName",
"approved",
"favorite",
"shares",
"tags",
"usageSummary",
"usageSummaryWithRelevancyScore"
]
}
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"report_suite": {
"type": "string"
},
"modifiedById": {
"type": "string"
},
"definition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"compatibility": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"createDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"organization": {
"type": "string"
},
"template": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date-time"
},
"performanceScore": {
"type": "string"
},
"performanceScoreWeightVersion": {
"type": "string"
},
"id": {
"type": "string"
},
"definitionLastModified": {
"type": "string",
"format": "date-time"
},
"dataId": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"dataName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
}
},
"403": {
"description": "Requesting non-shared segments for other users is restricted to admin users",
"content": {}
},
"500": {
"description": "External API error; segment retrieval failed",
"content": {}
}
}
},
"put": {
"tags": [
"Segments API"
],
"summary": "Make changes or updates to an existing segment",
"description": "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)",
"operationId": "updateSegment_2",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional segment metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"compatibility",
"definition",
"internal",
"modified",
"isDeleted",
"definitionLastModified",
"createdDate",
"recentRecordedAccess",
"performanceScore",
"owner",
"dataId",
"ownerFullName",
"dataName",
"sharesFullName"
]
}
}
},
{
"name": "id",
"in": "path",
"description": "Segment ID to be updated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "cached",
"in": "query",
"description": "Use cached results",
"schema": {
"type": "boolean",
"default": true,
"enum": [
true,
false
]
}
}
],
"requestBody": {
"description": "JSON-formatted Object containing key/value pairs to be updated.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"report_suite": {
"type": "string"
},
"modifiedById": {
"type": "string"
},
"definition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"compatibility": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"createDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"organization": {
"type": "string"
},
"template": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date-time"
},
"performanceScore": {
"type": "string"
},
"performanceScoreWeightVersion": {
"type": "string"
},
"id": {
"type": "string"
},
"definitionLastModified": {
"type": "string",
"format": "date-time"
},
"dataId": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"dataName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"report_suite": {
"type": "string"
},
"modifiedById": {
"type": "string"
},
"definition": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"compatibility": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
},
"createDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"internal": {
"type": "boolean"
},
"organization": {
"type": "string"
},
"template": {
"type": "boolean"
},
"recentRecordedAccess": {
"type": "string",
"format": "date-time"
},
"performanceScore": {
"type": "string"
},
"performanceScoreWeightVersion": {
"type": "string"
},
"id": {
"type": "string"
},
"definitionLastModified": {
"type": "string",
"format": "date-time"
},
"dataId": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
}
}
},
"isDeleted": {
"type": "boolean"
},
"dataName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
},
"approved": {
"type": "boolean"
},
"favorite": {
"type": "boolean"
},
"usageSummary": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {}
}
}
}
}
}
}
},
"400": {
"description": "Definition must be formatted as a JSON Object",
"content": {}
},
"401": {
"description": "Company mismatch; segment ownership can only be transferred within the same organization",
"content": {}
},
"403": {
"description": "User does not have permission to update this segment",
"content": {}
},
"500": {
"description": "External API error; Segment update or retrieval failed",
"content": {}
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"Segments API"
],
"summary": "Deletion of a Segment by ID",
"operationId": "deleteSegment_2",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "ID of segment to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Segment delete failed",
"content": {}
}
}
}
},
"/auditlogs/api/v1/auditlogs/search": {
"post": {
"tags": [
"Audit Logs"
],
"summary": "Retrieve audit logs for Customer Journey Analytics.",
"description": "This API returns a filterable list of audit log records.",
"operationId": "searchAuditLogs_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "x-user-auth",
"in": "header",
"description": "IMS User Access Token",
"required": true,
"schema": {}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {}
},
"400": {
"description": "Validation errors.",
"content": {}
},
"500": {
"description": "Unexpected error; Searching audit logs failed due to an internal error.",
"content": {}
}
}
}
},
"/auditlogs/api/v1/auditlogs": {
"get": {
"tags": [
"Audit Logs"
],
"summary": "Get audit logs for Customer Journey Analytics.",
"description": "This API returns a filterable list of audit log records.",
"operationId": "getAuditLogs_1",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "x-user-auth",
"in": "header",
"description": "IMS User Access Token",
"required": true,
"schema": {}
},
{
"name": "startDate",
"in": "query",
"description": "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.",
"schema": {}
},
{
"name": "endDate",
"in": "query",
"description": "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.",
"schema": {}
},
{
"name": "action",
"in": "query",
"description": "The action you want to filter by.",
"schema": {}
},
{
"name": "component",
"in": "query",
"description": "The type of component you want to filter by.",
"schema": {}
},
{
"name": "componentId",
"in": "query",
"description": "The ID of the component.",
"schema": {}
},
{
"name": "userType",
"in": "query",
"description": "The type of user.",
"schema": {}
},
{
"name": "userId",
"in": "query",
"description": "The ID of the user.",
"schema": {}
},
{
"name": "userEmail",
"in": "query",
"description": "The email address of the user.",
"schema": {}
},
{
"name": "description",
"in": "query",
"description": "The log description you want to filter by.",
"schema": {}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of results per page. If left null, the default size will be set to 100.",
"schema": {}
},
{
"name": "pageNumber",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {}
},
"400": {
"description": "Validation errors.",
"content": {}
},
"500": {
"description": "Unexpected error; Searching audit logs failed due to an internal error.",
"content": {}
}
}
}
},
"/dateranges": {
"get": {
"tags": [
"Date Range APIs"
],
"summary": "Returns a list of dateranges for the user",
"description": "This API allows users to store commonly used date ranges so that they can be reused throughout the product.",
"operationId": "getDateRanges",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "filterByIds",
"in": "query",
"description": "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.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional date range metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"definition",
"modified",
"ownerFullName",
"sharesFullName",
"shares",
"tags"
]
}
}
},
{
"name": "includeType",
"in": "query",
"description": "Include additional date ranges not owned by user.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"shared",
"templates"
]
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDateRange"
}
}
}
}
}
},
"post": {
"tags": [
"Date Range APIs"
],
"summary": "Creates configuration for a DateRange.",
"description": "",
"operationId": "createDateRange",
"requestBody": {
"description": "Date Range request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDateRange"
}
}
},
"required": true
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional date range metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"definition",
"modified",
"ownerFullName",
"sharesFullName",
"shares",
"tags"
]
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDateRange"
}
}
}
}
}
}
},
"/dateranges/{id}": {
"get": {
"tags": [
"Date Range APIs"
],
"summary": "Retrieves configuration for a DateRange.",
"description": "",
"operationId": "getDateRange",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "Date Range ID to be retrieved",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional date range metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"definition",
"modified",
"ownerFullName",
"sharesFullName",
"shares",
"tags"
]
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDateRange"
}
}
}
}
}
},
"put": {
"tags": [
"Date Range APIs"
],
"summary": "Updates configuration for a DateRange.",
"description": "",
"operationId": "updateDateRange",
"requestBody": {
"description": "Date Range request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDateRange"
}
}
},
"required": true
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "Date Range ID to be updated",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional date range metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"definition",
"modified",
"ownerFullName",
"sharesFullName",
"shares",
"tags"
]
}
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsDateRange"
}
}
}
}
}
},
"delete": {
"tags": [
"Date Range APIs"
],
"summary": "Deletes a DateRange.",
"description": "",
"operationId": "deleteDateRange",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "Date Range ID to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/projects/{id}": {
"get": {
"tags": [
"Projects APIs"
],
"summary": "Retrieves configuration for a Project.",
"description": "",
"operationId": "projects_getProject",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The Project id for which to retrieve information",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional project metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"shares",
"tags",
"accessLevel",
"modified",
"externalReferences",
"definition"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
}
}
}
},
"put": {
"tags": [
"Projects APIs"
],
"summary": "Updates configuration for a project.",
"description": "",
"operationId": "projects_updateProject",
"requestBody": {
"description": "Project request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
},
"required": true
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The Project id for which to retrieve information",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional project metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"shares",
"tags",
"accessLevel",
"modified",
"externalReferences",
"definition"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
}
}
}
},
"delete": {
"tags": [
"Projects APIs"
],
"summary": "deletes a project.",
"description": "",
"operationId": "projects_deleteProject",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "id",
"in": "path",
"description": "The Project id for which to retrieve information",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteResponse"
}
}
}
}
}
}
},
"/projects/validate": {
"post": {
"tags": [
"Projects APIs"
],
"summary": "Validates a Project definition",
"description": "",
"operationId": "projects_validateProject",
"requestBody": {
"description": "Project request body",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"project": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
}
}
},
"required": true
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectCompatibility"
}
}
}
},
"500": {
"description": "External API error; Project validation failed"
},
"400": {
"description": "Invalid input; definition is required. Definition must be formatted as a JSON Object."
}
}
}
},
"/projects": {
"get": {
"tags": [
"Projects APIs"
],
"summary": "Returns a list of projects for the user",
"description": "This Returns the projects list primarily for the Analytics product. ",
"operationId": "projects_getProjects",
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "includeType",
"in": "query",
"description": "Include additional segments not owned by user.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"shared"
]
}
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional project metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"shares",
"tags",
"accessLevel",
"modified",
"externalReferences",
"definition"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
},
{
"name": "filterByIds",
"in": "query",
"description": "Filter list to only include projects in the specified list (comma-delimited list of IDs)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "pagination",
"in": "query",
"description": "return paginated results",
"schema": {
"type": "string",
"default": "true",
"enum": [
"true",
"false"
]
}
},
{
"name": "ownerId",
"in": "query",
"description": "Filter list to only include projects owned by the specified imsUserId",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"required": false,
"schema": {
"type": "integer",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
}
}
}
}
},
"post": {
"tags": [
"Projects APIs"
],
"summary": "Creates a single project.",
"description": "",
"operationId": "projects_createProject",
"requestBody": {
"description": "Project request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
},
"required": true
},
"parameters": [
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"$ref": "#/components/parameters/x-gw-ims-org-id"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional project metadata fields to include on response.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"shares",
"tags",
"accessLevel",
"modified",
"externalReferences",
"definition"
]
}
}
},
{
"name": "locale",
"in": "query",
"description": "Locale",
"schema": {
"type": "string",
"default": "en_US"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsProject"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AssetCount": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int64"
}
}
},
"TransferFailure": {
"type": "object",
"properties": {
"componentType": {
"type": "string",
"enum": [
"segment",
"calculatedMetric",
"project",
"dateRange",
"annotation",
"scheduledJob",
"alert"
]
},
"componentId": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"TransferResults": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/TransferFailure"
}
},
"status": {
"type": "string",
"example": "status_partial_success",
"enum": [
"status_success",
"status_partial_success",
"status_all_failed"
]
}
}
},
"TransferData": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentIds": {
"type": "array",
"items": {
"type": "string"
}
},
"errorMessages": {
"type": "array",
"readOnly": true,
"items": {
"type": "string"
}
}
}
},
"AnalyticsDateRange": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "System generated id",
"readOnly": true
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"rsid": {
"type": "string",
"description": "The report suite id for which the component was created/updated"
},
"reportSuiteName": {
"type": "string",
"description": "The report suite name for which the component was created/updated",
"readOnly": true
},
"owner": {
"$ref": "#/components/schemas/Owner"
},
"definition": {
"type": "object"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"siteTitle": {
"type": "string"
},
"modified": {
"type": "string",
"format": "date-time"
},
"created": {
"type": "string",
"format": "date-time"
}
}
},
"AnalyticsDateRangeDefinition": {
"type": "object",
"properties": {
"start": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RollingDateFunction"
}
},
"end": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RollingDateFunction"
}
},
"calendarType": {
"$ref": "#/components/schemas/CalendarType"
},
"version": {
"type": "string"
}
}
},
"RollingDateFunction": {
"type": "object",
"properties": {
"function": {
"type": "string"
},
"granularity": {
"type": "string",
"enum": [
"year",
"quarter",
"month",
"week",
"day",
"hour",
"minute"
]
},
"offset": {
"type": "integer",
"format": "int32"
},
"dow": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"date": {
"type": "string"
}
}
},
"CalendarType": {
"type": "object",
"properties": {
"rsid": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"gregorian",
"nrf",
"qrs",
"custom_454",
"custom_445",
"modified_gregorian"
]
},
"anchorDate": {
"type": "string",
"format": "date-time"
}
}
},
"AnalyticsProject": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "System generated id",
"readOnly": true
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"rsid": {
"type": "string",
"description": "The report suite id for which the component was created/updated"
},
"reportSuiteName": {
"type": "string",
"description": "The report suite name for which the component was created/updated",
"readOnly": true
},
"owner": {
"$ref": "#/components/schemas/Owner"
},
"type": {
"type": "string",
"enum": [
"project",
"mobileScorecard"
]
},
"definition": {
"$ref": "#/components/schemas/JsonNode"
},
"externalReferences": {
"type": "object",
"additionalProperties": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
}
},
"accessLevel": {
"type": "string"
},
"versionNotes": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"shares": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"modified": {
"type": "string",
"format": "date-time"
},
"created": {
"type": "string",
"format": "date-time"
}
}
},
"JsonNode": {
"type": "object"
},
"ProjectCompatibility": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"validatorVersion": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"Owner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "integer",
"format": "string",
"description": "the ims user id of the owner"
},
"name": {
"type": "string",
"description": "the friendly full login name of the owner, included when the expansion parameter ownerFullName is true"
}
}
},
"DeleteResponse": {
"type": "object",
"properties": {
"result": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"Tag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "the tag id"
},
"name": {
"type": "string",
"description": "the tag name "
},
"description": {
"type": "string",
"description": "the tag description"
},
"components": {
"type": "array",
"description": "the list of components that have been tagged with this tag",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/TaggedComponent"
}
}
},
"description": "Tag Model"
},
"Connection": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/CJAOwner"
},
"dataSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSetMetadata"
}
},
"modifiedDate": {
"type": "string",
"format": "date-time"
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "string"
},
"modifiedBy": {
"type": "string"
},
"modifiedByFullName": {
"type": "string"
},
"backfillEnabled": {
"type": "boolean"
},
"sandboxId": {
"type": "string"
},
"sandboxName": {
"type": "string"
},
"floatPrecision": {
"type": "integer",
"format": "int32"
},
"dataRetentionMonths": {
"type": "integer",
"format": "int32"
},
"connectionValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectionValidationError"
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"backfillSummary": {
"$ref": "#/components/schemas/BackfillSummary"
},
"idWithoutPrefix": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "string"
}
}
},
"CJAOwner": {
"type": "object",
"properties": {
"imsUserId": {
"type": "string",
"description": "the ims org id of the owner, included when the expansion parameter owner is true"
},
"ownerId": {
"type": "string",
"description": "the ims user id or the system user id of the owner, included when the expansion parameter owner is true"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"imsUser",
"systemUser"
]
}
}
},
"DataSetMetadata": {
"type": "object",
"properties": {
"dataSetId": {
"type": "string"
},
"domain": {
"type": "string"
},
"type": {
"type": "string"
},
"timestampId": {
"type": "string"
},
"visitorId": {
"type": "string"
},
"lookupKeyField": {
"type": "string"
},
"lookupParentFields": {
"type": "array",
"items": {
"type": "string"
}
},
"identityNamespace": {
"type": "string"
},
"usePrimaryIdNamespace": {
"type": "boolean"
},
"identityMap": {
"type": "boolean"
},
"name": {
"type": "string"
},
"schemaInfo": {
"$ref": "#/components/schemas/SchemaInfo"
},
"backfills": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSetBackfill"
}
},
"streaming": {
"type": "boolean"
},
"backfillSummary": {
"$ref": "#/components/schemas/BackfillSummary"
},
"lastIngestedTime": {
"type": "string"
},
"streamingEnabledAt": {
"type": "string",
"example": "2022-03-11T14:44:16Z"
},
"identityNamespaceCol": {
"type": "string"
},
"dataSourceType": {
"$ref": "#/components/schemas/DataSourceType"
}
}
},
"DataSetBackfill": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"dataSetId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETED",
"FAILED",
"IN_PROGRESS",
"IN_QUEUE"
]
},
"startDate": {
"type": "string",
"example": "2022-03-11T14:44:16Z"
},
"endDate": {
"type": "string",
"example": "2022-03-11T14:44:16Z"
},
"createdDate": {
"type": "string",
"example": "2022-03-11T14:44:16Z"
},
"allData": {
"type": "boolean"
}
}
},
"BackfillSummary": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"failed": {
"type": "integer",
"format": "int32"
},
"inProgress": {
"type": "integer",
"format": "int32"
},
"completed": {
"type": "integer",
"format": "int32"
},
"invalid": {
"type": "boolean"
}
}
},
"DataSourceType": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"ConnectionValidationError": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"MISSING_FIELD",
"DISALLOWED_FIELD",
"INVALID_CONNECTION_NAME",
"INVALID_SANDBOX_ID",
"INVALID_SANDBOX_NAME",
"INVALID_DOMAIN",
"INVALID_DATA_SET_TYPE",
"INVALID_VISITOR_ID",
"INVALID_NAME_SPACE",
"INVALID_IDENTITY_NAMESPACE",
"INVALID_IDENTITY_MAP",
"INVALID_LOOKUP_KEY_FIELD",
"INVALID_LOOKUP_PARENT_FIELDS",
"INVALID_USE_PRIMARY_ID_NAME_SPACE",
"INVALID_DATA_SOURCE_TYPE",
"DATA_SET_DOES_NOT_EXIST",
"REQUIRED_EVENT_DATA_SET_MISSING",
"SCHEMA_UNAVAILABLE",
"NAMESPACE_UNAVAILABLE",
"DATASET_BACKFILL_REQUEST_LIMIT_EXCEEDED",
"DATASETS_PER_CONNECTION_LIMIT_EXCEEDED"
]
},
"dataSetId": {
"type": "string"
},
"dataSetName": {
"type": "string"
},
"disallowedField": {
"type": "string"
},
"missingField": {
"type": "string"
}
}
},
"ErrorStatus": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"enum": [
"invalid_metric_access",
"method_not_allowed",
"resource_conflict",
"invalid_access",
"resource_temporarily_unavailable",
"external_api_failure",
"aam_failure",
"resource_already_exists",
"invalid_state",
"invalid_json_input",
"invalid_parameters",
"invalid_dimension_access",
"unsupported_data_type",
"resource_not_found",
"insufficient_access",
"health_check_error",
"invalid_data",
"unexpected_error",
"external_api_error",
"unsupported_resource",
"io_error",
"action_not_implemented",
"too_many_requests",
"payload_too_large",
"invalid_request",
"invalid_client_id",
"unauthorized",
"authorization_error",
"invalid_token",
"insufficient_scope",
"bluecoat_unauthorized"
]
},
"errorDescription": {
"type": "string"
},
"errorId": {
"type": "string"
},
"errorDetails": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"rootCauseService": {
"type": "string"
}
}
},
"SchemaInfo": {
"type": "object",
"properties": {
"schemaId": {
"type": "string"
},
"schemaName": {
"type": "string"
},
"schemaRef": {
"$ref": "#/components/schemas/SchemaRef"
}
}
},
"SchemaRef": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id contains full URL path for XDM schema."
},
"contentType": {
"type": "string",
"description": "contentType represents XDM schema version and type of schema."
}
},
"description": "This is the full URL for XDM schema path. This field will be derived from schema field, if it is not present. This field will be used to annotate XDM schema version used in the dataSet or dataSetView."
},
"TaggedComponent": {
"type": "object",
"properties": {
"componentType": {
"type": "string"
},
"componentId": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"PageImsUser": {
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"pageable": {
"$ref": "#/components/schemas/Pageable"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"sort": {
"$ref": "#/components/schemas/Sort"
},
"number": {
"type": "integer",
"format": "int32"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImsUser"
}
},
"empty": {
"type": "boolean"
}
}
},
"ImsUser": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"imsOrgId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"fullName": {
"type": "string"
},
"type": {
"type": "string"
},
"storageReclamationAction": {
"type": "string"
},
"editable": {
"type": "boolean"
},
"externallyManaged": {
"type": "boolean"
},
"licenseGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseGroup"
}
},
"admin": {
"type": "boolean"
},
"imsOrgAdmin": {
"type": "boolean"
},
"imsProductAdmin": {
"type": "boolean"
},
"images": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"LicenseGroup": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"PageConnection": {
"type": "object",
"properties": {
"totalPages": {
"type": "integer",
"format": "int32"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"pageable": {
"$ref": "#/components/schemas/Pageable"
},
"sort": {
"$ref": "#/components/schemas/Sort"
},
"first": {
"type": "boolean"
},
"last": {
"type": "boolean"
},
"number": {
"type": "integer",
"format": "int32"
},
"numberOfElements": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Connection"
}
},
"empty": {
"type": "boolean"
}
}
},
"Pageable": {
"type": "object",
"properties": {
"paged": {
"type": "boolean"
},
"unpaged": {
"type": "boolean"
},
"pageNumber": {
"type": "integer",
"format": "int32"
},
"sort": {
"$ref": "#/components/schemas/Sort"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"offset": {
"type": "integer",
"format": "int64"
}
}
},
"Sort": {
"type": "object",
"properties": {
"unsorted": {
"type": "boolean"
},
"sorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
},
"parameters": {
"authorization": {
"name": "Authorization",
"in": "header",
"description": "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](https://developer.adobe.com/cja-apis/docs/getting-started/).",
"required": true,
"schema": {
"type": "string"
}
},
"x-gw-ims-org-id": {
"name": "x-gw-ims-org-id",
"in": "header",
"description": "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](https://developer.adobe.com/cja-apis/docs/getting-started/).",
"required": true,
"schema": {
"type": "string"
}
},
"x-api-key": {
"name": "x-api-key",
"in": "header",
"description": "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](https://developer.adobe.com/cja-apis/docs/getting-started/).",
"required": true,
"schema": {
"type": "string"
}
}
}
}
}