List enrichment jobs

GET

/jobs

List the caller's jobs, filterable by kind, status, and store. Requires the enrichment:read scope.

Authorization

headerAuthorizationBearer <API key>

API key in the Authorization header: Authorization: Bearer ace_live_.... Use an ace_test_... key for the free, rate-capped sandbox.

Query Parameters

kind?string

Value in"rules""content""pipeline""article""lookup"

status?string

storeId?string

page?integer

Range1 <= value

pageSize?integer

Range1 <= value <= 100

Response Body

A page of jobs

application/json

response

data?array<>

meta?

Example Request

curl -X GET 'https://example.com/api/v1/jobs'

Example Request

curl -X GET 'https://example.com/api/v1/jobs'

Example ResponseSchema200

{
  "data": [
    {
      "id": "string",
      "kind": "rules",
      "status": "pending",
      "progress": {
        "phase": "string",
        "completed": 0,
        "total": 0
      },
      "estimateMs": 0,
      "productCount": 0,
      "succeededCount": 0,
      "failedCount": 0,
      "storeId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "links": {
        "self": "string",
        "results": "string"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 50,
      "total": 128,
      "totalPages": 3
    }
  }
}

{  "data": [    {      "id": "string",      "kind": "rules",      "status": "pending",      "progress": {        "phase": "string",        "completed": 0,        "total": 0      },      "estimateMs": 0,      "productCount": 0,      "succeededCount": 0,      "failedCount": 0,      "storeId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "links": {        "self": "string",        "results": "string"      }    }  ],  "meta": {    "pagination": {      "page": 1,      "pageSize": 50,      "total": 128,      "totalPages": 3    }  }}

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body