Get dashboard metric counts

posthttps://api.expiryedge.com/v1/getExpiryMetrics

any role500/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/getExpiryMetrics' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "selectedTeam": "0",
  "futureDurationDays": 90
}'

Antwort

{
  "total": 142,
  "completed": 38,
  "expired": 4,
  "archived": 11,
  "active": 138,
  "future": 27,
  "upcomingThisMonth": 9,
  "today": 1,
  "notNotifying": 3
}

Counts the organization's expiries per dashboard card. Computed over all records (no pagination).

Body-Parameter

application/json

selectedTeamstring
Team id; '0' or omitted = all teams.
futureDurationDaysinteger or string
Window in days for the future count, or all.

Rückgabe

200

Metric counts.

totalinteger
Not done and not archived.
completedinteger
expiredinteger
Past expiry date, not done or archived.
archivedinteger
activeinteger
Expiry date today or later, not done or archived.
futureinteger
Expiry date after now and within futureDurationDays (all future when omitted).
upcomingThisMonthinteger
todayinteger
notNotifyinginteger
Active records with no queued reminder or no live contact.

Fehler

`400`	The request is missing required fields or contains invalid values.
`401`	Missing, expired or invalid bearer token.
`404`	The record does not exist or is not in your organization.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.