Skip to main content
GET
curl
See Reading events back in the event ingestion guide. To search across subjects, use List monitoring events.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

vendor_data
string
required

Your id for the subject (subject.vendor_data of its events). URL-encode it; a value containing / cannot be addressed by this endpoint.

Required string length: 1 - 255

Query Parameters

entity_type
enum<string>
default:individual

company returns the company with this vendor_data; any other value, or none, returns the individual. subject_entity_type is accepted as an alias when entity_type is absent.

Available options:
individual,
company
limit
integer
default:50

Maximum number of events per page. Defaults to 50. Values above 1000000 return 400; a non-numeric, zero or negative value falls back to 50.

Required range: 1 <= x <= 1000000
offset
integer
default:0

Number of events to skip. Defaults to 0. Prefer following the next URL from the response.

Required range: 0 <= x <= 1000000
event_category
enum<string>[]

Only events in these categories. Repeat the parameter for several values (?event_category=payment&event_category=dispute); an event matching any of them is returned.

Available options:
auth,
session,
gameplay,
bonus,
affiliate,
payment,
dispute,
security,
responsible_gambling,
custom
action_type
string[]

Only events with these action types (exact, case-sensitive). Repeat for several values.

status
enum<string>[]

Only events with these statuses. Repeat for several values.

Available options:
ACCEPTED,
APPROVED,
IN_REVIEW,
DECLINED
retention_class
enum<string>[]

Only events in these retention classes. Repeat for several values.

Available options:
low_value,
standard,
risk_relevant,
monetary_or_compliance
business_vendor_data
string

Exact match on the business.vendor_data sent with the event.

session_id
string

Exact match on session.session_id.

device_fingerprint
string

Exact match on device_context.fingerprint.

ip_address
string

Exact match on the event's IP address.

game_id
string

Exact match on the promoted game_id.

round_id
string

Exact match on the promoted round_id.

affiliate_code
string

Exact match on the promoted affiliate_code.

payment_reference_id
string

Exact match on the payment reference (from transaction_context.payment_reference_id or payload.payment_reference_id).

counterparty_vendor_data
string

Exact match on the promoted counterparty_vendor_data.

matched_only
boolean
default:false

true (also 1 or yes, case-insensitive) returns only events at least one rule matched (rules_matched_count above 0). Any other value is ignored.

occurred_from
string<date-time>

Only events with occurred_at at or after this instant (inclusive). Send an ISO 8601 value: 2026-10-01T00:00:00Z, an explicit offset with the + percent-encoded (2026-10-01T02:00:00%2B02:00; an unencoded + is decoded as a space and the value no longer parses), or a date alone (2026-10-01), which means 00:00:00 UTC of that day. A value without an offset is read as UTC. Values in any other format are not accepted.

occurred_to
string<date-time>

Only events with occurred_at at or before this instant (inclusive). A date alone means the start of that day, so occurred_to=2026-10-15 excludes the rest of 15 October; send 2026-10-15T23:59:59Z to include it. Send an ISO 8601 value: 2026-10-01T00:00:00Z, an explicit offset with the + percent-encoded (2026-10-01T02:00:00%2B02:00; an unencoded + is decoded as a space and the value no longer parses), or a date alone (2026-10-01), which means 00:00:00 UTC of that day. A value without an offset is read as UTC. Values in any other format are not accepted.

Case-insensitive substring match on event_id, action_type, subject_vendor_data or counterparty_vendor_data.

Response

One page of the subject's events.

One page of monitoring events, newest occurred_at first.

count
integer
required

Number of matching events, exact up to 100 and capped at 100 above that. Do not compute page counts from it; follow next until it is null.

next
string<uri> | null
required

URL of the next page, or null on the last page.

previous
string<uri> | null
required

URL of the previous page, or null on the first page.

results
object[]
required