/cms_medicare/datasets

POST /api/cms_medicare/datasets

Price: 1 credit

Get a CMS Medicare provider dataset by its slug

How to use it

Get a single CMS Medicare Provider Data Catalog dataset by its slug. Returns title, description, access level, landing page, issued/modified/released dates, keywords, themes, publisher, contact point, and the downloadable distributions (files with their distribution id, format and URL). The distribution id is what identifies the underlying provider rows.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dataset slug (examples: "dgck-syfz", "4pq5-n9py"; minLength: 1)

Response

• @type string (default: "CmsMedicareDataset")
• alias string required
• description string nullable
• access_level string nullable
• landing_page string nullable
• issued string nullable
• modified string nullable
• released string nullable
• bureau_code array (default: [])
• program_code array (default: [])
• keywords array (default: [])
• themes array (default: [])
• publisher string nullable
• contact_point object nullable
  • @type string (default: "CmsMedicareContactPoint")
  • name string nullable
  • email string nullable
  • url string nullable
• distributions array (default: [])
  • @type string (default: "CmsMedicareDistribution")
  • id string nullable
  • description string nullable
  • media_type string nullable
  • download_url string nullable
  • described_by string nullable
  • described_by_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Dataset not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.