Workflows

Get Workflow Logs

Returns the logs for a workflow, grouped by task. These are the same logs that appear on the Workflow page in Tetra.

By default, the response includes logs for the current run of each task in the workflow. To get logs for a single task, use the taskId query parameter. When you filter by taskId, the response also includes logs from earlier runs of that task, such as runs that were superseded by a retry. Logs from all runs are returned in the same array. The current run's entries come first, followed by earlier runs from oldest to newest. Entries don't indicate which run they came from.

If the workflow can't be found in your organization, the endpoint returns 200 with an empty array ([]).

get/v1/workflow/workflows/{workflowId}/logs

Request

  • Base URL
    https://api.tetrascience.com
  • URL
    https://api.tetrascience.com/v1/workflow/workflows/{workflowId}/logs
  • Auth
    API key in header ts-auth-token and API key in header x-org-slug

Path parameters

workflowIdstring uuid required

The ID of the workflow to get logs for.

Query parameters

taskIdstring

The ID of a task in the workflow. When provided, only that task's logs are returned, including logs from earlier runs of the task.

Response

The workflow's logs. Each key other than currentWfStatus is a task ID, and its value is an array of log entries for that task. If the workflow can't be found, the response is an empty array ([]).

currentWfStatus'pending' | 'queued' | 'in-progress' | 'completed' | 'failed' | 'canceled'

The workflow's current status.

Example response

{
  "currentWfStatus": "failed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.