HEherondata
Analytics

Get decline analytics for a user

Returns aggregated decline analytics for end users within a date range, including total end users, total declined, and per-check pass/fail/missing counts. Only the latest policy evaluation per end user is considered.

get/api/analytics/decline

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/analytics/decline
  • Auth
    API key in header x-api-key

Query parameters

start_datestring date-time required

Start of the date range (filters by end_user created date)

end_datestring date-time required

End of the date range (filters by end_user created date)

Response

Decline analytics retrieved successfully

total_declinedinteger

Number of end users with at least one failed check

total_end_usersinteger

Total number of end users with policy evaluations

Changes

No recorded changes to this operation across all 5 revisions of this API.