View as Markdown

API Services

Looking for available messages and enums? See the API reference.

AdminService

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

Methods

• CreateKey Creates an API key or SDK key for the authenticated user.

• DeleteConnector Deletes a connector by ID.

• GetConnectors Lists all connectors for the organization.

• GetKeys Lists the API and SDK keys available to the authenticated user.

• RevokeKey Revokes an API key or SDK key by ID.

• UpsertConnector Creates or updates a connector for the organization.

DashboardService

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

Methods

• GetChartsData Retrieves chart data for one or more charts.

• GetUniqueAppIds Returns the distinct platform, app ID, and app version combinations seen in the specified time range.

DebugFileService

Manages debug files for the authenticated organization.

Methods

• ListDebugFiles Lists debug files matching the specified filter criteria.

IssueService

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

Methods

• GetIssue Retrieves a single issue by ID.

• GetIssueFeatureFlags Retrieves the feature flags associated with an issue.

• GetIssueGroup Retrieves a single issue group by ID.

• ListIssueGroups Lists issue groups matching the specified filter criteria.

• ListIssues Lists issues matching the specified filter criteria.

TimelineService

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

Methods

• GetHydrationStatus Retrieves the hydration status of a session.

• GetSessionInfo Retrieves metadata and attributes for a session.

• GetSessionLogs Retrieves the logs for a session.

• HydrateSession Triggers hydration of a session.

WorkflowDataService

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

Methods

• FetchCapturedSessions Fetches captured sessions matching the given criteria, optionally scoped to a specific action.

WorkflowService

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

Methods

• CreateWorkflow Creates a new workflow.

• DeleteWorkflow Deletes a workflow permanently.

• DeployWorkflow Deploys a workflow, making it active and able to receive traffic.

• GetWorkflow Retrieves a workflow by ID.

• ListWorkflows Lists all workflows available to the authenticated user.

• RenameWorkflow Renames a workflow without modifying any other fields.

• StopWorkflow Stops a running workflow.

• UpdateWorkflow Updates a workflow, replacing the existing configuration with the provided definition.

• UpsertWorkflowChartMetadata Creates or updates chart metadata for a workflow.