SERTICA

SERTICA Analytics API

The Analytics API from SERTICA — 19 operation(s) for analytics.

GitHub OpenAPI

Operations 22

GET /Analytics Get All Menu Items #
POST /Analytics Save a Report #
GET /Analytics/{reportNo} Get Report by ReportNo #
PUT /Analytics/{reportNo} Update a Report #
DELETE /Analytics/{reportNo} Delete a Report #
GET /Analytics/{reportNo}/copy Copy report #
GET /Analytics/{reportNo}/outputFields Get output fields for a report #
GET /Analytics/{reportNo}/filterFields Get filter fields for a report #
GET /Analytics/{reportNo}/excel Get Excel Doc by ReportNo #
POST /Analytics/excel Get Excel Doc from updated Report #
GET /Analytics/reportSetting/{settingsKey}/excel Get Excel File with layout from Report stored in usersettings #
GET /Analytics/{reportNo}/dataset Get Dataset by ReportNo #
POST /Analytics/dataset Get Dataset from updated Report #
GET /Analytics/reportSetting/{settingsKey}/dataset Get Dataset with layout from Report stored in usersettings #
POST /Analytics/{templateFieldName}/distinctList/{filtered} Get DistinctList from ReportFilterField #
GET /Analytics/templates Gets a list of AnalyticsTemplates #
GET /Analytics/templates/{templateNo} Get Template by TemplateNo #
GET /Analytics/templates/{templateNo}/templatefields Get Template with TemplateFields by TemplateNo #
GET /Analytics/customTemplates/{templateNo} Gets a specific AnalyticsCustomTemplate #
GET /Analytics/customTemplates/{templateNo}/templatefields Get CustomTemplate with TemplateFields by TemplateNo #
GET /Analytics/datawarehousetemplates/{templateNo} Gets a specific DataWarehouseAnalyticsTemplate #
GET /Analytics/datawarehousetemplates/{templateNo}/templatefields Get DataWarehouseAnalyticsTemplate with TemplateFields by TemplateNo #

Documentation

📖
Documentation
https://support.sertica.com/hc/en-us/articles/28558470734109-SERTICA-Application-Programming-Interface
📖
APIReference
https://docs.sertica.com/api/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/authentication/sertica-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/openapi/sertica-analytics-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/errors/sertica-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/conventions/sertica-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/data-model/sertica-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/asyncapi/sertica-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sertica-analytics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sertica-analytics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Analytics API
  description: 'Online API browser for SERTICA Web API.


    Be aware that some endpoints are restricted by license or user rights and may not be available in your environment.


    Each endpoint includes a description of the required license and user rights.'
  version: v1
