---
updatedAt: 2026-04-29T23:07:57.000Z
agentTools:
  projectIndex: https://docs.bigeye.com/llms.txt
---

# Mark an entity as a favorite

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Metadata",
    "version": "version not set"
  },
  "paths": {
    "/api/v1/favorites": {
      "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"
        ]
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    },
    {
      "Personal_API_Key": []
    }
  ],
  "servers": [
    {
      "url": "https://app.bigeye.com"
    }
  ],
  "components": {
    "requestBodies": {
      "generatedFavoriteRequest": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/generatedFavoriteRequest"
            }
          }
        },
        "required": true
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      },
      "Personal_API_Key": {
        "description": "Add 'apikey ' to the beginning of your api key",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    },
    "schemas": {
      "generatedEmpty": {
        "type": "object"
      },
      "generatedFavoriteItem": {
        "properties": {
          "entityId": {
            "format": "int32",
            "type": "integer"
          },
          "entityName": {
            "type": "string"
          },
          "entityType": {
            "$ref": "#/components/schemas/generatedTaggableEntityType"
          }
        },
        "type": "object"
      },
      "generatedFavoriteRequest": {
        "properties": {
          "favorite": {
            "$ref": "#/components/schemas/generatedFavoriteItem"
          }
        },
        "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"
      },
      "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"
      }
    }
  }
}
```