recordBidInsightEvents

Requires permission biddesk:bid:read.

Records that the caller saw, opened, acted on or dismissed insight cards on a bid (1 to 50 events). Ids and codes only; a card already shown today is not written again. 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

mutation RecordBidInsightEvents($bidId: ID!, $events: [BidInsightEventInput!]!) {
  recordBidInsightEvents(bidId: $bidId, events: $events) {
    deduplicated
    recorded
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RecordBidInsightEvents($bidId: ID!, $events: [BidInsightEventInput!]!) {\n  recordBidInsightEvents(bidId: $bidId, events: $events) {\n    deduplicated\n    recorded\n  }\n}",
  "variables": {
    "bidId": "id",
    "events": [
      {
        "action": "ACTED",
        "cardKey": "string",
        "insightType": "COST_OUTLIER"
      }
    ]
  }
}
EOF

Variables:

{
  "bidId": "id",
  "events": [
    {
      "action": "ACTED",
      "cardKey": "string",
      "insightType": "COST_OUTLIER"
    }
  ]
}

Response:

{
  "data": {
    "recordBidInsightEvents": {
      "deduplicated": 0,
      "recorded": 0
    }
  }
}

recordBidInsightEvents(
  bidId: ID!
  events: [BidInsightEventInput!]!
): BidInsightEventsResult!

Arguments

recordBidInsightEvents.bidId ● ID! non-null scalar

The bid.

recordBidInsightEvents.events ● [BidInsightEventInput!]! non-null input

What the person did, 1 to 50 events.

Type

BidInsightEventsResult object

How many insight events were written.