Skip to main content
GET
/
api
/
analytics
/
decline
Get decline analytics for a user
curl --request GET \
  --url https://app.herondata.io/api/analytics/decline \
  --header 'x-api-key: <api-key>'
{
  "check_analytics": [
    {
      "check_name": "<string>",
      "total_failed": 123,
      "total_missing_data": 123,
      "total_passed": 123
    }
  ],
  "total_declined": 123,
  "total_end_users": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
start_date
string<date-time>
required

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

​
end_date
string<date-time>
required

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

Response

Decline analytics retrieved successfully

​
check_analytics
object[]
​
total_declined
integer

Number of end users with at least one failed check

​
total_end_users
integer

Total number of end users with policy evaluations