API Reference
Log In
API Reference

Update the security awareness leaderboard's badge date-range filter

post
https://api.caniphish.com/api/v3/reporting/employees/update-leaderboard-settings

Sets the tenant's badge date-range filter used by the security-awareness leaderboard (consumed by getLeaderboard). Accepts a preset window (allTime, 12Months, 6Months, 3Months, 1Months) or a custom range, in which case dateRange (yyyy-MM-dd) is required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The CanIPhish tenant identifier.

string
enum
required

Preset badge date-range window, or 'custom' to use dateRange.

Allowed:
date | null

Custom date in yyyy-MM-dd format. Required when dateFilter is 'custom'.

Responses

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago