Retry backlog for the workspace, broken down by campaign

GET /campaigns/retry-queue

Retry backlog for the workspace, broken down by campaign

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/retry-queue \
  --header 'Authorization: Bearer <token>'

200

{
  "totals": {
    "queued": 123,
    "parked": 123
  },
  "campaigns": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "DRAFT",
      "queued": 123,
      "parked": 123,
      "oldestDueAt": "<string>",
      "anyDueNow": true
    }
  ],
  "facets": {
    "byReason": {
      "RETRY_NO_ANSWER": {
        "queued": 123,
        "parked": 123
      },
      "RETRY_DROPPED": {
        "queued": 123,
        "parked": 123
      },
      "PROVIDER_ERROR": {
        "queued": 123,
        "parked": 123
      },
      "RECONCILED_STRANDED": {
        "queued": 123,
        "parked": 123
      },
      "NEXT_NUMBER": {
        "queued": 123,
        "parked": 123
      },
      "UNKNOWN": {
        "queued": 123,
        "parked": 123
      }
    },
    "byAttempt": [
      {
        "attempt": 123,
        "queued": 123,
        "parked": 123
      }
    ]
  }
}

Required scope: campaigns.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Query Parameters

campaignIds · string string[]

reasons · string string[]

attemptCountMin · integer | null

Required range: x >= 0

attemptCountMax · integer | null

Required range: x >= 0

Response

200

application/json

OK

totals · object · required

Show child attributes

campaigns · object[] · required

Show child attributes

facets · object · required

Show child attributes