# API Services

Looking for available messages and enums? See the [API reference](reference.md).

<div class="bd-api-index" markdown="1">

<section class="bd-api-index__package" data-package="bitdrift.public.unary.admin.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [AdminService](bitdrift_public_unary_admin_v1_AdminService.md)

Manages administrative settings including Slack integrations, notification groups, views, API/SDK keys, users, teams, and connectors.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [CreateKey](bitdrift_public_unary_admin_v1_AdminService.md#CreateKey)
  Creates an API key or SDK key for the authenticated user.

- [DeleteConnector](bitdrift_public_unary_admin_v1_AdminService.md#DeleteConnector)
  Deletes a connector by ID.

- [DeleteNotificationGroup](bitdrift_public_unary_admin_v1_AdminService.md#DeleteNotificationGroup)
  Deletes a notification group for the organization.

- [DeleteView](bitdrift_public_unary_admin_v1_AdminService.md#DeleteView)
  Deletes a view by ID.

- [FavoriteView](bitdrift_public_unary_admin_v1_AdminService.md#FavoriteView)
  Marks or unmarks a view as a favorite for the authenticated user.

- [GetConnectors](bitdrift_public_unary_admin_v1_AdminService.md#GetConnectors)
  Lists all connectors for the organization.

- [GetKeys](bitdrift_public_unary_admin_v1_AdminService.md#GetKeys)
  Lists the API and SDK keys available to the authenticated user.

- [GetNotificationGroups](bitdrift_public_unary_admin_v1_AdminService.md#GetNotificationGroups)
  Lists all notification groups for the organization.

- [GetView](bitdrift_public_unary_admin_v1_AdminService.md#GetView)
  Retrieves a view by ID.

- [ListViews](bitdrift_public_unary_admin_v1_AdminService.md#ListViews)
  Lists all views for the organization and the given service.

- [RevokeKey](bitdrift_public_unary_admin_v1_AdminService.md#RevokeKey)
  Revokes an API key or SDK key by ID.

- [TestAlertNotification](bitdrift_public_unary_admin_v1_AdminService.md#TestAlertNotification)
  Sends a test alert notification to validate formatting and mentions.

- [TestNotificationGroup](bitdrift_public_unary_admin_v1_AdminService.md#TestNotificationGroup)
  Sends a test notification to all targets in a notification group.

- [UpsertConnector](bitdrift_public_unary_admin_v1_AdminService.md#UpsertConnector)
  Creates or updates a connector for the organization.

- [UpsertNotificationGroup](bitdrift_public_unary_admin_v1_AdminService.md#UpsertNotificationGroup)
  Creates or updates a notification group for the organization.

- [UpsertView](bitdrift_public_unary_admin_v1_AdminService.md#UpsertView)
  Creates a view or updates an existing view for the organization.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.alerts.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [AlertsService](bitdrift_public_unary_alerts_v1_AlertsService.md)

Provides workflow alert configuration, listing, and history operations.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [GetAlertConfig](bitdrift_public_unary_alerts_v1_AlertsService.md#GetAlertConfig)
  Gets alert configuration for a workflow chart.

- [GetAlertHistory](bitdrift_public_unary_alerts_v1_AlertsService.md#GetAlertHistory)
  Gets history for a single workflow alert.

- [GetAllAlerts](bitdrift_public_unary_alerts_v1_AlertsService.md#GetAllAlerts)
  Lists workflow alerts for the organization.

- [UpsertAlertConfig](bitdrift_public_unary_alerts_v1_AlertsService.md#UpsertAlertConfig)
  Upserts alert configuration for a workflow chart.

</div>

</section>


<section class="bd-api-index__service" markdown="1">

### [IssuesAlertsService](bitdrift_public_unary_alerts_v1_IssuesAlertsService.md)

Provides issues alert configuration, listing, and history operations.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [GetAlertConfig](bitdrift_public_unary_alerts_v1_IssuesAlertsService.md#GetAlertConfig)
  Gets the alert configuration for an issues view.

- [GetAlertHistory](bitdrift_public_unary_alerts_v1_IssuesAlertsService.md#GetAlertHistory)
  Gets history for a single issues alert.

- [GetAllAlerts](bitdrift_public_unary_alerts_v1_IssuesAlertsService.md#GetAllAlerts)
  Lists issues alerts for the organization.

- [UpsertAlertConfig](bitdrift_public_unary_alerts_v1_IssuesAlertsService.md#UpsertAlertConfig)
  Upserts the alert configuration for an issues view.

</div>

</section>


<section class="bd-api-index__service" markdown="1">

### [NotificationsService](bitdrift_public_unary_alerts_v1_NotificationsService.md)

Manages session capture notification settings for workflow rules.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [GetCapturedSessionNotification](bitdrift_public_unary_alerts_v1_NotificationsService.md#GetCapturedSessionNotification)
  Gets the notification configuration for a session capture rule within a workflow.

- [UpsertCapturedSessionNotification](bitdrift_public_unary_alerts_v1_NotificationsService.md#UpsertCapturedSessionNotification)
  Upserts the notification configuration for a session capture rule within a workflow.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.dashboards.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [DashboardService](bitdrift_public_unary_dashboards_v1_DashboardService.md)

Provides access to dashboards and chart data, including layout and time series metrics.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [DeleteCustomDashboard](bitdrift_public_unary_dashboards_v1_DashboardService.md#DeleteCustomDashboard)
  Deletes a custom dashboard.

- [FavoriteCustomDashboard](bitdrift_public_unary_dashboards_v1_DashboardService.md#FavoriteCustomDashboard)
  Toggles the favorite status of a custom dashboard for the current user.

- [GetActiveDevices](bitdrift_public_unary_dashboards_v1_DashboardService.md#GetActiveDevices)
  Gets the unique active devices for a given time range and filter conditions. Active devices in this context are *any* devices that connected to the platform, regardless of whether they sent any metrics, were freshly started, moved to foreground, etc. This includes devices that connected as part of background activity so the number will be higher than "app open" based numbers.

- [GetChartsData](bitdrift_public_unary_dashboards_v1_DashboardService.md#GetChartsData)
  Retrieves chart data for one or more charts.

- [GetDashboard](bitdrift_public_unary_dashboards_v1_DashboardService.md#GetDashboard)
  Retrieves a single dashboard by its unique identifier.

- [GetUniqueAppIds](bitdrift_public_unary_dashboards_v1_DashboardService.md#GetUniqueAppIds)
  Returns the distinct platform, app ID, and app version combinations seen in the specified time range.

- [GetWorkflowCharts](bitdrift_public_unary_dashboards_v1_DashboardService.md#GetWorkflowCharts)
  Retrieves the chart configuration for a single workflow.

- [ListCharts](bitdrift_public_unary_dashboards_v1_DashboardService.md#ListCharts)
  Lists all charts available to the user.

- [ListDashboards](bitdrift_public_unary_dashboards_v1_DashboardService.md#ListDashboards)
  Lists all dashboards available to the authenticated user.

- [UpsertCustomDashboard](bitdrift_public_unary_dashboards_v1_DashboardService.md#UpsertCustomDashboard)
  Upserts a custom dashboard.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.debug_files.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [DebugFileService](bitdrift_public_unary_debug_files_v1_DebugFileService.md)

Manages debug files for the authenticated organization.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [ListDebugFiles](bitdrift_public_unary_debug_files_v1_DebugFileService.md#ListDebugFiles)
  Lists debug files matching the specified filter criteria.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.entity.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [EntityService](bitdrift_public_unary_entity_v1_EntityService.md)

Provides entity details, known-entity management, and entity recording requests.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [CancelEntityRecordNextOnlineTime](bitdrift_public_unary_entity_v1_EntityService.md#CancelEntityRecordNextOnlineTime)
  Cancels an active request to record data the next time the entity comes online.

- [DeleteKnownEntity](bitdrift_public_unary_entity_v1_EntityService.md#DeleteKnownEntity)
  Deletes a known entity.

- [GetEntityInfo](bitdrift_public_unary_entity_v1_EntityService.md#GetEntityInfo)
  Retrieves summary information about a specific entity.

- [ListEntityRecordNextOnlineTimes](bitdrift_public_unary_entity_v1_EntityService.md#ListEntityRecordNextOnlineTimes)
  Lists entity recording requests with pagination, filtering, and sorting.

- [ListKnownEntities](bitdrift_public_unary_entity_v1_EntityService.md#ListKnownEntities)
  Lists known entities.

- [ListRecentlyViewedEntities](bitdrift_public_unary_entity_v1_EntityService.md#ListRecentlyViewedEntities)
  Lists recently viewed entities for the authenticated user.

- [UpsertEntityRecordNextOnlineTime](bitdrift_public_unary_entity_v1_EntityService.md#UpsertEntityRecordNextOnlineTime)
  Creates or updates a request to record data the next time the entity comes online.

- [UpsertKnownEntity](bitdrift_public_unary_entity_v1_EntityService.md#UpsertKnownEntity)
  Creates or updates a known entity.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.health.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [HealthService](bitdrift_public_unary_health_v1_HealthService.md)

The HealthService provides methods for checking the health and status of the system, including the number of connected SDK clients and the current queue delays for processing ingested data.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [GetSystemStatus](bitdrift_public_unary_health_v1_HealthService.md#GetSystemStatus)
  Get the overall system status, including the number of SDK clients connected and the current queue delay for processing ingested data.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.issues.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [IssueService](bitdrift_public_unary_issues_v1_IssueService.md)

Manages crash and issue tracking, including issue groups, individual issues, and feature flag analysis.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [GetIssue](bitdrift_public_unary_issues_v1_IssueService.md#GetIssue)
  Retrieves a single issue by ID.

- [GetIssueFeatureFlags](bitdrift_public_unary_issues_v1_IssueService.md#GetIssueFeatureFlags)
  Retrieves the feature flags associated with an issue.

- [GetIssueGroup](bitdrift_public_unary_issues_v1_IssueService.md#GetIssueGroup)
  Retrieves a single issue group by ID.

- [GetIssueGroupAttributes](bitdrift_public_unary_issues_v1_IssueService.md#GetIssueGroupAttributes)
  Retrieves ancillary attributes for an issue group, such as custom tags or metadata.

- [ListIssueGroups](bitdrift_public_unary_issues_v1_IssueService.md#ListIssueGroups)
  Lists issue groups matching the specified filter criteria.

- [ListIssues](bitdrift_public_unary_issues_v1_IssueService.md#ListIssues)
  Lists issues matching the specified filter criteria.

- [ListIssuesV2](bitdrift_public_unary_issues_v1_IssueService.md#ListIssuesV2)
  Lists issues in an issue group that match the specified filter criteria.

- [ListPossibleAssignees](bitdrift_public_unary_issues_v1_IssueService.md#ListPossibleAssignees)
  Lists the users who can be assigned to issues.

- [UpdateIssueGroupAssignees](bitdrift_public_unary_issues_v1_IssueService.md#UpdateIssueGroupAssignees)
  Updates the assignees for an issue group.

- [UpdateIssueGroupAttributes](bitdrift_public_unary_issues_v1_IssueService.md#UpdateIssueGroupAttributes)
  Updates ancillary attributes for an issue group, such as custom tags or metadata.

- [UpdateIssueGroupStatus](bitdrift_public_unary_issues_v1_IssueService.md#UpdateIssueGroupStatus)
  Updates the status of an issue group.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.timeline.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [TimelineService](bitdrift_public_unary_timeline_v1_TimelineService.md)

Provides access to session timeline data, including logs, metadata, and hydration state.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [AdvancedSearchSession](bitdrift_public_unary_timeline_v1_TimelineService.md#AdvancedSearchSession)
  Performs an advanced search across logs in a session.

- [GetHydrationStatus](bitdrift_public_unary_timeline_v1_TimelineService.md#GetHydrationStatus)
  Retrieves the hydration status of a session.

- [GetSessionInfo](bitdrift_public_unary_timeline_v1_TimelineService.md#GetSessionInfo)
  Retrieves metadata and attributes for a session.

- [GetSessionLogs](bitdrift_public_unary_timeline_v1_TimelineService.md#GetSessionLogs)
  Retrieves the logs for a session.

- [HydrateSession](bitdrift_public_unary_timeline_v1_TimelineService.md#HydrateSession)
  Triggers hydration of a session.

- [SearchSpans](bitdrift_public_unary_timeline_v1_TimelineService.md#SearchSpans)
  Searches spans within a session.

</div>

</section>


</section>

<section class="bd-api-index__package" data-package="bitdrift.public.unary.workflows.v1" markdown="1">

<section class="bd-api-index__service" markdown="1">

### [WorkflowDataService](bitdrift_public_unary_workflows_v1_WorkflowDataService.md)

Queries data collected by workflow actions, such as captured sessions.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [FetchCapturedSessions](bitdrift_public_unary_workflows_v1_WorkflowDataService.md#FetchCapturedSessions)
  Fetches captured sessions matching the given criteria, optionally scoped to a specific action.

</div>

</section>


<section class="bd-api-index__service" markdown="1">

### [WorkflowService](bitdrift_public_unary_workflows_v1_WorkflowService.md)

Manages workflows and their lifecycle, including creation, deployment, and configuration.

<div class="bd-api-index__methods" markdown="1">

**Methods**

- [CreateWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#CreateWorkflow)
  Creates a new workflow.

- [DeleteWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#DeleteWorkflow)
  Deletes a workflow permanently.

- [DeployWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#DeployWorkflow)
  Deploys a workflow, making it active and able to receive traffic.

- [FavoriteWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#FavoriteWorkflow)
  Updates whether a workflow is favorited for the current user.

- [GetWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#GetWorkflow)
  Retrieves a workflow by ID.

- [ListTags](bitdrift_public_unary_workflows_v1_WorkflowService.md#ListTags)
  Lists all available workflow tags.

- [ListWorkflows](bitdrift_public_unary_workflows_v1_WorkflowService.md#ListWorkflows)
  Lists all workflows available to the authenticated user.

- [RenameWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#RenameWorkflow)
  Renames a workflow without modifying any other fields.

- [StopWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#StopWorkflow)
  Stops a running workflow.

- [UpdateWorkflow](bitdrift_public_unary_workflows_v1_WorkflowService.md#UpdateWorkflow)
  Updates a workflow, replacing the existing configuration with the provided definition.

- [UpsertWorkflowChartMetadata](bitdrift_public_unary_workflows_v1_WorkflowService.md#UpsertWorkflowChartMetadata)
  Creates or updates chart metadata for a workflow.

- [UpsertWorkflowTags](bitdrift_public_unary_workflows_v1_WorkflowService.md#UpsertWorkflowTags)
  Assigns tags to a workflow.

</div>

</section>


</section>

</div>