Administer Adobe Analytics report suites — create suites, and read and update the settings that govern collection and reporting behavior. Distinct from the read-only report suite discovery operations on the core 2.0 reporting API.
{
"openapi": "3.0.1",
"info": {
"title": "Report Suite APIs",
"description": "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."
},
"servers": [
{
"url": "https://analytics.adobe.io/api"
}
],
"tags": [],
"paths": {
"/{globalCompanyId}/reportsuites/collections/suites/{rsid}": {
"get": {
"tags": [
"Collections Suites"
],
"summary": "Retrieves a single suite by ID",
"operationId": "getSuite_1",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"parentRsid",
"currency",
"calendarType",
"timezoneZoneinfo"
]
}
}
},
{
"name": "rsid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Could not find the suite for the given id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected error; suite retrieval failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Suite"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/collections/suites": {
"get": {
"tags": [
"Collections Suites"
],
"summary": "Retrieves many report suites using the given search criteria",
"operationId": "getSuites_1",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "string",
"default": "10"
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "string",
"default": "0"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"name",
"parentRsid",
"currency",
"calendarType",
"timezoneZoneinfo"
]
}
}
},
{
"name": "rsids",
"in": "query",
"description": "Filter list to only include suites in this RSID list (comma-delimited)",
"schema": {
"type": "string"
}
},
{
"name": "rsidContains",
"in": "query",
"description": "Filter list to only include suites whose rsid contains rsidContains.",
"schema": {
"type": "string"
}
}
],
"responses": {
"500": {
"description": "Unexpected error; report suite retrieval failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Suite"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/virtualreportsuites": {
"get": {
"tags": [
"Virtual Report Suites"
],
"summary": "Retrieves many virtual report suites using the given search criteria",
"operationId": "userGetVirtualReportSuites",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "string",
"default": "10"
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "string",
"default": "0"
}
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional virtual report suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"globalCompanyKey",
"parentRsid",
"parentRsidName",
"timezone",
"timezoneZoneinfo",
"currentTimezoneOffset",
"segmentList",
"description",
"modified",
"isDeleted",
"dataCurrentAsOf",
"compatibility",
"dataSchema",
"sessionDefinition",
"curatedComponents",
"type",
"backgroundSessionsEnabled"
]
}
}
},
{
"name": "filterByIds",
"in": "query",
"description": "filter list to only include specified virtual report suites",
"schema": {
"type": "string"
}
},
{
"name": "idContains",
"in": "query",
"description": "Filter list to only include suites whose id contains idContains",
"schema": {
"type": "string"
}
},
{
"name": "segmentIds",
"in": "query",
"description": "Filter list to only include virtual report suites that have a segment in this Comma-delimited list of segmentids",
"schema": {
"type": "string"
}
}
],
"responses": {
"500": {
"description": "Unexpected error; virtual report suite search failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
}
}
},
"post": {
"tags": [
"Virtual Report Suites"
],
"summary": "Creates a new virtual report suite",
"description": "Creates a virtual report suite. The following attributes are required when creating a virtual report suite: name, parentRsid, and segmentList",
"operationId": "userCreateVirtualReportSuite",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional virtual report suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"globalCompanyKey",
"parentRsid",
"parentRsidName",
"timezone",
"timezoneZoneinfo",
"currentTimezoneOffset",
"segmentList",
"description",
"modified",
"isDeleted",
"dataCurrentAsOf",
"compatibility",
"dataSchema",
"sessionDefinition",
"curatedComponents",
"type",
"backgroundSessionsEnabled"
]
}
}
}
],
"requestBody": {
"description": "Virtual report suite creation JSON object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
},
"responses": {
"500": {
"description": "Unexpected error; Virtual report suite create failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/virtualreportsuites/{id}": {
"get": {
"tags": [
"Virtual Report Suites"
],
"summary": "Retrieves a single virtual report suite by ID",
"operationId": "userGetVirtualReportSuite",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional virtual report suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"globalCompanyKey",
"parentRsid",
"parentRsidName",
"timezone",
"timezoneZoneinfo",
"currentTimezoneOffset",
"segmentList",
"description",
"modified",
"isDeleted",
"dataCurrentAsOf",
"compatibility",
"dataSchema",
"sessionDefinition",
"curatedComponents",
"type",
"backgroundSessionsEnabled"
]
}
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "Could not find the virtual report suite for the given id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected error; virtual report suite retrieval failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
}
}
},
"put": {
"tags": [
"Virtual Report Suites"
],
"summary": "Update configuration for a virtual report suite",
"operationId": "userUpdateVirtualReportSuite",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "expansion",
"in": "query",
"description": "Comma-delimited list of additional virtual report suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"globalCompanyKey",
"parentRsid",
"parentRsidName",
"timezone",
"timezoneZoneinfo",
"currentTimezoneOffset",
"segmentList",
"description",
"modified",
"isDeleted",
"dataCurrentAsOf",
"compatibility",
"dataSchema",
"sessionDefinition",
"curatedComponents",
"type",
"backgroundSessionsEnabled"
]
}
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Virtual report suite creation JSON object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
},
"responses": {
"500": {
"description": "Unexpected error; virtual report suite update failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
}
}
},
"delete": {
"tags": [
"Virtual Report Suites"
],
"summary": "Delete virtual report suite",
"description": "Deletes or disables a virtual report suite by ID",
"operationId": "userDeleteVirtualReportSuite",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "id",
"in": "path",
"description": "The virtual report suite ID to be deleted",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"500": {
"description": "Unexpected error; virtual report suite deletion failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteResponse"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/virtualreportsuites/validate": {
"post": {
"tags": [
"Virtual Report Suites"
],
"summary": "Validates a virtual report suite",
"operationId": "userValidateVirtualReportSuite",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
}
],
"requestBody": {
"description": "Virtual report suite creation JSON object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
},
"responses": {
"500": {
"description": "Unexpected error; Virtual report suite validation failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VrsCompatibility"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/virtualreportsuites/search": {
"post": {
"tags": [
"Virtual Report Suites"
],
"summary": "Retrieves many virtual report suites using the given search criteria",
"operationId": "searchAll",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
},
{
"name": "limit",
"in": "query",
"description": "Number of results per page",
"schema": {
"type": "string",
"default": "10"
}
},
{
"name": "page",
"in": "query",
"description": "Page number (base 0 - first page is \"0\")",
"schema": {
"type": "string",
"default": "0"
}
},
{
"name": "expansion",
"in": "",
"description": "Comma-delimited list of additional virtual report suite metadata fields to include on response",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"globalCompanyKey",
"parentRsid",
"parentRsidName",
"timezone",
"timezoneZoneinfo",
"currentTimezoneOffset",
"segmentList",
"description",
"modified",
"isDeleted",
"dataCurrentAsOf",
"compatibility",
"dataSchema",
"sessionDefinition",
"curatedComponents",
"type",
"backgroundSessionsEnabled"
]
}
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"expansion": {
"type": "string"
},
"filterByIds": {
"type": "string"
},
"idContains": {
"type": "string"
},
"segmentIds": {
"type": "string"
}
}
}
}
}
},
"responses": {
"500": {
"description": "Unexpected error; virtual report suite search failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VirtualReportSuite"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/reportsuites/timezones": {
"get": {
"tags": [
"Report Suites"
],
"summary": "Get Timezones",
"description": "Retrieves all supported timezones.",
"operationId": "getTimezones_1",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimezoneSettings"
}
}
}
}
}
}
},
"/{globalCompanyId}/reportsuites/reportsuites/{rsid}": {
"post": {
"tags": [
"Report Suites"
],
"summary": "Creates a new report suite",
"description": "Creates a new standard report suite.\n\nNOTE: The proposed RSID must begin with the prefix of the owning company.",
"operationId": "userCreateReportSuite",
"parameters": [
{
"name": "globalCompanyId",
"in": "path",
"description": "The Global Company ID for the Adobe Analytics organization",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rsid",
"in": "path",
"description": "The Report Suite ID to be created.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "copySettingsFromRsid",
"in": "query",
"description": "The Report Suite ID to copy settings from.",
"required": false,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/authorization"
},
{
"$ref": "#/components/parameters/x-api-key"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"hitsPerDay": {
"type": "integer"
},
"timezone": {
"type": "string",
"example": "US/Pacific"
},
"signUpDate": {
"type": "string",
"example": "YYYY-MM-DD"
},
"baseUrl": {
"type": "string"
},
"currencyCode": {
"type": "string",
"example": "USD"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Report suite created successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatedSuite"
}
}
}
},
"400": {
"description": "Bad Request - Unable to create Report Suite.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected error; suite creation failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsAsrErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AnalyticsAsrErrorResponse": {
"properties": {
"errorDescription": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"errorId": {
"type": "string"
}
}
},
"CalendarSettings": {
"properties": {
"rsid": {
"type": "string"
},
"anchorDate": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "string",
"enum": [
"GREGORIAN",
"NRF",
"QRS",
"CUSTOM_454",
"CUSTOM_445",
"MODIFIED_GREGORIAN",
"CUSTOM_544"
]
}
}
},
"CuratedComponent": {
"required": [
"componentId"
],
"type": "object",
"properties": {
"componentId": {
"type": "string"
},
"componentType": {
"type": "string"
},
"curatedName": {
"type": "string"
}
}
},
"Suite": {
"properties": {
"calendarType": {
"$ref": "#/components/schemas/CalendarSettings"
},
"rsid": {
"title": "Report suite ID",
"type": "string"
},
"parentRsid": {
"title": "Parent report suite ID for virtual report suite",
"type": "string"
},
"name": {
"title": "Suite name",
"type": "string"
},
"timezoneZoneinfo": {
"title": "Suite friendly timezone name",
"type": "string"
},
"currency": {
"title": "Suite currency",
"type": "string"
},
"id": {
"title": "Suite id",
"type": "string"
}
}
},
"CreatedSuite": {
"properties": {
"rsid": {
"title": "Report Suite id",
"type": "string"
},
"created": {
"title": "Suite created",
"type": "boolean"
},
"axleActivated": {
"title": "Axle activated for suite",
"type": "boolean"
}
}
},
"VirtualReportSuite": {
"properties": {
"internal": {
"type": "boolean"
},
"dataSchema": {
"type": "string",
"enum": [
"ExperienceCloudPlatform",
"Stitched",
"Cache",
"CacheAndMid"
]
},
"curatedComponents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CuratedComponent"
}
},
"backgroundSessionsEnabled": {
"type": "boolean"
},
"timezone": {
"type": "integer",
"format": "int32"
},
"siteTitle": {
"type": "string"
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-analytics/refs/heads/main/openapi/_original/adobe-analytics-report-suites-admin-api-openapi.json