Skip to content
getgeolens.com
GeoLens Docs

List Admin Jobs

GET
/admin/jobs/
 
curl --request GET \
  --url 'https://example.com/admin/jobs/?skip=0&limit=50&sort=created_at&order=asc' \
  --header 'Authorization: Bearer <token>'

List all ingestion jobs with optional status/user/search/sort filters (admin only).

sort and order are closed enums, so an unrecognised value is refused with a 422 and never reaches the query.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
Any of:
string
user_id
Any of:
string format: uuid
search
Any of:
string
skip
Skip
integer
0
limit
Limit
integer
default: 50 >= 1 <= 200
sort
Sort

Column to order by. Duration orders by the completed_at - started_at interval, so unfinished jobs sort last either way.

string
default: created_at
Allowed values: created_at source_filename status username duration

Column to order by. Duration orders by the completed_at - started_at interval, so unfinished jobs sort last either way.

order
Order

Sort direction.

string
default: desc
Allowed values: asc desc

Sort direction.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AdminJobListResponse
object
jobs
required
Jobs

Page of ingestion jobs.

Array<object>
AdminJobResponse
object
id
required
Id

Unique ingestion job identifier.

string format: uuid
status
required
Status

Current job status: ‘pending’, ‘running’, ‘complete’, ‘failed’, or ‘cancelled’.

string
Allowed values: pending running complete failed cancelled fanned_out
source_filename
required
Any of:
string
dataset_id
required
Any of:
string format: uuid
error_message
required
Any of:
string
can_retry
required
Can Retry

Whether the failed job can be retried with its retained source.

boolean
retry_reason
required
Any of:
string
user_metadata
required
Any of:
object
key
additional properties
any
created_by
required
Any of:
string format: uuid
username
required
Any of:
string
started_at
required
Any of:
string format: date-time
completed_at
required
Any of:
string format: date-time
created_at
required
Created At

Timestamp when the job was queued.

string format: date-time
total
required
Total

Total number of jobs matching the query.

integer
Example 
{
  "jobs": [
    {
      "status": "pending"
    }
  ]
}

400

Section titled “400 ”

Bad request — invalid query parameters or payload

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Section titled “403 ”

Forbidden — caller lacks access to this resource

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “404 ”

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}
Privacy Apache 2.0 getgeolens.com