bidHealthBoard

Requires permission biddesk:bid:read.

The bid health board: counts of on-track, at-risk and off-track bids, bids escalated to the caller, targets missed in the last seven days, and the rows, filtered by owner, team or state. 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 BidHealthBoard {
  bidHealthBoard {
    totalCount
    truncated
    counts {
      atRisk
      breachesLast7Days
      breachesPrevious7Days
      escalatedToMe
      needsAttention
      offTrack
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidHealthBoard {\n  bidHealthBoard {\n    totalCount\n    truncated\n    counts {\n      atRisk\n      breachesLast7Days\n      breachesPrevious7Days\n      escalatedToMe\n      needsAttention\n      offTrack\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidHealthBoard": {
      "totalCount": 0,
      "truncated": true,
      "counts": {
        "atRisk": 0,
        "breachesLast7Days": 0,
        "breachesPrevious7Days": 0,
        "escalatedToMe": 0,
        "needsAttention": 0,
        "offTrack": 0
      }
    }
  }
}

bidHealthBoard(
  filter: BidHealthBoardFilterInput
): BidHealthBoard!

Arguments

bidHealthBoard.filter ● BidHealthBoardFilterInput input

Which bids and which page. Default: all, first 50.

Type

BidHealthBoard object

The bid health board.