How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bigeye

Bigeye Custom Rule Service API

The CustomRuleService API from Bigeye — 8 operation(s) for customruleservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Bigeye Custom Rule Service API is one of 45 APIs that Bigeye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CustomRuleService. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 8 paths, and defines 83 schemas. It is described by OpenAPI 3.2.0, at version version not set.

Requests are made against a single base URL, https://app.bigeye.com.

9 operations 8 paths 83 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
version not set
Base URL
https://app.bigeye.com
Authentication
HTTP Basic, API Key, API Key
Resource Areas
1

Authentication & Security 3

Bigeye Custom Rule Service API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (Agent_API_Key). An API key is passed in the header as Authorization (Personal_API_Key). By default, every request must be authenticated.

  • Agent_API_Key — Add 'apikey ' to the beginning of your api key
  • Personal_API_Key — Add 'apikey ' to the beginning of your api key

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

CustomRuleService 9
POST
/api/v1/custom-rules
Create a custom rule
CustomRuleService_CreateCustomRule body → 200default
DELETE
/api/v1/custom-rules/{customRuleId}
Delete a custom rule
CustomRuleService_DeleteCustomRule 1 param → 200default
GET
/api/v1/custom-rules/{customRuleId}
Get a custom rule
CustomRuleService_GetCustomRule 1 param → 200default
GET
/api/v1/custom-rules/{customRuleId}/revisions
Get custom rule revisions
CustomRuleService_GetCustomRuleRevisions 1 param → 200default
POST
/api/v1/custom-rules/fetch
Get custom rules
CustomRuleService_GetCustomRules body → 200default
GET
/api/v1/custom-rules/collection/{collectionId}
Get all custom rules for a collection
CustomRuleService_GetCustomRulesForCollection 1 param → 200default
GET
/api/v1/custom-rules/warehouse/{warehouseId}
Get all custom rules for a warehouse
CustomRuleService_GetCustomRulesForWarehouse 1 param → 200default
GET
/api/v1/custom-rules/run/{customRuleId}
Run a custom rule
CustomRuleService_RunCustomRule 1 param → 200default
PUT
/api/v1/custom-rules/{id}
Update a custom rule
CustomRuleService_UpdateCustomRule 1 param body → 200default

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are generatedMetricConfiguration (29 properties), generatedCustomRule (26 properties), generatedTable (23 properties), generatedMetricMetadata (22 properties). Each schema is shown below with its type and property counts.

generatedTag
object
6 properties
generatedMetricType
object
6 properties
generatedSimpleBoundType
string
generatedColumnCorrelation
object
2 properties
generatedTimeIntervalType
string
generatedJoin
object
7 properties
generatedMetricParameter
object
4 properties
generatedCatalogEntityType
string
generatedRelativeThreshold
object
2 properties
generatedThreshold
object
6 properties
generatedCustomRulesThresholdType
string
generatedMetricMetadata
object
22 properties
generatedWebhookHeader
object
2 properties
generatedAggregationType
string
generatedCreateCustomRuleRequest
object
1 property
generatedTemplateMetric
object
3 properties
generatedCustomRuleSortOption
object
2 properties
generatedMonitorType
string
generatedIssueExternalTicketInfo
object
4 properties
generatedAutothresholdSensitivity
string
generatedWarehouseType
string
generatedJoinColumnPairing
object
4 properties
generatedTableType
string
generatedMetricGroupOverride
object
3 properties
generatedRowCreationTimeFilter
object
2 properties
generatedMetricObservedColumnResponse
object
5 properties
generatedSlackChannelInfo
object
4 properties
generatedEmpty
object
generatedExternalTicketProvider
string
generatedSortDirection
string
generatedMetricStatus
string
generatedMetricRunAnnotation
object
4 properties
generatedMetricRun
object
19 properties
generatedNamedSchedule
object
5 properties
generatedMetricRunLabel
string
generatedCustomRuleInfo
object
12 properties
generatedPaginationInfo
object
5 properties
generatedRevisionInfo
object
3 properties
generatedEntityInfo
object
4 properties
generatedStandardDeviationThreshold
object
2 properties
generatedMetricRunStatus
string
generatedPredefinedMetricName
string
generatedExternalMonitorType
string
generatedFreshnessScheduleThreshold
object
4 properties
generatedWebhook
object
2 properties
generatedConstantThreshold
object
1 property
generatedCompanionMetric
object
3 properties
generatedJoinType
string
generatedUser
object
8 properties
generatedTimeInterval
object
2 properties
generatedTable
object
Representation of a table in a warehouse.
23 properties
generatedGetCustomRuleListRequest
object
14 properties
generatedPredefinedMetric
object
1 property
generatedMetricInfo
object
14 properties
protobufAny
object
2 properties
generatedForecastModelType
string
generatedNoneThreshold
object
generatedMetricSchedule
object
2 properties
generatedSchemaChangeInfo
object
3 properties
generatedLookbackType
string
generatedCustomRuleRevision
object
2 properties
generatedGetCustomRuleListResponse
object
2 properties
generatedCustomRuleSortField
string
generatedCustomRuleType
string
generatedMetricGroupDimension
object
3 properties
generatedMetricRunFailureReason
string
generatedCompanionMetricType
string
generatedSchema
object
Representation of a schema in a warehouse.
16 properties
generatedMonitoredObject
object
2 properties
generatedMetricConfiguration
object
29 properties
generatedColumnWithTable
object
2 properties
generatedTableColumn
object
Representation of a column in a table.
15 properties
generatedJoinTableFilter
object
2 properties
generatedRevisionType
string
generatedSimpleBound
object
2 properties
generatedGetCustomRuleRevisionsResponse
object
1 property
generatedMetricCreationState
string
generatedExternalMonitor
object
1 property
generatedIdAndDisplayName
object
2 properties
runtimeError
object
4 properties
generatedAutoThreshold
object
5 properties
generatedCustomRule
object
26 properties
generatedNotificationChannel
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigeye-customruleservice-api-openapi.yml Raw ↑

Other APIs Bigeye publishes across the network.

Bigeye MCP Gateway
AE Profile APIs.io
Bigeye Agent Service API
AE Profile APIs.io
Bigeye API Key Service API
AE Profile APIs.io
Bigeye Catalog Rebuilds Service API
AE Profile APIs.io
Bigeye Classifier Service API
AE Profile APIs.io
Bigeye Collection Service API
AE Profile APIs.io
Bigeye Collection V2 Service API
AE Profile APIs.io
Bigeye Column Service API
AE Profile APIs.io
Bigeye Company Service API
AE Profile APIs.io
Bigeye Comparison Table Service API
AE Profile APIs.io
Bigeye Config Service API
AE Profile APIs.io
Bigeye Dashboard Service API
AE Profile APIs.io
#CustomRuleService
← Back to B APIs
API Details
ID
bigeye:bigeye-customruleservice-api
Base URL
https://app.bigeye.com
Docs
https://docs.bigeye.com/reference
Provider
Bigeye
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bigeye-customruleservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bigeye-customruleservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Bigeye Custom Rule Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.