Adobe Analytics Report Suites API

openapi: 3.2.0
info:
  title: Adobe Analytics Report Suites API
  x-refined-note:
  - x-last-validated differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Report Suites across 2 of this provider''s published API definitions: adobe-analytics-api-openapi.yml, adobe-analytics-report-suites-admin-api-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://analytics.adobe.io/api/{globalCompanyId}
  description: Adobe Analytics Production API
  variables:
    globalCompanyId:
      description: The global company ID for your Adobe Analytics organization
      default: YOUR_GLOBAL_COMPANY_ID
- url: https://analytics.adobe.io/api
tags:
- name: Report Suites
  description: Retrieve report suite information and configuration
paths:
  /reportsuites/collections/suites:
    get:
      operationId: listReportSuites
      summary: Adobe Analytics List Report Suites
      description: Returns a list of report suites accessible to the authenticated user, including report suite ID, name, timezone, and type.
      tags:
      - Report Suites
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          default: 10
        example: 10
      - name: page
        in: query
        schema:
          type: integer
          default: 0
        example: 10
      responses:
        '200':
          description: List of report suites
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSuiteList'
              examples:
                Listreportsuites200Example:
                  summary: Default listReportSuites 200 response
                  x-microcks-default: true
                  value:
                    content:
                    - rsid: '500123'
                      name: Example Title
                      timezoneZoneinfo: example_value
                      type: standard
                    totalElements: 42
                    totalPages: 42
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Listreportsuites401Example:
                  summary: Default listReportSuites 401 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
                    errorId: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
        apiKey: []
    servers:
    - url: https://analytics.adobe.io/api/{globalCompanyId}
      description: Adobe Analytics Production API
      variables:
        globalCompanyId:
          description: The global company ID for your Adobe Analytics organization
          default: YOUR_GLOBAL_COMPANY_ID
  /reportsuites/collections/suites/{rsid}:
    get:
      operationId: getReportSuite
      summary: Adobe Analytics Get a Report Suite
      description: Returns details for a specific report suite by its ID.
      tags:
      - Report Suites
      parameters:
      - $ref: '#/components/parameters/rsidPath'
      responses:
        '200':
          description: Report suite details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSuite'
              examples:
                Getreportsuite200Example:
                  summary: Default getReportSuite 200 response
                  x-microcks-default: true
                  value:
                    rsid: '500123'
                    name: Example Title
                    timezoneZoneinfo: example_value
                    type: standard
        '404':
          description: Report suite not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getreportsuite404Example:
                  summary: Default getReportSuite 404 response
                  x-microcks-default: true
                  value:
                    errorCode: example_value
                    errorDescription: example_value
                    errorId: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - bearerAuth: []
        apiKey: []
    servers:
    - url: https://analytics.adobe.io/api/{globalCompanyId}
      description: Adobe Analytics Production API
      variables:
        globalCompanyId:
          description: The global company ID for your Adobe Analytics organization
          default: YOUR_GLOBAL_COMPANY_ID
  /{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'
    servers:
    - url: https://analytics.adobe.io/api
  /{globalCompanyId}/reportsuites/reportsuites/{rsid}:
    post:
      tags:
      - Report Suites
      summary: Creates a new report suite
      description: 'Creates a new standard report suite.


        NOTE: 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'
    servers:
    - url: https://analytics.adobe.io/api
components:
  schemas:
    ReportSuite:
      type: object
      description: An Adobe Analytics report suite
      properties:
        rsid:
          type: string
          description: Report suite ID
          example: '500123'
        name:
          type: string
          description: Display name of the report suite
          example: Example Title
        timezoneZoneinfo:
          type: string
          description: Timezone for the report suite
          example: example_value
        type:
          type: string
          description: Report suite type
          enum:
          - standard
          - virtual
          example: standard
    ErrorResponse:
      type: object
      description: Error response from the API
      properties:
        errorCode:
          type: string
          description: Machine-readable error code
          example: example_value
        errorDescription:
          type: string
          description: Human-readable error message
          example: example_value
        errorId:
          type: string
          description: Unique ID for tracking this error
          example: '500123'
    ReportSuiteList:
      type: object
      description: Paginated list of report suites
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ReportSuite'
          example: []
        totalElements:
          type: integer
          description: Total number of report suites
          example: 42
        totalPages:
          type: integer
          description: Total number of pages
          example: 42
    TimezoneSettings:
      properties:
        currentTimezoneOffset:
          type: number
          format: float
        name:
          type: string
        timezoneZoneinfo:
          type: string
        timezoneId:
          type: integer
          format: int32
    AnalyticsAsrErrorResponse:
      properties:
        errorDescription:
          type: string
        errorCode:
          type: string
        errorId:
          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
  parameters:
    rsidPath:
      name: rsid
      in: path
      required: true
      description: The report suite ID
      schema:
        type: string
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token from Adobe IMS
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Adobe Developer Console API key
externalDocs:
  description: Adobe Analytics 2.0 API Documentation
  url: https://developer.adobe.com/analytics-apis/docs/2.0/
x-refined-from:
- adobe-analytics-api-openapi.yml
- adobe-analytics-report-suites-admin-api-openapi.json