servers:
- url: /api
tags:
- name: Analytics
paths:
  /Analytics:
    get:
      tags:
      - Analytics
      summary: Get All Menu Items
      operationId: GetAllMenuItems
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    post:
      tags:
      - Analytics
      summary: Save a Report
      operationId: CreateReport
      requestBody:
        description: Report Object
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/{reportNo}:
    get:
      tags:
      - Analytics
      summary: Get Report by ReportNo
      operationId: GetAnalyticsReport
      parameters:
      - name: reportNo
        in: path
        description: ReportNo
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    put:
      tags:
      - Analytics
      summary: Update a Report
      operationId: UpdateReport
      parameters:
      - name: reportNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: Report Object
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
    delete:
      tags:
      - Analytics
      summary: Delete a Report
      operationId: DeleteReport
      parameters:
      - name: reportNo
        in: path
        description: Report No.
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/{reportNo}/copy:
    get:
      tags:
      - Analytics
      operationId: CopyReport
      parameters:
      - name: reportNo
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
      summary: Copy report
      x-summary-source: derived
  /Analytics/{reportNo}/outputFields:
    get:
      tags:
      - Analytics
      summary: Get output fields for a report
      operationId: GetReportOutputFields
      parameters:
      - name: reportNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReportOutputField'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/{reportNo}/filterFields:
    get:
      tags:
      - Analytics
      summary: Get filter fields for a report
      operationId: GetReportFilterFields
      parameters:
      - name: reportNo
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.Report.AnalyticsReportFilterField'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/{reportNo}/excel:
    get:
      tags:
      - Analytics
      summary: Get Excel Doc by ReportNo
      operationId: GetReportExcelByNo
      parameters:
      - name: reportNo
        in: path
        description: ReportNo
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/excel:
    post:
      tags:
      - Analytics
      summary: Get Excel Doc from updated Report
      operationId: GetReportExcel
      requestBody:
        description: Report Object
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/reportSetting/{settingsKey}/excel:
    get:
      tags:
      - Analytics
      summary: Get Excel File with layout from Report stored in usersettings
      operationId: GetReportExcelByUserSetting
      parameters:
      - name: settingsKey
        in: path
        description: The user settingskey that contains the report object to get as Excel report
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/{reportNo}/dataset:
    get:
      tags:
      - Analytics
      summary: Get Dataset by ReportNo
      operationId: GetReportDatasetByNo
      parameters:
      - name: reportNo
        in: path
        description: ReportNo
        required: true
        schema:
          type: string
      - name: unitList
        in: query
        description: Filter List of units separated by '|'
        schema:
          type: string
      - name: dateFilterField
        in: query
        description: Output field name or guid to filter by fromDate and toDate
        schema:
          type: string
      - name: fromDate
        in: query
        description: Filter from date
        schema:
          type: string
          format: date-time
      - name: toDate
        in: query
        description: Filter to date
        schema:
          type: string
          format: date-time
      - name: objectIdFilterField
        in: query
        description: Output field name or guid to filter by objectId
        schema:
          type: string
      - name: objectId
        in: query
        description: Filter by objectId
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/dataset:
    post:
      tags:
      - Analytics
      summary: Get Dataset from updated Report
      operationId: GetReportDataset
      parameters:
      - name: top
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      requestBody:
        description: Report Object
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/reportSetting/{settingsKey}/dataset:
    get:
      tags:
      - Analytics
      summary: Get Dataset with layout from Report stored in usersettings
      operationId: GetReportDatasetByUserSetting
      parameters:
      - name: settingsKey
        in: path
        description: The user settingskey that contains the report object to get as dataset
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/{templateFieldName}/distinctList/{filtered}:
    post:
      tags:
      - Analytics
      summary: Get DistinctList from ReportFilterField
      operationId: GetDistinctList
      parameters:
      - name: templateFieldName
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: filtered
        in: query
        description: ''
        schema:
          type: boolean
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          text/json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsReport'
      responses:
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/templates:
    get:
      tags:
      - Analytics
      summary: Gets a list of AnalyticsTemplates
      operationId: GetAnalyticsTemplateStructure
      parameters:
      - name: includeEmptyMenus
        in: query
        description: ''
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsMenuItem'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/templates/{templateNo}:
    get:
      tags:
      - Analytics
      summary: Get Template by TemplateNo
      operationId: GetTemplate
      parameters:
      - name: templateNo
        in: path
        description: TemplateNo
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplate'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/templates/{templateNo}/templatefields:
    get:
      tags:
      - Analytics
      summary: Get Template with TemplateFields by TemplateNo
      operationId: GetTemplatesFields
      parameters:
      - name: templateNo
        in: path
        description: TemplateNo
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsTemplateField'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '401':
          description: If user is unauthorized
        '403':
          description: User must have one of these User Rights</br><table><thead><tr><th>Key</th><th>Right</th></tr></thead><tbody><tr><td style='border-bottom:none;padding-right:5px'>AnalyticsMain</td><td style='border-bottom:none'>View</td></tr></tbody></table>
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
      security:
      - Bearer: []
  /Analytics/customTemplates/{templateNo}:
    get:
      tags:
      - Analytics
      summary: Gets a specific AnalyticsCustomTemplate
      operationId: GetCustomTemplate
      parameters:
      - name: templateNo
        in: path
        description: TemplateNo
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the requested analyticsCustomTemplate
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsCustomTemplate'
        '400':
          description: Returns a validation result with information about the bad request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
        '404':
          description: If an analyticsCustomTemplate with the supplied AnalyticsCustomTemplate No cannot be found
        '401':
          description: If user is unaut

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sertica/refs/heads/main/openapi/sertica-analytics-api-openapi.yml