Reference

Check health

GET /v1/health. Whether the API is up, with the release, the latest MyDataHub-Version, the current dataset version and how old its TPS and CTPS screen is.

Generated from the contractsView as Markdown

GET /v1/health

Whether the API is up, with the release, the latest MyDataHub-Version, the current dataset version and how old its TPS and CTPS screen is.

Property	Value
Endpoint	`GET https://mydatahub.emailmovers.com/v1/health`
Operation id	`getHealth`
Cost	Free (0 credits)
Access	No account, key or token needed.
Tag	Meta

Request

Parameters

Name	In	Type	Required	Description
`MyDataHub-Version`	header	string	no	The dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window.

Example request

curl "https://mydatahub.emailmovers.com/v1/health"

Responses

200: Health.

Headers: RateLimit, RateLimit-Policy.

Member	Type	Always present	Description
`status`	enum: `ok`, `degraded`, `down`	yes
`version`	string	yes	The API release, such as 2.0.0.
`api_version`	string	yes	The latest MyDataHub-Version, such as 2027-01-15.
`dataset_version`	string	yes	The immutable weekly build a count is bound to, such as 2026-W39. The last 52 stay queryable.
`tps_screen`	`TpsScreen`	yes	The TPS and CTPS screen of the current dataset version, on today's date.
`tps_screen.screened_at`	string (date) or null	yes	The version's TPS and CTPS screen date (quality.tps_ctps_screened_at); null when no number in it is screened.
`tps_screen.age_days`	integer (0 or more) or null	yes	Days from the screen date to today; null when no number is screened.
`tps_screen.status`	enum: `ok`, `warning`, `expired`	yes	ok up to 21 days, warning from 22 to 28 days, and expired after 28 days, when counts, samples, quotes and orders with telephone in play are refused with tps-screen-expired. ok when no number is screened.
`time`	string (date-time)	yes
`status_page`	string (uri)	yes

Example response

{
  "status": "ok",
  "version": "2.0.0",
  "api_version": "2027-01-15",
  "dataset_version": "2026-W39",
  "tps_screen": {
    "screened_at": "2026-09-25",
    "age_days": 1,
    "status": "ok"
  },
  "time": "2026-09-26T10:14:00Z",
  "status_page": "https://status.emailmovers.com"
}

Errors

Every error is a problem object with a code and a next_step. Every response carries the RateLimit and RateLimit-Policy headers; see Rate limits.

Status	Problem codes	When
400	`invalid-request`, `idempotency-key-required`, `unsupported-version`	The request could not be read, or an Idempotency-Key is missing.
429	`rate-limited`	Too many requests. Wait for Retry-After.
Any other failure	`internal-error`, `service-unavailable`, `tps-screen-expired`	Something failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old.