SERTICA

SERTICA Analytics Subscriptions API

The AnalyticsSubscriptions API from SERTICA — 6 operation(s) for analyticssubscriptions.

GitHub OpenAPI

Operations 6

GET /AnalyticsSubscriptions Gets a list of AnalyticsSubscriptions #
GET /AnalyticsSubscriptions/{guid} Gets a specific AnalyticsSubscription including its recipients #
POST /AnalyticsSubscriptions/search Search for AnalyticsSubscriptions Takes a SearchDefinition input, which can… #
POST /AnalyticsSubscriptions/searchCount Returns number of hits in a search for AnalyticsSubscriptions Takes a… #
POST /AnalyticsSubscriptions/searchIndex/{analyticsSubscriptionGuid} Get index of a record in a search for AnalyticsSubscriptions Takes a… #
GET /AnalyticsSubscriptions/searchInfo Returns structured information about what and how you can search for #

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-analyticssubscriptions-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-analyticssubscriptions-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-analyticssubscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SERTICA Web Analytics Subscriptions 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: AnalyticsSubscriptions
paths:
  /AnalyticsSubscriptions:
    get:
      tags:
      - AnalyticsSubscriptions
      summary: Gets a list of AnalyticsSubscriptions
      operationId: GetAnalyticsSubscriptions
      parameters:
      - name: page
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: ''
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
        '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'>AnalyticsReport</td><td style='border-bottom:none'>View</td></tr><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: []
  /AnalyticsSubscriptions/{guid}:
    get:
      tags:
      - AnalyticsSubscriptions
      summary: Gets a specific AnalyticsSubscription including its recipients
      operationId: GetAnalyticsSubscription
      parameters:
      - name: guid
        in: path
        description: The Guid of the subscription to get
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the requested AnalyticsSubscription
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
            application/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
            text/json:
              schema:
                $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
        '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 AnalyticsSubscription with the supplied Guid cannot be found
        '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'>AnalyticsReport</td><td style='border-bottom:none'>View</td></tr><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: []
  /AnalyticsSubscriptions/search:
    post:
      tags:
      - AnalyticsSubscriptions
      summary: Search for AnalyticsSubscriptions Takes a SearchDefinition input, which can…
      operationId: SearchAnalyticsSubscriptions
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Pagesize
        schema:
          type: integer
          format: int32
          default: 25
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscription'
        '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'>AnalyticsReport</td><td style='border-bottom:none'>View</td></tr><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: []
  /AnalyticsSubscriptions/searchCount:
    post:
      tags:
      - AnalyticsSubscriptions
      summary: Returns number of hits in a search for AnalyticsSubscriptions Takes a…
      operationId: SearchCountAnalyticsSubscriptions
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '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'>AnalyticsReport</td><td style='border-bottom:none'>View</td></tr><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: []
  /AnalyticsSubscriptions/searchIndex/{analyticsSubscriptionGuid}:
    post:
      tags:
      - AnalyticsSubscriptions
      summary: Get index of a record in a search for AnalyticsSubscriptions Takes a…
      operationId: SearchIndexAnalyticsSubscriptions
      parameters:
      - name: analyticsSubscriptionGuid
        in: path
        description: The subscription to get index for
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: The search definition
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          text/json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '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'>AnalyticsReport</td><td style='border-bottom:none'>View</td></tr><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: []
  /AnalyticsSubscriptions/searchInfo:
    get:
      tags:
      - AnalyticsSubscriptions
      summary: Returns structured information about what and how you can search for
      operationId: SearchInfoAnalyticsSubscriptions
      responses:
        '200':
          description: Returns a list of valid search fields
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
            application/json:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
            text/json:
              schema:
                $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo'
        '500':
          description: The api has encountered an unhandled exception. See Sertica logs for details
