APG PayAPG Paydocs

Operations

Get queue

GET/queues/{queueId}
Request
GEThttps://api.tst.au.apgpay.dev/queues/{queueId}
curl -X GET https://api.tst.au.apgpay.dev/queues/{queueId} \
  -H "Authorization: Bearer $API_KEY"

Return one queue by name, with what each consumer group on it is doing.

Permissions

Required permission
queues:query

Requires the `query` action on `queues` for the supplied runtime context

Path parameters

queueIdstring
required

Responses

The response is a tagged shape: type is always "QueueAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "QueueAttributes"
queuestringrequired

The queue's name, which is also its id.

tickerLagSecondsinteger (int64)required

Seconds since the queue last ticked. Ticking is driven by the consumers' own polling, so a large value means nobody is draining rather than that nothing is being published.

Example 1250

eventsPerSecondnumber (double)required

Events published per second, as the queue measures it.

Example 12.5

Every consumer group with a cursor on this queue. Empty means nothing is reading it.

Example
{
  "type": "QueueAttributes",
  "queue": "string",
  "tickerLagSeconds": 1250,
  "eventsPerSecond": 12.5,
  "consumers": [
    {
      "type": "QueueConsumerAttributes",
      "consumer": "string",
      "backlog": 1250,
      "lagSeconds": 1250,
      "members": 1250,
      "silentMembers": 1250
    }
  ]
}

Error responses