Skip to main content
GET
See what a proactive task did this period

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

worker_id
string
required

The worker's id, from GET /v1/digital_workers

task_id
string
required

The task's id, from GET /v1/digital_workers/{worker_id}/tasks

Response

200 - application/json

Successful Response

book_size
integer | null
required

How many accounts a book task covers this period, after its conditions; null for a task that isn't a book task, or when the worker's accounts can't be read

pending
CoveredAccount · object[] | null
required

The accounts it hasn't covered yet; at most 200

pending_count
integer | null
required

How many of those it hasn't covered yet this period

period
string
required

The period this covers: once for a task each account gets once, else the run's start (a recurring task's scheduled time, a book goal's day), ISO 8601 UTC

runs
TaskRun · object[]
required

What it did this period, oldest first; at most 200

runs_total
integer
required
scope
enum<string>
required

global is about your workspace and no one account; account is about the account in account_id; book is about each account the worker covers (its accounts.segment), once each period, narrowed by conditions

Available options:
global,
account,
book