components:
  schemas:
    Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest:
      type: object
      properties:
        deviceGuid:
          type:
          - string
          - 'null'
          format: uuid
        requestIdGuid:
          type:
          - string
          - 'null'
          format: uuid
        fullSynchronization:
          type: boolean
        appType:
          type: integer
          format: int32
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        dataType:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType'
        operators:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator'
        enumType:
          type:
          - string
          - 'null'
        isCustomProperty:
          type: boolean
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection:
      enum:
      - Asc
      - Desc
      type: string
    SerticaWebApi.Models.Analytics.AnalyticsSubscriptionIntervalType:
      enum:
      - Months
      - Days
      - SpecificTimes
      type: string
    SerticaWebApi.Models.Analytics.AnalyticsSubscriptionRecipient:
      type: object
      properties:
        userNo:
          type:
          - string
          - 'null'
        userName:
          type:
          - string
          - 'null'
        userEmail:
          type:
          - string
          - 'null'
        analyticsSubscriptionGuid:
          type:
          - string
          - 'null'
          format: uuid
        guidForReferencedObject:
          type:
          - string
          - 'null'
          format: uuid
        guid:
          type:
          - string
          - 'null'
          format: uuid
        liveObjectGuid:
          type:
          - string
          - 'null'
          format: uuid
        unitGuid:
          type:
          - string
          - 'null'
          format: uuid
        deleted:
          type: boolean
        latestHistoryGuid:
          type:
          - string
          - 'null'
          format: uuid
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Link'
          readOnly: true
      additionalProperties: false
    SerticaWebApi.Models.Link:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    SerticaWebApi.Models.BrokenRule:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/SerticaWebApi.Models.BrokenRuleType'
        index:
          type:
          - integer
          - 'null'
          format: int32
        objectGuid:
          type:
          - string
          - 'null'
          format: uuid
        field:
          type:
          - string
          - 'null'
        field2:
          type:
          - string
          - 'null'
        field3:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator:
      enum:
      - Equals
      - LessThan
      - GreaterThan
      - Like
      - Range
      - In
      - Dynamic
      - StartsWith
      - EndsWith
      - IsNull
      - NotLike
      - Or
      - NotEquals
      - NotIn
      type: string
    SerticaWebApi.Models.ErrorReason:
      type: object
      properties:
        text:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        direction:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection'
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType:
      enum:
      - Unkonwn
      - String
      - Int
      - Decimal
      - Enum
      - DateTime
      - Guid
      - Bool
      - Duration
      type: string
    SerticaWebApi.Models.ValidationResult:
      type: object
      properties:
        isValid:
          type: boolean
          readOnly: true
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.ErrorReason'
          readOnly: true
        brokenRules:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.BrokenRule'
          readOnly: true
        subResults:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SerticaWebApi.Models.ValidationResult'
          readOnly: true
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo:
      type: object
      properties:
        supportsContains:
          type: boolean
        fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField'
          readOnly: true
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition:
      type: object
      properties:
        distinct:
          type: boolean
        subObjectsToInclude:
          type:
          - array
          - 'null'
          items:
            type: string
        contains:
          type:
          - array
          - 'null'
          items:
            type: string
        criteria:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria'
        sorting:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy'
        columns:
          type:
          - array
          - 'null'
          items:
            type: string
        forDeviceRequest:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest'
        unitFilter:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching:
      enum:
      - All
      - One
      type: string
    SerticaWebApi.Models.BrokenRuleType:
      enum:
      - Default
      - ShouldBeFilled
      - Information
      - Warning
      - Error
      - Delete
      type: string
    Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        operator:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator'
        values:
          type:
          - array
          - 'null'
          items: {}
        valuesMatching:
          $ref: '#/components/schemas/Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching'
      additionalProperties: false
    SerticaWebApi.Models.Analytics.AnalyticsSubscription:
      type: object
      properties:
        analyticsReportGuid:
          type:
          - string
          - 'null'
          format: uuid
        reportNo:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        startDate:
          type:
          - string
          - 'null'
          format: date-time
        frequency:
          type:
          - integer
          - 'null'
          format: int32
        exportFolderPath:
          type:
          - string
          - 'null'
        mailingList:
          type:
          - string
          - 'null'
        intervalType:
          $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscriptionIntervalType'
        doNotSendEmptyReports:
          type:
          - boolean
          - 'null'
        mailSubject:
          type:
          - string
          - 'null'
        mailBody:
          type:
          - string
          - 'null'
        startTime:
          type:
          - string
          - 'null'
          format: date-time
        runTime:
          type:
          - string
          - 'null'
          format: date-time
        recipientEmailsAsString:
          type:
          - string
          - 'null'
        scheduledExecutionDate:
          type:
          - string
          - 'null'
          format: date-time
        recipients:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Analytics.AnalyticsSubscriptionRecipient'
        guid:
          type:
          - string
          - 'null'
          format: uuid
        liveObjectGuid:
          type:
          - string
          - 'null'
          format: uuid
        unitGuid:
          type:
          - string
          - 'null'
          format: uuid
        deleted:
          type: boolean
        latestHistoryGuid:
          type:
          - string
          - 'null'
          format: uuid
        links:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SerticaWebApi.Models.Link'
          readOnly: true
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: JWT Authorization header using the Bearer scheme
      scheme: bearer