Batch status and per-item results
Audience: org-service-account
Per-item results are kept for 3 days; after that the items of a finished batch are omitted and counted in counts.unreported. A batch of another org or account, or an id this API did not issue, returns 404.
Request
GET https://api.mapped.com/v1/accounts/{accountId}/orgs/{orgId}/batches/{batchId}
Parameters
| Name | In | Required | Type | Constraints | Description |
|---|---|---|---|---|---|
accountId | path | yes | string | ||
orgId | path | yes | string | ||
batchId | path | yes | string |
Example
curl -X GET 'https://api.mapped.com/v1/accounts/{accountId}/orgs/{orgId}/batches/{batchId}' \
-H 'Authorization: Bearer <token>'
Responses
200
Per-item results are kept for 3 days; after that the items of a finished batch are omitted and counted in counts.unreported. A batch of another org or account, or an id this API did not issue, returns 404.
See the example above.
401
No valid bearer token: missing_token (no Authorization: Bearer header), invalid_token or token_expired.
Example error code: invalid_token
{
"code": "invalid_token",
"error": "Invalid bearer token",
"success": false
}
403
Not a credential for this org and account, or not an account-org-level service-account credential. Nothing was read or changed.
Error code: forbidden
{
"code": "forbidden",
"error": "Org does not belong to this account",
"success": false
}
404
Batch not found.
Error code: not_found
{
"code": "not_found",
"error": "Batch not found",
"success": false
}
429
Too many requests; see Retry-After.
Error code: rate_limited
{
"code": "rate_limited",
"error": "Too many requests",
"success": false
}
503
Per-item results (results_unavailable) or the batch (jobs_unavailable, batches_unavailable) cannot be read right now, or a check this API depends on is unavailable (upstream_unavailable); retry.
Example error code: results_unavailable
{
"code": "results_unavailable",
"error": "Per-item results are temporarily unavailable; try again shortly",
"success": false
}