bidScore

Requires permission biddesk:bid:read.

The advisory bid/no-bid score of a bid the caller may see: six factors drawn from history, each with its value, weight and the counts behind it. It is advice; the decision stays with people and the bid.go approval rule. 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 BidScore($bidId: ID!) {
  bidScore(bidId: $bidId) {
    asOf
    band
    bidId
    score
    scoreHash
    version
    explanation {
      code
      status
      createdAt
      model
      runId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidScore($bidId: ID!) {\n  bidScore(bidId: $bidId) {\n    asOf\n    band\n    bidId\n    score\n    scoreHash\n    version\n    explanation {\n      code\n      status\n      createdAt\n      model\n      runId\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidScore": {
      "asOf": "2025-01-15T00:00:00Z",
      "band": "FAVOURABLE",
      "bidId": "id",
      "score": 0,
      "scoreHash": "string",
      "version": 0,
      "explanation": {
        "code": "string",
        "status": "READY",
        "createdAt": "2025-01-15T00:00:00Z",
        "model": "string",
        "runId": "id"
      }
    }
  }
}

bidScore(
  bidId: ID!
): BidScore!

Arguments

bidScore.bidId ● ID! non-null scalar

The bid.

Type

BidScore object

A bid's advisory bid/no-bid score from history. The same data on the same day gives the same score. The decision stays with people.