Skip to main content
POST
workflow.batch.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
batchId
string
required

Record identifier in your connected account.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
version
enum<string>
default:legacy

Batch inspection protocol; current includes processing errors.

Available options:
legacy,
current

Response

The result

batchId
string
required

Record identifier in your connected account.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
state
enum<string>
required

Batch submission state, not run completion.

Available options:
pending,
processing,
completed,
partial_failed,
aborted
expectedRows
integer
required

Number of items.

Required range: 0 <= x <= 9007199254740991
acceptedRows
integer
required

Number of items.

Required range: 0 <= x <= 9007199254740991
results
object[]
required

First 100 accepted executions; see truncated for larger batches.

Maximum array length: 100
truncated
boolean
required

Some accepted execution identifiers were omitted from this selection.

failedRows
integer

Number of items.

Required range: 0 <= x <= 9007199254740991
updatedAt
string<date-time>

Time in ISO 8601 format.

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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$