Sematext Subscriptions API

The Subscriptions API from Sematext — 7 operation(s) for subscriptions.

Operations 10

PUT /users-web/api/v3/subscriptions/{updateableSubscriptionId} Toggle subscription status #
DELETE /users-web/api/v3/subscriptions/{updateableSubscriptionId} Delete subscription #
POST /users-web/api/v3/dashboards/{dashId}/report/send Email a dashboard report #
GET /users-web/api/v3/apps/{appId}/subscriptions Get subscriptions for an App #
POST /users-web/api/v3/dashboards/{dashId}/subscription Create dashboard subscription #
PUT /users-web/api/v3/dashboards/{dashId}/subscription Update dashboard subscription #
POST /users-web/api/v3/apps/{appId}/subscription Create App subscription #
PUT /users-web/api/v3/apps/{appId}/subscription Update App subscription #
POST /users-web/api/v3/apps/{appId}/report/send Email an App report #
GET /users-web/api/v3/subscriptions Get current account's subscriptions #

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/sematext:sematext-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

sematext-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Sematext Subscriptions API
  version: v3
  description: 'Operations tagged Subscriptions across 2 of this provider''s published API definitions: sematext-cloud-openapi-original.json, sematext-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Subscriptions
paths:
  /users-web/api/v3/subscriptions/{updateableSubscriptionId}:
    put:
      tags:
      - Subscriptions
      summary: Toggle subscription status
      operationId: toggleEnabledUsingPUT_1
      parameters:
      - name: updateableSubscriptionId
        in: path
        description: updateableSubscriptionId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionDto'
        description: dto
        required: true
    delete:
      tags:
      - Subscriptions
      summary: Delete subscription
      operationId: deleteUsingDELETE_3
      parameters:
      - name: updateableSubscriptionId
        in: path
        description: updateableSubscriptionId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Generic_Map_Based_Api_Response'
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - api_key:
        - global
  /users-web/api/v3/dashboards/{dashId}/report/send:
    post:
      tags:
      - Subscriptions
      summary: Email a dashboard report
      operationId: sendDashReportUsingPOST
      parameters:
      - name: dashId
        in: path
        description: dashId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailReportResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportInfo'
        description: emailDto
        required: true
  /users-web/api/v3/apps/{appId}/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: Get subscriptions for an App
      operationId: listUsingGET_2
      parameters:
      - name: appId
        in: path
        description: appId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscriptions, Response data type: List of Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
  /users-web/api/v3/dashboards/{dashId}/subscription:
    post:
      tags:
      - Subscriptions
      summary: Create dashboard subscription
      operationId: createForDashUsingPOST_1
      parameters:
      - name: dashId
        in: path
        description: dashId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionDashboardDto'
        description: subscription
        required: true
    put:
      tags:
      - Subscriptions
      summary: Update dashboard subscription
      operationId: updateForDashUsingPUT_1
      parameters:
      - name: dashId
        in: path
        description: dashId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionDashboardDto'
        description: subscription
        required: true
  /users-web/api/v3/apps/{appId}/subscription:
    post:
      tags:
      - Subscriptions
      summary: Create App subscription
      operationId: createForAppUsingPOST_1
      parameters:
      - name: appId
        in: path
        description: appId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionDto'
        description: subscription
        required: true
    put:
      tags:
      - Subscriptions
      summary: Update App subscription
      operationId: updateForAppUsingPUT_1
      parameters:
      - name: appId
        in: path
        description: appId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionDto'
        description: subscription
        required: true
  /users-web/api/v3/apps/{appId}/report/send:
    post:
      tags:
      - Subscriptions
      summary: Email an App report
      operationId: sendAppReportUsingPOST
      parameters:
      - name: appId
        in: path
        description: appId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: 'Response data key : subscription, Response data type: Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailReportResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportInfo'
        description: emailDto
        required: true
  /users-web/api/v3/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: Get current account's subscriptions
      operationId: listUsingGET_5
      responses:
        '200':
          description: 'Response data key : subscriptions, Response data type: List of Subscription'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - api_key:
        - global
