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/mantic:mantic-calendar-series-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

openapi: 3.2.0
info:
  title: Fast Calendar Series API
  version: 0.1.0
tags:
- name: calendar_series
paths:
  /webapp/question_list/{list_id}/available_series:
    get:
      tags:
      - calendar_series
      summary: Get Available Series
      description: 'The metrics this calendar can show, whether or not it shows them today, and

        what the organisation billed for them has left to spend.'
      operationId: get_available_series_webapp_question_list__list_id__available_series_get
      security:
      - OAuth2AuthorizationCodeBearer: []
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: integer
          title: List Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAvailableSeriesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /webapp/question_list/{list_id}/series/{series_key}:
    post:
      tags:
      - calendar_series
      summary: Subscribe Series
      description: Charge for a metric and queue the work that puts it on this calendar.
      operationId: subscribe_series_webapp_question_list__list_id__series__series_key__post
      security:
      - OAuth2AuthorizationCodeBearer: []
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: integer
          title: List Id
      - name: series_key
        in: path
        required: true
        schema:
          type: string
          title: Series Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscribeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - calendar_series
      summary: Unsubscribe Series
      description: 'Remove a metric from this calendar. The family keeps generating for other lists,

        and the credit returns only once no calendar in the organisation shows it.'
      operationId: unsubscribe_series_webapp_question_list__list_id__series__series_key__delete
      security:
      - OAuth2AuthorizationCodeBearer: []
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          type: integer
          title: List Id
      - name: series_key
        in: path
        required: true
        schema:
          type: string
          title: Series Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsubscribeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    service__api__routes__webapp__calendar_series__BudgetResponse:
      properties:
        total:
          anyOf:
          - type: integer
          - type: 'null'
          title: Total
        spent:
          type: integer
          title: Spent
        remaining:
          anyOf:
          - type: integer
          - type: 'null'
          title: Remaining
      type: object
      required:
      - total
      - spent
      - remaining
      title: BudgetResponse
      description: '`total` and `remaining` are null where nothing is metered: no organisation billed,

        or one whose allowance is unlimited.'
    CatalogueSeriesResponse:
      properties:
        series_key:
          type: string
          title: Series Key
        subject:
          type: string
          title: Subject
        geography:
          anyOf:
          - type: string
          - type: 'null'
          title: Geography
        unit:
          anyOf:
          - type: string
          - type: 'null'
          title: Unit
        frequency:
          type: string
          title: Frequency
        subdomain:
          type: string
          title: Subdomain
        state:
          $ref: '#/components/schemas/SeriesState'
        preview_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Preview Title
        next_release_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Next Release At
        reference_period_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Reference Period Date
        previous_value:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Value
        previous_period_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Previous Period Date
        unavailable_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Unavailable Reason
        cost_units:
          type: integer
          title: Cost Units
        included:
          type: boolean
          title: Included
        first_forecast:
          type: boolean
          title: First Forecast
      additionalProperties: false
      type: object
      required:
      - series_key
      - subject
      - geography
      - unit
      - frequency
      - subdomain
      - state
      - preview_title
      - next_release_at
      - reference_period_date
      - previous_value
      - previous_period_date
      - unavailable_reason
      - cost_units
      - included
      - first_forecast
      title: CatalogueSeriesResponse
    GetAvailableSeriesResponse:
      properties:
        series:
          items:
            $ref: '#/components/schemas/CatalogueSeriesResponse'
          type: array
          title: Series
        budget:
          $ref: '#/components/schemas/service__api__routes__webapp__calendar_series__BudgetResponse'
      type: object
      required:
      - series
      - budget
      title: GetAvailableSeriesResponse
    SubscribeResponse:
      properties:
        series_key:
          type: string
          title: Series Key
        series:
          anyOf:
          - $ref: '#/components/schemas/CatalogueSeriesResponse'
          - type: 'null'
        budget:
          $ref: '#/components/schemas/service__api__routes__webapp__calendar_series__BudgetResponse'
      type: object
      required:
      - series_key
      - series
      - budget
      title: SubscribeResponse
      description: 'The metric is charged for and queued, not yet on the calendar: provisioning it

        can mean enabling a family and forecasting it for the first time.'
    UnsubscribeResponse:
      properties:
        series:
          anyOf:
          - $ref: '#/components/schemas/CatalogueSeriesResponse'
          - type: 'null'
        budget:
          $ref: '#/components/schemas/service__api__routes__webapp__calendar_series__BudgetResponse'
      type: object
      required:
      - series
      - budget
      title: UnsubscribeResponse
    SeriesState:
      type: string
      enum:
      - subscribed
      - pending
      - available
      - dormant
      - unavailable
      - initialising
      - failed
      title: SeriesState
      description: Which control a family offers on a dashboard.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: https://app.mantic.com/auth/oauth2/authorize
          tokenUrl: https://app.mantic.com/auth/oauth2/token