Bigeye

Bigeye Favorite Service API

The FavoriteService API from Bigeye — 4 operation(s) for favoriteservice.

GitHub OpenAPI

Operations 5

POST /api/v1/favorites/bulk Mark multiple entities as favorites #
POST /api/v1/favorites/unfavorite/bulk Remove multiple entities from favorites #
GET /api/v1/favorites Get favorites for the current user #
POST /api/v1/favorites Mark an entity as a favorite #
POST /api/v1/favorites/unfavorite Remove an entity from favorites #

Documentation

📖
Documentation
https://docs.bigeye.com/docs/api-user-guide
📖
APIReference
https://docs.bigeye.com/reference
📖
Documentation
https://docs.bigeye.com/docs/monitoring
📖
Documentation
https://docs.bigeye.com/docs/getting-started-scanning

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-favoriteservice-api-openapi.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/bigeye:bigeye-favoriteservice-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

bigeye-favoriteservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Metadata Favorite Service API
  version: version not set
servers:
- url: https://app.bigeye.com
security:
- basicAuth: []
- Personal_API_Key: []
tags:
- name: FavoriteService
paths:
  /api/v1/favorites/bulk:
    post:
      operationId: FavoriteService_BulkFavorite
      requestBody:
        $ref: '#/components/requestBodies/generatedBulkFavoriteRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBulkFavoriteResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Mark multiple entities as favorites
      tags:
      - FavoriteService
  /api/v1/favorites/unfavorite/bulk:
    post:
      operationId: FavoriteService_BulkUnfavorite
      requestBody:
        $ref: '#/components/requestBodies/generatedBulkFavoriteRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedBulkFavoriteResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Remove multiple entities from favorites
      tags:
      - FavoriteService
  /api/v1/favorites:
    get:
      operationId: FavoriteService_GetFavorites
      parameters:
      - in: query
        name: workspaceId
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedFavoriteListResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Get favorites for the current user
      tags:
      - FavoriteService
    post:
      operationId: FavoriteService_Favorite
      requestBody:
        $ref: '#/components/requestBodies/generatedFavoriteRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedEmpty'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Mark an entity as a favorite
      tags:
      - FavoriteService
  /api/v1/favorites/unfavorite:
    post:
      operationId: FavoriteService_Unfavorite
      requestBody:
        $ref: '#/components/requestBodies/generatedFavoriteRequest'
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generatedEmpty'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimeError'
      summary: Remove an entity from favorites
      tags:
      - FavoriteService
components:
  schemas:
    generatedEmpty:
      type: object
    protobufAny:
      properties:
        typeUrl:
          type: string
        value:
          format: byte
          type: string
      type: object
    runtimeError:
      properties:
        code:
          format: int32
          type: integer
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
        error:
          type: string
        message:
          type: string
      type: object
    generatedBulkFavoriteRequest:
      properties:
        favorites:
          items:
            $ref: '#/components/schemas/generatedFavoriteItem'
          type: array
      type: object
    generatedFavoriteItem:
      properties:
        entityId:
          format: int32
          type: integer
        entityName:
          type: string
        entityType:
          $ref: '#/components/schemas/generatedTaggableEntityType'
      type: object
    generatedFavoriteFailure:
      properties:
        favorite:
          $ref: '#/components/schemas/generatedFavoriteItem'
        reason:
          type: string
      type: object
    generatedTaggableEntityType:
      default: TAGGABLE_ENTITY_TYPE_UNSPECIFIED
      enum:
      - TAGGABLE_ENTITY_TYPE_UNSPECIFIED
      - TAGGABLE_ENTITY_TYPE_SOURCE
      - TAGGABLE_ENTITY_TYPE_SCHEMA
      - TAGGABLE_ENTITY_TYPE_DATASET
      - TAGGABLE_ENTITY_TYPE_METRIC
      - TAGGABLE_ENTITY_TYPE_DELTA
      - TAGGABLE_ENTITY_TYPE_COLUMN
      - TAGGABLE_ENTITY_TYPE_SLA
      - TAGGABLE_ENTITY_TYPE_BI_TOOL
      - TAGGABLE_ENTITY_TYPE_N_WAY_DELTA
      - TAGGABLE_ENTITY_TYPE_VIRTUAL_TABLE
      - TAGGABLE_ENTITY_TYPE_INTEGRATION
      - TAGGABLE_ENTITY_TYPE_DBT_PROJECT
      - TAGGABLE_ENTITY_TYPE_DBT_JOB
      - TAGGABLE_ENTITY_TYPE_CUSTOM_RULE
      - TAGGABLE_ENTITY_TYPE_META_CENTER_ENTITY
      - TAGGABLE_ENTITY_TYPE_DATA_NODE_ENTITY
      - TAGGABLE_ENTITY_TYPE_META_CENTER_REPOSITORY
      - TAGGABLE_ENTITY_TYPE_CUSTOM_REPOSITORY
      type: string
    generatedFavoriteRequest:
      properties:
        favorite:
          $ref: '#/components/schemas/generatedFavoriteItem'
      type: object
    generatedBulkFavoriteResponse:
      properties:
        failures:
          items:
            $ref: '#/components/schemas/generatedFavoriteFailure'
          type: array
        successes:
          items:
            $ref: '#/components/schemas/generatedFavoriteItem'
          type: array
      type: object
    generatedFavoriteListResponse:
      properties:
        favorites:
          items:
            $ref: '#/components/schemas/generatedFavoriteItem'
          type: array
      type: object
  requestBodies:
    generatedBulkFavoriteRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generatedBulkFavoriteRequest'
      required: true
    generatedFavoriteRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/generatedFavoriteRequest'
      required: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    Agent_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
    Personal_API_Key:
      description: Add 'apikey ' to the beginning of your api key
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  method: harvested
  publisher: Bigeye
  source: https://docs.bigeye.com/openapi/metadata.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)