bidHealth

Requires permission biddesk:bid:read.

The health of up to 100 bids the caller may see, computed now: state, reasons, escalation and who the bid is waiting on. Unknown or invisible bids are left out. Requires Bid Desk and permission to read bids.

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 BidHealth($bidIds: [ID!]!) {
  bidHealth(bidIds: $bidIds) {
    bidId
    escalatedToMe
    escalationLevel
    escalationSubjectId
    escalationSubjectKind
    state
    reasons {
      code
      count
      level
      minutes
      severity
      subjectId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidHealth($bidIds: [ID!]!) {\n  bidHealth(bidIds: $bidIds) {\n    bidId\n    escalatedToMe\n    escalationLevel\n    escalationSubjectId\n    escalationSubjectKind\n    state\n    reasons {\n      code\n      count\n      level\n      minutes\n      severity\n      subjectId\n    }\n  }\n}",
  "variables": {
    "bidIds": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "bidIds": [
    "id"
  ]
}

Response:

{
  "data": {
    "bidHealth": [
      {
        "bidId": "id",
        "escalatedToMe": true,
        "escalationLevel": 0,
        "escalationSubjectId": "id",
        "escalationSubjectKind": "APPROVAL_STAGE",
        "state": "AT_RISK",
        "reasons": [
          {
            "code": "BID_OVERDUE",
            "count": 0,
            "level": 0,
            "minutes": 0,
            "severity": "AT_RISK",
            "subjectId": "id"
          }
        ]
      }
    ]
  }
}

bidHealth(
  bidIds: [ID!]!
): [BidHealth!]!

Arguments

bidHealth.bidIds ● [ID!]! non-null scalar

The bids to judge, at most 100.

Type

BidHealth object

A bid's health, computed from the live data when asked. The same for everyone who may see the bid, except escalatedToMe.