Retrieve a summary of publishing jobs

Request

Retrieves statistics about publishing jobs, including how many jobs are queued, how many are running or have failed or been canceled, and how many have been completed.

Note

To retrieve job statistics, your token must include one of the following scopes xmcpub.jobs.a:r, xmcpub.jobs.t:r, or xmcpub.jobs.t:rl.

Security

Bearer

Query

system.queuedTimeArray of strings

Queued time to use to filter entries. Use & to include more than one filter (for example, ?system.queuedTime=>2024-10-14T00:00:00.000Z&system.queuedTime=<2024-12-31T00:00:00.000Z). Only =>DATE and =<DATE filters are supported.

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/publishing/v1/jobs/summary?system.queuedTime=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

Bodyapplication/json

countsobject(StatisticsCounts)required

The job count for every status.

Response

{
  "counts": {
    "queued": 0,
    "running": 0,
    "canceled": 0,
    "failed": 0,
    "completed": 0,
    "canceling": 0
  }
}