Skip to content
Try for free
On this page

Tables

Get row group run

Read one row’s workflow or enrichment-group outcome: run state, output cells keyed by column name, and providers in cascade order with status, hosted-key cost, duration, and the matching provider. `runState: null` means never run; `cascade: null` means no breakdown was recorded. Missing tables, rows, or groups return `404`. Run state above 2 MiB returns `413`. OAuth scope: `api:read`.

GET/api/v2/tables/{tableId}/rows/{rowId}/enrichment/{groupId}

Read one row’s workflow or enrichment-group outcome: run state, output cells keyed by column name, and providers in cascade order with status, hosted-key cost, duration, and the matching provider. runState: null means never run; cascade: null means no breakdown was recorded. Missing tables, rows, or groups return 404. Run state above 2 MiB returns 413.

OAuth scope: api:read.

Authentication

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

Send X-API-Key in the request header.

Alternatively

Send a Sim OAuth access token in Authorization: Bearer. See OAuth authentication and scopes.

Authorization: Bearer YOUR_ACCESS_TOKEN

Required scopes: api:read

OAuth flows
json
{
  "authorizationCode": {
    "authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
    "tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
    "scopes": {
      "api:read": "Read your workspaces, workflows, files, tables, and logs",
      "api:write": "Read, create, change, run, and delete resources in your workspaces",
      "offline_access": "Stay signed in without asking again"
    }
  }
}

OAuth scope: api:read.

Path parameters

tableIdstringRequired

Unique table identifier.

minLength
1
rowIdstringRequired

Unique table row identifier.

minLength
1
groupIdstringRequired

Workflow or enrichment group to run.

minLength
1

Query parameters

workspaceIdstringRequired

Workspace that owns the table.

minLength
1

Responses

200

The run state, output cells, and provider cascade for the group on the row.

object

Run state, output cells, and provider cascade for one group on one row.

1 field
dataobjectRequired

Response data.

4 fields
groupIdstringRequired

Workflow or enrichment group this answers for.

runStatevalueRequired

Most recent run of this group on this row — the same shape includeRunState reports — or null when the group has never run for the row.

Schema details

Any of

Option 1object

Run outcome for one workflow group on one row.

7 fields
statusstringRequired

Lifecycle state of the most recent run for this cell: pending, queued, running, completed, error, or canceled.

executionIdvalueRequired

Workflow execution identifier, or null before a worker claimed the cell.

Schema details

Any of

Option 1string
Option 2null
workflowIdstringRequired

Workflow the group runs for this cell.

errorvalueRequired

Failure reason, or null when the run did not fail.

Schema details

Any of

Option 1string
Option 2null
runningBlockIdsarrayRequired

Block identifiers currently mid-execution.

Schema details
Array itemstring
blockErrorsobjectRequired

Per-block failure messages keyed by block identifier.

Schema details
Additional propertiesstring
canceledAtvalueRequired

ISO 8601 timestamp when the cell was canceled, or null.

Schema details

Any of

Option 1string
format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Option 2null

Additional properties are not allowed.

Option 2null
outputsobjectRequired

The group's output cells keyed by column name. A column the run has not populated is null.

Schema details
Additional propertiesvalue

User-defined cell value interpreted by its column definition.

cascadevalueRequired

Provider cascade behind the cell, or null when none was recorded — a manual workflow group, a group that has not run, or a run predating the breakdown.

Schema details

Any of

Option 1object

Provider cascade, cost, and timing for one enrichment cell.

7 fields
startedAtvalueRequired

ISO 8601 timestamp when the cascade started, or null when not recorded.

Schema details

Any of

Option 1string
format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Option 2null
completedAtvalueRequired

ISO 8601 timestamp when the cascade finished, or null when not recorded.

Schema details

Any of

Option 1string
format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Option 2null
durationMsnumberRequired

Wall-clock milliseconds across the whole cascade; zero when not recorded.

totalCostnumberRequired

Sum of per-provider hosted-key cost in USD; zero when not recorded.

matchedProvidervalueRequired

Provider that produced the match, or null when none did.

Schema details

Any of

Option 1string
Option 2null
abortedbooleanRequired

True when the run was canceled before it settled.

providersarrayRequired

Every configured provider, in cascade order, including those that never ran.

Schema details
Array itemobject

One provider's result within an enrichment cascade.

7 fields
idstringRequired

Provider identifier, e.g. hunter.

labelstringRequired

Human-readable provider name.

toolIdstringRequired

Sim tool identifier the provider ran.

statusstringRequired

Provider outcome: matched, no_match, skipped, error, or not_run. Handle unrecognized values, since additional statuses may be returned.

costnumberRequired

Hosted-key cost in USD this provider incurred; zero when Sim did not bill it.

durationMsnumberRequired

Wall-clock milliseconds this provider took; zero if skipped.

errorvalueRequired

Failure reason when status is error, else null.

Schema details

Any of

Option 1string
Option 2null

Additional properties are not allowed.

Additional properties are not allowed.

Option 2null

Additional properties are not allowed.

Additional properties are not allowed.

Response headers

X-RateLimit-Limitinteger

Maximum requests allowed in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Remaininginteger

Requests remaining in the current window.

minimum
0
maximum
9007199254740991
X-RateLimit-Resetstring

ISO 8601 timestamp when the current rate-limit window resets.

format
date-time
pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Was this helpful?
Suggest an edit