Adobe Analytics Virtual Report Suites API

openapi: 3.2.0
info:
  title: Virtual Report Suites API
  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:
- name: Virtual Report Suites
paths:
  /{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'
components:
  schemas:
    Owner:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        login:
          type: string
    CuratedComponent:
      required:
      - componentId
      type: object
      properties:
        componentId:
          type: string
        componentType:
          type: string
        curatedName:
          type: string
    DeleteResponse:
      properties:
        result:
          type: string
        message:
          type: string
    AnalyticsAsrErrorResponse:
      properties:
        errorDescription:
          type: string
        errorCode:
          type: string
        errorId:
          type: string
    VrsCompatibility:
      properties:
        valid:
          type: boolean
        validator_version:
          type: string
        message:
          type: string
        supported_products:
          type: array
          items:
            type: string
    JsonNode:
      type: object
      properties:
        valueNode:
          type: boolean
        floatingPointNumber:
          type: boolean
        containerNode:
          type: boolean
        missingNode:
          type: boolean
        pojo:
          type: boolean
        integralNumber:
          type: boolean
        short:
          type: boolean
        int:
          type: boolean
        long:
          type: boolean
        double:
          type: boolean
        bigDecimal:
          type: boolean
        bigInteger:
          type: boolean
        textual:
          type: boolean
        binary:
          type: boolean
        float:
          type: boolean
        nodeType:
          type: string
          enum:
          - ARRAY
          - BINARY
          - BOOLEAN
          - MISSING
          - 'NULL'
          - NUMBER
          - OBJECT
          - POJO
          - STRING
        boolean:
          type: boolean
        number:
          type: boolean
        object:
          type: boolean
        array:
          type: boolean
        'null':
          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
        description:
          type: string
        type:
          type: string
        parentRsid:
          type: string
        globalCompanyKey:
          type: string
        reportSuiteName:
          type: string
        isDeleted:
          type: boolean
        currentTimezoneOffset:
          type: number
          format: float
        curationEnabled:
          type: boolean
        modified:
          type: string
          format: date-time
        id:
          type: string
        dataCurrentAsOf:
          type: string
          format: date-time
        segmentList:
          type: array
          items:
            type: string
        owner:
          $ref: '#/components/schemas/Owner'
        parentRsidName:
          type: string
        rsid:
          type: string
        name:
          type: string
        timezoneZoneinfo:
          type: string
        sessionDefinition:
          $ref: '#/components/schemas/JsonNode'
        compatibility:
          $ref: '#/components/schemas/VrsCompatibility'
  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 CJA API](https://developer.adobe.com/cja-apis/docs/getting-started/).
      required: true
      schema:
        type: string