Skip to main content

Workspace.Workflows.Activity

Tags: automation, workflows

Endpoints​

Batch​

GET /api/v2/w/{workspace_uuid}/workflows/activity/batch

Description:

Workflow creation and management

Get activity statistics for multiple workflows in a single request.

Query Parameters:

  • workflow_ids: Comma-separated list of workflow IDs (e.g., "1,2,3")
  • days: Number of days of sparkline data to return (1-90, default 7)

Response: Returns a dict mapping workflow ID (as string key) to activity object:

  • chatCount: Total number of chats (integer)
  • sparklineData: Array of integers representing daily chat counts (oldest to newest)

Authorization: Requires workflows:read scope

Parameters:

  • workflow_ids (String)
  • days (Integer)

Activity​

GET /api/v2/w/{workspace_uuid}/workflows/{workflow_id}/activity

Description:

Workflow creation and management

Get activity statistics for a workflow.

Returns sparkline data showing chat activity over the specified number of days.

Path Parameters:

  • workflow_id: Unique identifier of the workflow (integer)

Query Parameters:

  • days: Number of days of sparkline data to return (1-90, default 7)

Response: Returns an object containing:

  • chatCount: Total number of chats (integer)
  • sparklineData: Array of integers representing daily chat counts (oldest to newest)

Permissions: Requires workflows:read and workflow read visibility.

Error Responses:

  • 401 Unauthorized: Authentication required or invalid session
  • 403 Forbidden: User lacks workflow read visibility
  • 404 Not Found: Workflow with specified ID does not exist
  • 422 Unprocessable Entity: Invalid days parameter (must be 1-90)

Related Endpoints:

  • GET /workflows/{workflow_id} - Get workflow details
  • GET /workflows - List all workflows

Authorization: Requires workflows:read scope

Parameters:

  • workflow_id (Integer)
  • days (Integer)