bidEvents

Requires permission biddesk:bid:read.

Lists what happened on a bid, newest first, optionally only some kinds or one person. Never shows a cost, margin, price or message text. 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 BidEvents($bidId: ID!) {
  bidEvents(bidId: $bidId) {
    nextCursor
    items {
      id
      actorName
      createdAt
      actorId
      kind
      payload
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidEvents($bidId: ID!) {\n  bidEvents(bidId: $bidId) {\n    nextCursor\n    items {\n      id\n      actorName\n      createdAt\n      actorId\n      kind\n      payload\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidEvents": {
      "nextCursor": "string",
      "items": [
        {
          "id": "id",
          "actorName": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "actorId": "id",
          "kind": "string",
          "payload": {}
        }
      ]
    }
  }
}

bidEvents(
  actorId: ID
  after: String
  bidId: ID!
  kinds: [String!]
  take: Int
): BidEventPage!

Arguments

bidEvents.actorId ● ID scalar

Only this person's actions.

bidEvents.after ● String scalar

The previous page's nextCursor.

bidEvents.bidId ● ID! non-null scalar

The bid.

bidEvents.kinds ● [String!] list scalar

Only these kinds.

bidEvents.take ● Int scalar

Page size, 1 to 100 (default 50).

Type

BidEventPage object

A page of a bid's activity stream, newest first.