Skip to main content
Version: Next

SupportHistoryBan

activation objectrequired
atstring<date-time>required
bucket_idstring | nullnullablerequired
window_indexinteger | nullnullablerequired
window_currentinteger | nullnullablerequired
window_previousinteger | nullnullablerequired
totalnumber | nullnullablerequired
effective_limitnumber | nullnullablerequired
planned_end(string | null)<date-time>nullablerequired
kindstringrequired

Possible values: [ban_activated, ban_activation_unconfirmed]

rulestringrequired
stored_rulestringrequired
rule_fingerprintstringrequired
instancestringrequired
activating_requeststringrequired
Constant value: NOT_A_CULPRIT
period_secondsintegerrequired
ban_time_secondsintegerrequired
failed_requestsintegerrequired
end objectrequired

How a ban instance ended as far as recorded. Only released is a recorded end; planned ends are relative to the window end, which is queried_at for ban contexts.

at(string | null)<date-time>nullablerequired
release_sourcestring | nullnullablerequired
reasonstringrequired

Possible values: [released, superseded_by_new_activation, planned_end_passed_unconfirmed, planned_end_after_window, unknown]

contributions objectrequired
crossing_candidate objectrequired
oneOf
atstring<date-time>required
window_currentinteger | nullnullablerequired
event_idstringrequired
basisstringrequired
Constant value: heuristic_crossed_flag
distinct_claimed_namesinteger | nullnullablerequired
windows object[]required
  • Array [
  • expectedinteger | nullnullablerequired
    presentinteger | nullnullablerequired
    windowstringrequired

    Possible values: [activation_window, previous_window]

    statusstringrequired

    Possible values: [complete, loss_detected, aggregate_only, expired, not_applicable]

    evidencestringrequired

    Possible values: [raw, summary, not_read, not_assessed]

    window_indexintegerrequired
    counts_are_upper_boundsbooleanrequired
    summary_check_unreliablebooleanrequired
  • ]
  • items object[]required
  • Array [
  • atstring<date-time>required
    window_indexinteger | nullnullablerequired
    window_currentinteger | nullnullablerequired
    crossedboolean | nullnullablerequired
    account_knownboolean | nullnullablerequired
    claimed_usernamestring | nullnullablerequired
    accountstring | nullnullablerequired
    client_ipstring | nullnullablerequired
    subject_matchboolean | nullnullablerequired
    event_idstringrequired
    request_idstringrequired
    count_sourcestringrequired
    protocolstringrequired
    redactedbooleanrequired
  • ]
  • caveatsstring[]required
    statusstringrequired

    Possible values: [complete, loss_detected, aggregate_only, expired, not_applicable]

    truncatedbooleanrequired
    hits objectrequired
    by_source objectrequired
    property name*integer
    distinct_claimed_namesinteger | nullnullablerequired
    subject_hitsinteger | nullnullablerequired
    claimants object[]required
  • Array [
  • claimed_usernamestring | nullnullablerequired
    accountstring | nullnullablerequired
    hitsintegerrequired
  • ]
  • evidencestringrequired

    Possible values: [raw, summary, not_read, not_assessed]

    countintegerrequired
    count_is_upper_boundbooleanrequired
    interval_approximatebooleanrequired
    unknownsstring[]required
    ban_refstringrequired
    networkstringrequired
    SupportHistoryBan
    {
    "activation": {
    "at": "2024-07-29T15:51:28.071Z",
    "bucket_id": "string",
    "window_index": 0,
    "window_current": 0,
    "window_previous": 0,
    "total": 0,
    "effective_limit": 0,
    "planned_end": "2024-07-29T15:51:28.071Z",
    "kind": "ban_activated",
    "rule": "string",
    "stored_rule": "string",
    "rule_fingerprint": "string",
    "instance": "string",
    "activating_request": "NOT_A_CULPRIT",
    "period_seconds": 0,
    "ban_time_seconds": 0,
    "failed_requests": 0
    },
    "end": {
    "at": "2024-07-29T15:51:28.071Z",
    "release_source": "string",
    "reason": "released"
    },
    "contributions": {
    "crossing_candidate": {
    "at": "2024-07-29T15:51:28.071Z",
    "window_current": 0,
    "event_id": "string",
    "basis": "heuristic_crossed_flag"
    },
    "distinct_claimed_names": 0,
    "windows": [
    {
    "expected": 0,
    "present": 0,
    "window": "activation_window",
    "status": "complete",
    "evidence": "raw",
    "window_index": 0,
    "counts_are_upper_bounds": true,
    "summary_check_unreliable": true
    }
    ],
    "items": [
    {
    "at": "2024-07-29T15:51:28.071Z",
    "window_index": 0,
    "window_current": 0,
    "crossed": true,
    "account_known": true,
    "claimed_username": "string",
    "account": "string",
    "client_ip": "string",
    "subject_match": true,
    "event_id": "string",
    "request_id": "string",
    "count_source": "string",
    "protocol": "string",
    "redacted": true
    }
    ],
    "caveats": [
    "string"
    ],
    "status": "complete",
    "truncated": true
    },
    "hits": {
    "by_source": {},
    "distinct_claimed_names": 0,
    "subject_hits": 0,
    "claimants": [
    {
    "claimed_username": "string",
    "account": "string",
    "hits": 0
    }
    ],
    "evidence": "raw",
    "count": 0,
    "count_is_upper_bound": true,
    "interval_approximate": true
    },
    "unknowns": [
    "string"
    ],
    "ban_ref": "string",
    "network": "string"
    }