How many events the caller holds this quota period
Returns the number of the caller's stored event rows that count toward their quota period (the current calendar month for a regular user, all time for an admin), plus the caller's event limit. The event limit applies to each view separately at its full value, so pass view to get the tally the matching events list is actually capped by; omit it for the total across every view you can open, which for an account with more than one view is a number no single list is capped by. Counting is O(rows) on the caller's whole partition, so the value is cached per (user, view) and refreshed in the background: a repeat call is served instantly from cache and may be up to a few minutes stale. The dashboard events page calls this separately from the events query so a slow count never delays the page, and refetches it on a tab switch.
This is a read: a read-only API key may call it.
Request
- Base URL: https://eyalsec.com
- URL: https://eyalsec.com/api/event_count/
- Auth: one of:
- API key in header X-API-Key
- API key in cookie __Host-es2session
Query parameters
Count only one agent kind: python, browser, go, c, cpp, rust, node, solidity, java, bash, ruby or php. Omit for every view you can open; if that is exactly one, the unscoped tally is that view's. Naming a view your account does not hold is a 403, and an unrecognised value is a 400, never a silent whole-account count. The response echoes the view it counted.
Response
OK.
Changes
No recorded changes to this operation across all 1 revision of this API.