bidDebrief

Requires permission biddesk:bid:read.

The bid's debrief, or null when none is recorded yet. Requires Bid Desk. Requires 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 BidDebrief($bidId: ID!) {
  bidDebrief(bidId: $bidId) {
    id
    competitorName
    bidId
    outcome
    priceGapPct
    reason
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidDebrief($bidId: ID!) {\n  bidDebrief(bidId: $bidId) {\n    id\n    competitorName\n    bidId\n    outcome\n    priceGapPct\n    reason\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidDebrief": {
      "id": "id",
      "competitorName": "string",
      "bidId": "id",
      "outcome": "LOST",
      "priceGapPct": "string",
      "reason": "DELIVERY"
    }
  }
}

bidDebrief(
  bidId: ID!
): BidDebrief

Arguments

bidDebrief.bidId ● ID! non-null scalar

The bid.

Type

BidDebrief object

The structured debrief of a decided bid.