List Jobs

curl --request GET \
  --url https://mango.sievedata.com/v2/jobs \
  --header 'X-API-Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "function_id": "<string>",
      "organization_id": "<string>",
      "function": {
        "name": "<string>",
        "owner_name": "<string>"
      },
      "status": "<string>",
      "created_at": "2024-12-15T01:41:59.195000",
      "started_at": "2024-12-15T01:41:59.195000",
      "completed_at": "2024-12-15T01:41:59.195000",
      "error": "<string>",
      "visibility": "<string>",
      "run_id": "<string>",
      "inputs": {},
      "outputs": [],
      "children": {},
      "restarts": []
    }
  ],
  "next_offset": -1
}

GET

jobs

List Jobs

curl --request GET \
  --url https://mango.sievedata.com/v2/jobs \
  --header 'X-API-Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "function_id": "<string>",
      "organization_id": "<string>",
      "function": {
        "name": "<string>",
        "owner_name": "<string>"
      },
      "status": "<string>",
      "created_at": "2024-12-15T01:41:59.195000",
      "started_at": "2024-12-15T01:41:59.195000",
      "completed_at": "2024-12-15T01:41:59.195000",
      "error": "<string>",
      "visibility": "<string>",
      "run_id": "<string>",
      "inputs": {},
      "outputs": [],
      "children": {},
      "restarts": []
    }
  ],
  "next_offset": -1
}

Authorizations

X-API-Key

string

header

required

The Sieve API key to authenticate with.

Query Parameters

limit

integer

default:500

The maximum amount of jobs to show.

offset

integer

default:0

Exclude the first N jobs.

status

string

default:""

The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled', . Leave empty to get all statuses.

Response

Successful Response

data

Job · object[]

required

Show child attributes

data.id

string

required

The id of the job.

data.function_id

string

required

The id of the function that the job belongs to. This can be the first 7 characters of the full id.

data.organization_id

string

required

The ID of the organization that submitted the function.

data.function

CompactFunctionApp · object

required

The name of the function that the job belongs to.

Show child attributes

data.function.name

string

required

The name of the function.

data.function.owner_name

string

required

The owner name of the function

data.status

string

required

The status of the job. Possible values: 'queued', 'processing', 'error', 'finished', 'cancelled'

data.created_at

string<date-time> | null

required

The UTC time the job was created.

Example:

"2024-12-15T01:41:59.195000"

data.started_at

string<date-time> | null

required

The UTC time the job started processing by the function.

Example:

"2024-12-15T01:41:59.195000"

data.completed_at

string<date-time> | null

required

The UTC time the job was completed.

Example:

"2024-12-15T01:41:59.195000"

data.error

string | null

required

The error that the job ran into. Empty string if there's no error.

data.visibility

string

required

"public" or "private".

data.run_id

string | null

required

The run_id of the job.

data.inputs

Inputs · object

Show child attributes

data.outputs

(InputOutput · object | InputOutput · object[])[]

Show child attributes

InputOutput · object
InputOutput · object[]

Show child attributes

data.outputs.type

string | null

The type of the output, see all possible values here

data.outputs.name

string | null

The name of the output

data.outputs.data

any

The data of the output. Empty if the response is not from a job

data.outputs.description

string | null

The description of the output

data.outputs.schema

Schema · object

data.outputs.run_id

string | null

The run id associated with this output

data.outputs.is_optional

boolean | null

default:false

Whether this input is optional or required

data.children

Children · object

Child attributes

Show child attributes

data.children.{key}

any[]

data.restarts

Restart · object[] | null

Job restart metadata

Show child attributes

data.restarts.timestamp

string<date-time>

required

The UTC time the job restarted.

data.restarts.reason

string

required

The reason the job restarted

data.restarts.type

enum<string>

required

The type of restart

Available options:

preemption,

OOM,

error

data.restarts.run_id

string | null

required

The run id that restarted

next_offset

integer

default:-1

Get Job Logs Get Function

⌘I

API Reference

CLI Reference

Custom Functions

SDK Reference

List Jobs

Authorizations

Query Parameters

Response