Get an admin job result.

GET

/api/admin/jobs/{id}/result

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/jobs/example/result \
  --header 'Authorization: Bearer <token>'

Returns the result for a completed or partially failed job. Pending, processing, failed without result, or otherwise incomplete jobs return result_not_available.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Completed job result response.

Media type application/json

object

job_id

required

string

summary

required

One of:

object

object

total

integer

succeeded

integer

failed

integer

skipped

integer

key

additional properties

null

null

failures

required

Array<object>

object

row

integer

>= 1

error_code

required

string

field

string

message

string

key

additional properties

logs

required

Array<object>

object

timestamp

required

string

level

required

string

Allowed values: info warn error

code

required

string

message

required

string

row

integer

email

string

key

additional properties

artifact_id

string

available_formats

Array<string>

Allowed values: json csv

manifest_url

string

download_url

string

key

additional properties

Example

{
  "logs": [
    {
      "level": "info"
    }
  ],
  "available_formats": [
    "json"
  ]
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}