List jobs

GET

/v1/scraper/jobs

const url = 'http://localhost:8080/v1/scraper/jobs?offset=0&limit=50&sort=createdAt%3Adesc%2Cid%3Aasc';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8080/v1/scraper/jobs?offset=0&limit=50&sort=createdAt%3Adesc%2Cid%3Aasc' \
  --header 'x-api-key: <x-api-key>'

Filtres simples (status, domainId). Pagination offset/limit. Sort par défaut: createdAt:desc,id:desc. Pour des filtres combinés (and/or/not, contains, gte…) utiliser POST /v1/scraper/jobs/search.

Authorizations

apiKey

Parameters

Query Parameters

offset

integer

limit

integer

default: 50 >= 1 <= 200

sort

string

Example

createdAt:desc,id:asc

Format field:dir,field:dir. Fields: createdAt, id, priority, attempts, status.

status

string

domainId

string

Responses

200

Page de jobs.

application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

items

required

Array<object>

object

required

string

url

required

string

status

required

string

Allowed values: queued claimed done failed dead

priority

required

integer

attempts

required

integer

createdAt

required

string format: date-time

finishedAt

required

string | null format: date-time

domainId

required

string

tenantId

required

string

pagination

required

object

offset

required

integer

limit

required

integer

> 0

total

required

integer

hasMore

required

boolean

sort

Array<object>

object

field

required

string

dir

required

string

Allowed values: asc desc

cache

object

hit

required

boolean

key

string

ageSeconds

integer

expiresAt

string format: date-time

timing

object

totalMs

required

integer

dbMs

integer

externalMs

integer

deprecation

object

sunset

required

string format: date-time

successor

string

note

string

Example

{
  "status": "success",
  "data": {
    "items": [
      {
        "status": "queued"
      }
    ],
    "sort": [
      {
        "dir": "asc"
      }
    ]
  }
}

400

Requête mal formée (validation_error, invalid_idempotency_key, invalid_sort_field, invalid_filter).

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

401

Authentification manquante ou invalide.

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}