similarBids

Requires permission biddesk:bid:read.

The most similar past bids to a bid, run in ARC or imported, each with a score and the reasons. A bid the caller may not see never appears. 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 SimilarBids($bidId: ID!) {
  similarBids(bidId: $bidId) {
    id
    title
    customerName
    decidedAt
    kind
    outcome
    reasons {
      kind
      matched
      total
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SimilarBids($bidId: ID!) {\n  similarBids(bidId: $bidId) {\n    id\n    title\n    customerName\n    decidedAt\n    kind\n    outcome\n    reasons {\n      kind\n      matched\n      total\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "similarBids": [
      {
        "id": "id",
        "title": "string",
        "customerName": "string",
        "decidedAt": "2025-01-15T00:00:00Z",
        "kind": "BID",
        "outcome": "LOST",
        "reasons": [
          {
            "kind": "ASSEMBLY",
            "matched": 0,
            "total": 0
          }
        ]
      }
    ]
  }
}

similarBids(
  bidId: ID!
  limit: Int
): [SimilarBid!]!

Arguments

similarBids.bidId ● ID! non-null scalar

The bid to compare.

similarBids.limit ● Int scalar

How many to return; 5 by default, at most 10.

Type

SimilarBid object

A past bid that resembles the asked-about bid, with its score and reasons. Carries no amount.