components:
  schemas:
    UserPermissions:
      type: object
      properties:
        canDelete:
          type: boolean
        canEdit:
          type: boolean
        canView:
          type: boolean
    SubscriptionResponseEntry:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/Subscription'
    ReportInfo:
      type: object
      properties:
        additionalParams:
          type: string
        addresses:
          type: string
          description: Comma separated list of email addresses
        appId:
          type: integer
          format: int64
        endDate:
          type: string
          format: date-time
        filters:
          type: string
        reportName:
          type: string
        startDate:
          type: string
          format: date-time
        subject:
          type: string
        text:
          type: string
    MailReportResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MailReportResponseResponseEntry'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        message:
          type: string
        success:
          type: boolean
    MailReportResponseResponseEntry:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/ReportInfo'
    SubscriptionDashboardDto:
      type: object
      properties:
        addresses:
          type: string
        dashboardId:
          type: integer
          format: int64
        enable:
          type: boolean
        filters:
          type: string
        frequency:
          type: string
          enum:
          - EVERY_FIVE_MINUTES
          - DAILY
          - WEEKLY
          - MONTHLY
          - QUARTERLY
        id:
          type: integer
          format: int64
        reportName:
          type: string
        sendTime:
          type: string
          format: date-time
        subject:
          type: string
        text:
          type: string
        timeRange:
          type: string
          enum:
          - ONE_DAY
          - ONE_WEEK
          - ONE_MONTH
          - TWO_MONTH
          - SIX_MONTH
          - ONE_YEAR
    Generic_Map_Based_Api_Response:
      type: object
      properties:
        data:
          type: object
          properties: {}
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        message:
          type: string
        success:
          type: boolean
      description: Generic map based wrapper class for all API responses
    Subscription:
      type: object
      properties:
        additionalParams:
          type: string
        addresses:
          type: string
        createdBy:
          type: string
        dashboardId:
          type: integer
          format: int64
        dashboardName:
          type: string
        enabled:
          type: boolean
        filters:
          type: string
        frequency:
          type: string
          enum:
          - EVERY_FIVE_MINUTES
          - DAILY
          - WEEKLY
          - MONTHLY
          - QUARTERLY
        id:
          type: integer
          format: int64
        nextSendDate:
          type: string
          format: date-time
        subject:
          type: string
        systemId:
          type: integer
          format: int64
        systemName:
          type: string
        text:
          type: string
        timeRange:
          type: string
          enum:
          - ONE_DAY
          - ONE_WEEK
          - ONE_MONTH
          - TWO_MONTH
          - SIX_MONTH
          - ONE_YEAR
        userPermissions:
          $ref: '#/components/schemas/UserPermissions'
    SubscriptionsResponseEntry:
      type: object
      properties:
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
    UpdateSubscriptionDto:
      type: object
      properties:
        enabled:
          type: boolean
    SubscriptionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SubscriptionResponseEntry'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        message:
          type: string
        success:
          type: boolean
    SubscriptionDto:
      type: object
      properties:
        additionalParams:
          type: string
        addresses:
          type: string
        enable:
          type: boolean
        filters:
          type: string
        frequency:
          type: string
          enum:
          - EVERY_FIVE_MINUTES
          - DAILY
          - WEEKLY
          - MONTHLY
          - QUARTERLY
        id:
          type: integer
          format: int64
        reportName:
          type: string
        sendTime:
          type: string
          format: date-time
        subject:
          type: string
        systemId:
          type: integer
          format: int64
        text:
          type: string
        timeRange:
          type: string
          enum:
          - ONE_DAY
          - ONE_WEEK
          - ONE_MONTH
          - TWO_MONTH
          - SIX_MONTH
          - ONE_YEAR
        userPermissions:
          $ref: '#/components/schemas/UserPermissions'
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    SubscriptionsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SubscriptionsResponseEntry'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        message:
          type: string
        success:
          type: boolean
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
x-refined-from:
- sematext-cloud-openapi-original.json
- sematext-openapi.yml