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/cloudsmith-metrics-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: Cloudsmith API (v1) audit-log Metrics API
  description: The API to the Cloudsmith Service
  termsOfService: https://help.cloudsmith.io
  contact:
    name: Cloudsmith Support
    url: https://help.cloudsmith.io
    email: support@cloudsmith.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: v1
servers:
- url: https://api.cloudsmith.io/
security:
- apikey: []
- basic: []
tags:
- name: metrics
paths:
  /metrics/entitlements/{owner}/:
    parameters:
    - name: owner
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: metrics_entitlements_account_list
      summary: View for listing entitlement token metrics, across an account.
      description: View for listing entitlement token metrics, across an account.
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: finish
        in: query
        description: Include metrics upto and including this UTC date or UTC datetime. For example '2020-12-31' or '2021-12-13T00:00:00Z'.
        required: false
        schema:
          type: string
      - name: start
        in: query
        description: Include metrics from and including this UTC date or UTC datetime. For example '2020-12-31' or '2021-12-13T00:00:00Z'.
        required: false
        schema:
          type: string
      - name: tokens
        in: query
        description: A comma seperated list of tokens (slug perm) to include in the results.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Retrieved the metrics for entitlements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementUsageMetrics'
        '400':
          description: Request could not be processed (see detail).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '422':
          description: Missing or invalid parameters (see detail).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      tags:
      - metrics
  /metrics/entitlements/{owner}/{repo}/:
    parameters:
    - name: owner
      in: path
      required: true
      schema:
        type: string
    - name: repo
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: metrics_entitlements_repo_list
      summary: View for listing entitlement token metrics, for a repository.
      description: View for listing entitlement token metrics, for a repository.
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: finish
        in: query
        description: Include metrics upto and including this UTC date or UTC datetime. For example '2020-12-31' or '2021-12-13T00:00:00Z'.
        required: false
        schema:
          type: string
      - name: start
        in: query
        description: Include metrics from and including this UTC date or UTC datetime. For example '2020-12-31' or '2021-12-13T00:00:00Z'.
        required: false
        schema:
          type: string
      - name: tokens
        in: query
        description: A comma seperated list of tokens (slug perm) to include in the results.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Retrieved the metrics for entitlements.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementUsageMetrics'
        '400':
          description: Request could not be processed (see detail).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '422':
          description: Missing or invalid parameters (see detail).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      tags:
      - metrics
  /metrics/packages/{owner}/{repo}/:
    parameters:
    - name: owner
      in: path
      required: true
      schema:
        type: string
    - name: repo
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: metrics_packages_list
      summary: View for listing package usage metrics, for a repository.
      description: View for listing package usage metrics, for a repository.
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      - name: finish
        in: query
        description: Include metrics upto and including this UTC date or UTC datetime. For example '2020-12-31' or '2021-12-13T00:00:00Z'.
        required: false
        schema:
          type: string
      - name: packages
        in: query
        description: A comma seperated list of packages (slug perm) to include in the results.
        required: false
        schema:
          type: string
      - name: start
        in: query
        description: Include metrics from and including this UTC date or UTC datetime. For example '2020-12-31' or '2021-12-13T00:00:00Z'.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Retrieved the metrics for packages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageUsageMetrics'
        '400':
          description: Request could not be processed (see detail).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '422':
          description: Missing or invalid parameters (see detail).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      tags:
      - metrics
components:
  schemas:
    CommonBandwidthMetricsValue:
      description: Average bandwidth usage in the specified period, e.g. a day
      required:
      - display
      - value
      type: object
      properties:
        display:
          title: Display
          description: Bandwidth usage value
          type: string
          maxLength: 64
          minLength: 1
        units:
          title: Units
          description: Unit of measurement e.g. bytes
          type: string
          default: bytes
          minLength: 1
        value:
          title: Value
          description: Human readable version of display value
          type: integer
    CommonMetrics:
      required:
      - bandwidth
      - downloads
      type: object
      properties:
        active:
          title: Active
          description: Number of packages with at least 1 download
          type: integer
          default: 0
        bandwidth:
          $ref: '#/components/schemas/CommonBandwidthMetrics'
        downloads:
          $ref: '#/components/schemas/CommonDownloadsMetrics'
        inactive:
          title: Inactive
          description: Packages with zero downloads
          type: integer
          default: 0
        total:
          title: Total
          description: Total number of packages in repo
          type: integer
          default: 0
    ErrorDetail:
      required:
      - detail
      type: object
      properties:
        detail:
          title: Detail
          description: An extended message for the response.
          type: string
          minLength: 1
        fields:
          title: Fields
          description: 'A Dictionary of related errors where key: Field and value: Array of Errors related to that field'
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              minLength: 1
    CommonDownloadsMetricsValue:
      required:
      - value
      type: object
      properties:
        value:
          title: Value
          type: integer
    PackageUsageMetrics:
      required:
      - packages
      type: object
      properties:
        packages:
          $ref: '#/components/schemas/CommonMetrics'
    CommonBandwidthMetrics:
      required:
      - average
      - highest
      - lowest
      - total
      type: object
      properties:
        average:
          $ref: '#/components/schemas/CommonBandwidthMetricsValue'
        highest:
          $ref: '#/components/schemas/CommonBandwidthMetricsValue'
        lowest:
          $ref: '#/components/schemas/CommonBandwidthMetricsValue'
        total:
          $ref: '#/components/schemas/CommonBandwidthMetricsValue'
    CommonDownloadsMetrics:
      required:
      - average
      - highest
      - lowest
      - total
      type: object
      properties:
        average:
          $ref: '#/components/schemas/CommonDownloadsMetricsValue'
        highest:
          $ref: '#/components/schemas/CommonDownloadsMetricsValue'
        lowest:
          $ref: '#/components/schemas/CommonDownloadsMetricsValue'
        total:
          $ref: '#/components/schemas/CommonDownloadsMetricsValue'
    EntitlementUsageMetrics:
      required:
      - tokens
      type: object
      properties:
        tokens:
          $ref: '#/components/schemas/CommonMetrics'
  securitySchemes:
    apikey:
      type: apiKey
      name: X-Api-Key
      in: header
    basic:
      type: http
      scheme: basic