Adobe Analytics API

{
  "swagger": "2.0",
  "info": {
    "description": "The endpoints described here are routed through analytics.adobe.io. In order to use these endpoints you must create an oAuth client that is subscribed to access the Adobe Analytics Reporting API. \n\n To view the API References for non-core Analytics 2.0 APIs, select the **API Reference** drop-down menu at the top of the page. \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.",
    "title": "Adobe Analytics APIs",
    "version": "2.0"
  },
  "host": "analytics.adobe.io",
  "basePath": "/api",
  "tags": [
    {
      "name": "Annotations"
    },
    {
      "name": "Calculated Metrics"
    },
    {
      "name": "Component Meta Data"
    },
    {
      "name": "Date Ranges"
    },
    {
      "name": "Dimensions"
    },
    {
      "name": "Metrics"
    },
    {
      "name": "Projects"
    },
    {
      "name": "Reports"
    },
    {
      "name": "Segments"
    },
    {
      "name": "Users"
    },
    {
      "name": "Usage logs"
    }
  ],
  "parameters": {
    "authorization": {
      "name": "Authorization",
      "in": "header",
      "description": "The access token copied from your AA API client integration, prefixed with \"Bearer \".",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    "x-api-key": {
      "name": "x-api-key",
      "in": "header",
      "description": "The API key copied from your AA API client integration. For more information on how to obtain this value, see [Getting started with the Analytics API](https://developer.adobe.com/analytics-apis/docs/2.0/guides/).",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  },
  "paths": {
    "/{globalCompanyId}/annotations": {
      "get": {
        "tags": [
          "Annotations"
        ],
        "summary": "Retrieve all annotations.",
        "description": "",
        "operationId": "getAnnotations_1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "expansion",
            "in": "query",
            "description": "Comma-delimited list of additional annotation metadata fields to include on response.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "name",
                "description",
                "dateRange",
                "color",
                "applyToAllReports",
                "scope",
                "createdDate",
                "modifiedDate",
                "modifiedById",
                "owner",
                "companyId",
                "rsid",
                "approved",
                "favorite",
                "shares",
                "sharesFullName",
                "tags",
                "usageSummary",
                "usageSummaryWithRelevancyScore",
                "ownerFullName",
                "reportSuiteName"
              ]
            },
            "collectionFormat": "csv"
          },
          {
            "name": "includeType",
            "in": "query",
            "description": "Include additional annotations not owned by user. The \"all\" option takes precedence over \"shared\"",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "all",
                "shared"
              ]
            },
            "collectionFormat": "csv"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          },
          {
            "name": "filterByIds",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "filterByModifiedAfter",
            "in": "query",
            "description": "Filter list to only include annotations modified since this date (ISO8601 format)",
            "required": false,
            "type": "string"
          },
          {
            "name": "filterByDateRange",
            "in": "query",
            "description": "Filter list to only include annotations in the specified date range with format yyyy-MM-dd'T'HH:mm:ss/yyyy-MM-dd'T'hh:MM:ss",
            "required": false,
            "type": "string"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Number of results per page",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number (base 0 - first page is \"0\")",
            "required": false,
            "type": "integer",
            "default": 0
          },
          {
            "name": "sortDirection",
            "in": "query",
            "description": "Sort direction (ASC or DESC",
            "required": false,
            "type": "integer",
            "default": "ASC"
          },
          {
            "name": "sortProperty",
            "in": "query",
            "description": "Property to sort by (name, modified_date, id is currently allowed)",
            "required": false,
            "type": "string",
            "default": "id"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/AnalyticsAnnotation"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Annotations"
        ],
        "summary": "Create new annotation",
        "description": "",
        "operationId": "createAnnotation_1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "expansion",
            "in": "query",
            "description": "Comma-delimited list of additional annotation metadata fields to include on response.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "name",
                "description",
                "dateRange",
                "color",
                "applyToAllReports",
                "scope",
                "createdDate",
                "modifiedDate",
                "modifiedById",
                "owner",
                "companyId",
                "rsid",
                "approved",
                "favorite",
                "shares",
                "sharesFullName",
                "tags",
                "usageSummary",
                "usageSummaryWithRelevancyScore",
                "ownerFullName",
                "reportSuiteName"
              ]
            },
            "collectionFormat": "csv"
          },
          {
            "in": "body",
            "name": "body",
            "description": "JSON-formatted Object containing date range keys/value pairs to be updated.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/AnalyticsAnnotation"
            }
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/AnalyticsAnnotation"
            }
          }
        }
      }
    },
    "/{globalCompanyId}/annotations/{id}": {
      "get": {
        "tags": [
          "Annotations"
        ],
        "summary": "Get existing annotation",
        "description": "",
        "operationId": "getAnnotation_1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "expansion",
            "in": "query",
            "description": "Comma-delimited list of additional annotation metadata fields to include on response.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "name",
                "description",
                "dateRange",
                "color",
                "applyToAllReports",
                "scope",
                "createdDate",
                "modifiedDate",
                "modifiedById",
                "owner",
                "companyId",
                "rsid",
                "approved",
                "favorite",
                "shares",
                "sharesFullName",
                "tags",
                "usageSummary",
                "usageSummaryWithRelevancyScore",
                "ownerFullName",
                "reportSuiteName"
              ]
            },
            "collectionFormat": "csv"
          },
          {
            "name": "id",
            "in": "path",
            "description": "Annotation ID to retrieve",
            "required": true,
            "type": "string"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/AnalyticsAnnotation"
            }
          }
        }
      },
      "put": {
        "tags": [
          "Annotations"
        ],
        "summary": "Update existing annotation",
        "description": "",
        "operationId": "updateAnnotation_1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "expansion",
            "in": "query",
            "description": "Comma-delimited list of additional annotation metadata fields to include on response.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "name",
                "description",
                "dateRange",
                "color",
                "applyToAllReports",
                "scope",
                "createdDate",
                "modifiedDate",
                "modifiedById",
                "owner",
                "companyId",
                "rsid",
                "approved",
                "favorite",
                "shares",
                "sharesFullName",
                "tags",
                "usageSummary",
                "usageSummaryWithRelevancyScore",
                "ownerFullName",
                "reportSuiteName"
              ]
            },
            "collectionFormat": "csv"
          },
          {
            "in": "body",
            "name": "body",
            "description": "JSON-formatted Object containing date range keys/value pairs to be updated.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/AnalyticsAnnotation"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "Annotation ID to update",
            "required": true,
            "type": "string"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/AnalyticsAnnotation"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Annotations"
        ],
        "summary": "Delete existing annotation",
        "description": "",
        "operationId": "deleteAnnotation_1",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "id",
            "in": "path",
            "description": "Annotation ID to update",
            "required": true,
            "type": "string"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/DeleteResponse"
            }
          }
        }
      }
    },
    "/{globalCompanyId}/calculatedmetrics": {
      "get": {
        "tags": [
          "Calculated Metrics"
        ],
        "summary": "Retrieve multiple 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, see the [Calculated Metrics API endpoint guide](https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/calculatedmetrics/)\n\n",
        "operationId": "findCalculatedMetrics",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "rsids",
            "in": "query",
            "description": "Filter list to only include calculated metrics tied to specified RSID list (comma-delimited)",
            "required": false,
            "type": "string"
          },
          {
            "name": "ownerId",
            "in": "query",
            "description": "Filter list to only include calculated metrics owned by the specified loginId",
            "required": false,
            "type": "integer",
            "format": "int32"
          },
          {
            "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",
            "required": false,
            "type": "string"
          },
          {
            "name": "toBeUsedInRsid",
            "in": "query",
            "description": "The report suite where the calculated metric 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.",
            "required": false,
            "type": "string"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          },
          {
            "name": "name",
            "in": "query",
            "description": "Filter list to only include calculated metrics that contains the Name",
            "required": false,
            "type": "string"
          },
          {
            "name": "tagNames",
            "in": "query",
            "description": "Filter list to only include calculated metrics that contains one of the tags",
            "required": false,
            "type": "string"
          },
          {
            "name": "favorite",
            "in": "query",
            "description": "Filter list to only include calculated metrics that are favorites",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "approved",
            "in": "query",
            "description": "Filter list to only include calculated metrics that are approved",
            "required": false,
            "type": "boolean"
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Number of results per page",
            "required": false,
            "type": "integer",
            "default": 10
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number (base 0 - first page is \"0\")",
            "required": false,
            "type": "integer",
            "default": 0
          },
          {
            "name": "sortDirection",
            "in": "query",
            "description": "Sort direction (ASC or DESC)",
            "required": false,
            "type": "string",
            "default": "ASC"
          },
          {
            "name": "sortProperty",
            "in": "query",
            "description": "Property to sort by (name, modified_date, id is currently allowed)",
            "required": false,
            "type": "string",
            "default": "id"
          },
          {
            "name": "expansion",
            "in": "query",
            "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "reportSuiteName",
                "ownerFullName",
                "modified",
                "tags",
                "definition",
                "compatibility",
                "categories"
              ]
            },
            "collectionFormat": "csv",
            "enum": [
              "reportSuiteName",
              "ownerFullName",
              "modified",
              "tags",
              "definition",
              "compatibility",
              "categories"
            ]
          },
          {
            "name": "includeType",
            "in": "query",
            "description": "Include additional calculated metrics not owned by user. The \"all\" option takes precedence over \"shared\"",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "all",
                "shared",
                "templates"
              ]
            },
            "collectionFormat": "csv",
            "enum": [
              "all",
              "shared",
              "templates"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/AnalyticsCalculatedMetric"
              }
            }
          },
          "400": {
            "description": "Unable to retrieve list of calculated metrics shared with user",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          },
          "401": {
            "description": "Owner filter error; user specified is not in the same company as the requesting user",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          },
          "403": {
            "description": "Requesting non-shared calculated metrics for other users is restricted to admin users",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          },
          "500": {
            "description": "External API error; Calculated metric retrieval failed",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Calculated Metrics"
        ],
        "summary": "Create a new calculated metric",
        "description": "Creates a new calculated metric. The following attributes are available when creating a calculated metric:\n\nIMPORTANT: Required Fields: name, definition, rsid\n\nOptional fields: description\n\nExample definition for use in testing API below (\"Visits per visitor\"):\n\n```json\n\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    }\n```\n\nA calculated metric response will always include these default items:* id, name, description, rsid, owner* \n\nAdditional attributes can be optionally requested in the 'expansion' field as described in the GET calculated metrics section.",
        "operationId": "calculatedmetrics_createCalculatedMetric",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "in": "body",
            "name": "body",
            "description": "JSON-formatted Object containing key/value pairs for calculated metric creation.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/AnalyticsCalculatedMetric"
            }
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          },
          {
            "name": "expansion",
            "in": "query",
            "description": "Comma-delimited list of additional calculated metric metadata fields to include on response.",
            "required": false,
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "reportSuiteName",
                "ownerFullName",
                "modified",
                "tags",
                "definition",
                "compatibility",
                "categories"
              ]
            },
            "collectionFormat": "csv",
            "enum": [
              "reportSuiteName",
              "ownerFullName",
              "modified",
              "tags",
              "definition",
              "compatibility",
              "categories"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/AnalyticsCalculatedMetric"
            }
          },
          "400": {
            "description": "Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object.",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          },
          "500": {
            "description": "External API error; Calculated metric create or retrieval failed",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          }
        }
      }
    },
    "/{globalCompanyId}/calculatedmetrics/functions": {
      "get": {
        "tags": [
          "Calculated Metrics"
        ],
        "summary": "Retrieve calculated metric functions",
        "description": "",
        "operationId": "calculatedmetrics_getCalculatedMetricFunctions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/CalcMetricFunction"
              }
            }
          },
          "500": {
            "description": "External API error; Calculated metric functions retrieval failed",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          }
        }
      }
    },
    "/{globalCompanyId}/calculatedmetrics/functions/{id}": {
      "get": {
        "tags": [
          "Calculated Metrics"
        ],
        "summary": "Retrieve a calculated metric function by ID",
        "description": "",
        "operationId": "calculatedmetrics_getCalculatedMetricFunction",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The function ID to retrieve",
            "required": true,
            "type": "string"
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/CalcMetricFunction"
            }
          },
          "404": {
            "description": "Calculated metric function not found",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          },
          "500": {
            "description": "External API error; Calculated metric function retrieval failed",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          }
        }
      }
    },
    "/{globalCompanyId}/calculatedmetrics/validate": {
      "post": {
        "tags": [
          "Calculated Metrics"
        ],
        "summary": "Validate a calculated metric definition",
        "description": "",
        "operationId": "calculatedmetrics_validateCalculatedMetric",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "globalCompanyId",
            "in": "path",
            "description": "The Global Company ID for the Adobe Analytics organization",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/authorization"
          },
          {
            "$ref": "#/parameters/x-api-key"
          },
          {
            "in": "body",
            "name": "body",
            "description": "JSON-formatted Object containing key/value pairs for calculated metric validation.",
            "required": false,
            "schema": {
              "$ref": "#/definitions/AnalyticsCalculatedMetric"
            }
          },
          {
            "name": "locale",
            "in": "query",
            "description": "Locale",
            "required": false,
            "type": "string",
            "default": "en_US"
          },
          {
            "name": "migrating",
            "in": "query",
            "description": "Include migration functions in validation",
            "required": false,
            "type": "boolean",
            "default": false
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/AnalyticsCalculatedMetric"
            }
          },
          "400": {
            "description": "Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object.",
            "schema": {
              "$ref": "#/definitions/CalculatedMetricErrorStatus"
            }
          },
          "500": {
            "description": "External API error; Calculated metric validation failed",
          

# --- truncated at 32 KB (186 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-analytics-openapi.json