The Health Endpoint gives you real-time visibility into the status of Modash API services. Use it to monitor availability, detect issues early, and keep your integration running smoothly.
How it works
Modash evaluates the most recent 50 requests made within the past 5 minutes for each monitored endpoint group:
email-search
search
reports
reports-audience-overlap
performance-data
Discovery endpoints starting with Instagram, TikTok, or YouTube
A request is marked as failed if:
It returns an HTTP status code of 500 or higher.
It takes longer than 20 seconds to complete.
Status definitions
Each monitored service reports one of three statuses:
Healthy - Less than 20% of requests failed, or no requests in the past 5 minutes.
Degraded - Between 20% and 40% of requests failed.
Unhealthy - More than 40% of requests failed.
The overall health status reflects the worst-performing endpoint. If one service is degraded and the rest are healthy, the overall status shows as degraded.
Things to keep in mind
RAW API endpoints are excluded from health calculations.
The overall status reflects the worst-performing endpoint group.
For detailed per-endpoint statistics, refer to your service logs.
š” If the health endpoint shows degraded or unhealthy status and you're seeing 500 errors, don't worry - failed requests are not billed. See API error handling for retry best practices.
For detailed public documentation on the Health Endpoint, visit docs.modash.io.
FAQs
FAQs
Does the health endpoint cost credits?
No. The
/healthendpoint is free to call and is not rate limited.How often should I poll the health endpoint?
You can safely poll every few minutes for internal status dashboards without impacting your quota.
Why might the overall status show degraded when my requests are succeeding?
The overall status reflects the worst-performing endpoint group. Another endpoint group may be experiencing issues even if the ones you use are healthy.
Are RAW API issues reflected in the health endpoint?
No. RAW API endpoints are excluded from health calculations. The health endpoint only monitors Discovery API services.