bidDeskOnboarding

Requires permission biddesk:settings:manage.

How ready the company is to run real bids: the profile, six readiness areas against go-live targets, the next best step, onboarding steps, persona holders and what each bid approval rule would have held. Reads counts only. Requires Bid Desk and permission to manage its settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BidDeskOnboarding {
  bidDeskOnboarding {
    goLive
    goLivePct
    readinessPct
    areas {
      status
      key
      ratioPct
      target
      unit
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDeskOnboarding {\n  bidDeskOnboarding {\n    goLive\n    goLivePct\n    readinessPct\n    areas {\n      status\n      key\n      ratioPct\n      target\n      unit\n      value\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidDeskOnboarding": {
      "goLive": true,
      "goLivePct": 0,
      "readinessPct": 0,
      "areas": [
        {
          "status": "BELOW",
          "key": "BID_HISTORY",
          "ratioPct": 0,
          "target": 0,
          "unit": "COUNT",
          "value": 0
        }
      ]
    }
  }
}

bidDeskOnboarding: BidDeskOnboarding!

Type

BidDeskOnboarding object

How ready the company is to run real bids, area by area.