Jump to Content
Home
Guides
Recipes
API Reference
Log In
API Reference
Log In
Home
Guides
Recipes
API Reference
Get all collection information
Search
JUMP TO
Datawatch.proto
ApiKeyService
Get all Agent API Keys
get
Create an Agent API Key
post
Verify an Agent API Key
get
Delete an Agent API Key
delete
Get all Personal API Keys
get
Create a Personal API Key
post
Verify a Personal API Key
get
Delete a Personal API Key
delete
AgentService
Retrieve the latest health status of all agent sources
get
Synchronously ping all agent sources for their health status
get
Get the public key Bigeye currently has for the user's company Agent
get
Set the public key Bigeye will use to encrypt messages to the user's company Agent
put
Get the public key the user's company Agent should use when sending messages to Bigeye
get
Validate that the agent is working for a given source
get
CollectionService
Get all collections
get
Create collection
post
Get all collection information
get
Get collection information
get
Get specific collection
get
Delete collection
delete
Edit collection
put
ColumnService
Get specified columns
get
Get columns
post
Get applicable metric types for column
get
CompanyService
Update a company
put
ConfigService
Update configs
put
Get configs
post
CustomRuleService
Create a custom rule
post
Get all custom rules for a collection
get
Run a custom rule
get
Get custom rules
post
Get all custom rules for a warehouse
get
Get a custom rule
get
Delete a custom rule
delete
Update a custom rule
put
Get custom rule revisions
get
DashboardService
Get dashboard data series for requested types
post
Gets last updated date for dashboard data series
post
DeltaService
/api/v1/deltas
post
/api/v1/deltas
put
/api/v1/deltas/bulk
put
/api/v1/deltas/fetch
post
/api/v1/deltas/run/{deltaId}
get
/api/v1/deltas/{deltaId}
get
/api/v1/deltas/{deltaId}
delete
FavoriteService
/api/v1/favorites
get
/api/v1/favorites
post
/api/v1/favorites/bulk
post
/api/v1/favorites/unfavorite
post
/api/v1/favorites/unfavorite/bulk
post
GroupService
Get all groups
get
Create a group
post
Change a group's access to workspaces
put
Add or remove users to a group
put
Get a group
get
Delete a group
delete
Update a group
put
IntegrationService
Get integrations
get
Create integration
post
Get single dbt job run
get
Get single dbt job
get
Get single dbt project
get
Get dbt jobs for project
get
Get single Tableau workbook
get
Get single integration
get
Delete integration
delete
Update integration
put
Get entities for integration
get
IssueService
Batch update issues
put
Performs bulk issues updates
put
Get issues
post
Get issues summary by table
post
Get issue
get
Update issue
put
JoinService
Create join
post
Get joins
post
Get join
get
Delete join
delete
Update join
put
LineageService
/api/v1/lineage/integrations/{integrationId}/lineage/workflow
post
/api/v1/lineage/nodes
post
/api/v1/lineage/nodes/{dataNodeId}
get
/api/v1/lineage/nodes/{dataNodeId}
delete
/api/v1/lineage/nodes/{dataNodeId}/downstream/fetch
post
/api/v1/lineage/nodes/{dataNodeId}/relationships
get
/api/v1/lineage/nodes/{dataNodeId}/relationships
delete
/api/v1/lineage/relationships
post
/api/v1/lineage/relationships/{lineageRelationshipId}
get
/api/v1/lineage/relationships/{lineageRelationshipId}
delete
/api/v1/lineage/sources/{sourceId}/lineage/workflow
post
MetricTemplateService
Create or update a metric template
post
Get all metric templates
post
Get single metric template
get
Delete a metric template
delete
MetricService
Search metric configuration
get
Create or update metric
post
Get backfill status
get
Backfill metric
post
Batch edit metrics
put
Performs bulk metric updates
put
Performs bulk Delta updates
put
Get count of metrics
get
Get metric information
get
Get batch metric information
post
Get single metric information
get
Gets the list of all metadata metric names
get
Batch run metrics
post
Queue batch run metrics. This is useful for batches that take a long time to run. Returns a WorkflowResponse, which contains a workflow_id. The status of the batch can be checked by using the /api/v1/workflows/{workflow_id}/status endpoint.
post
Run metric
get
Get metric runs
post
Get metric scorecard
post
Gets the list of all table-level metric names
get
Validate a metric configuration
get
Get metric configuration
get
Delete metric
delete
Get metric revisions / history / timeline
get
Get sample debug rows for debug page
get
Get queries for debug page
get
DeltasService
Get info about the groups of a particular metric in a delta
get
Create a delta
post
Get information about deltas
post
Run a delta
get
Retrieve a delta configuration
get
Delete a delta
delete
Get list of metrics applicable for deltas
get
ObjectOwnerService
Set object owner
post
Get object owner
get
Delete object owner
delete
QueryService
/api/v1/query/counts
post
CatalogRebuildsService
/api/v1/rebuilds/schemas/{schemaId}
post
/api/v1/rebuilds/sources/{sourceId}
post
/api/v1/rebuilds/tables/single-table/queue
post
RoleService
Get all roles
get
Create a role
post
Update a role
put
Get a role
get
Delete a role
delete
List the groups and users who have been granted a role
get
NamedScheduleService
Get named schedules
get
Create a named schedule
post
Deleted a named schedule
delete
Get all entities using a given named schedule
get
SchemaChangeService
/api/v1/schema-changes/fetch
post
SchemaService
Search schemas
get
Get schemas
post
Get dbt jobs for schema
get
Get the region for a BigQuery schema (called dataset in BigQuery)
get
Remove the manual override of a region for a BigQuery schema (called dataset in BigQuery)
delete
Set the region for a BigQuery schema (called dataset in BigQuery)
put
Get workflow for schema
get
Get the current status for a workflow for a schema
get
SourceService
Create or update source
post
Get sources
post
Set the schemas that automatically get metadata metrics
post
Validate source
post
Get single source
get
Delete source
delete
Get workflow for source
get
Get the current status for a workflow for a source
get
TableService
Search tables
get
Set the date columns for a list of tables
put
Get tables
post
Profile a table
get
Profile a column
get
Get list of metrics applicable to an entire table, filtered for only the ones that are valid for that table's warehouse
get
Get the date column information for a table
get
Get dbt jobs for table
get
/api/v1/tables/{tableId}/required-partition-column
delete
/api/v1/tables/{tableId}/required-partition-column
put
Snooze table
post
Unsnooze table
post
Get workflow for table
get
Get the current status for a workflow for a table
get
TagService
/api/v1/tags
post
/api/v1/tags/bulk
post
/api/v1/tags/untag
post
/api/v1/tags/untag/bulk
post
/api/v1/tags/{entityType}/{entityId}
get
UserService
Get all users
get
Invite a new user
post
Delete users
post
Get a user
get
Update user name and/or groups
put
VirtualTableService
Get all Virtual Tables
get
Create a Virtual Table
post
Get Virtual Tables
post
Get a Virtual Table
get
Delete Virtual Table
delete
Update a Virtual Table
put
WorkflowService
Get the current status for a workflow
get
WorkspaceService
Get all workspaces
get
Create a workspace
post
Set the default workspace
put
Get a workspace
get
Delete a workspace
delete
Update a workspace
put
List the groups and users who can access a workspace
get
CollectionV2Service
Get all collection information
get
Fetch paginated collection information
post
Get collection information
get
LineageV2Service
Create custom lineage edge between two nodes
post
Bulk create custom lineage edges
post
Get edge
get
Delete custom lineage edge
delete
Create custom lineage node
post
Bulk create custom lineage nodes
post
Get lineage node by id
get
Delete custom lineage node
delete
Get lineage graph from a data node
get
WorkflowV2Service
Get status for V2 workflow without run
post
Get status for V2 workflow and run
post
Powered by
Get all collection information
get
https://app.bigeye.com/api/v1/collections/info
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
:
RESPONSE
Click
Try It!
to start a request and see the response here!
