POST/v3/live/healthcare/discover/hcps/count

Count discover HCPs

Returns how many HCPs match the search criteria, exactly, without returning any of them and without consuming credits. The count is not subject to the 5,000-result paging ceiling.

Version
v3
Rate limit
Tier 2 · 10–100 rps by plan
Billing
HEALTHCARE_DISCOVER · Count discover HCPs

Request body

  • metadataobjectOptional
    Optional metadata to associate with the request. Will be returned in the response.
  • orobject[]Optional
    One or more filter groups. An HCP matches the request when they satisfy at least one group; within a group every block is ANDed
    • congressesobjectOptional
      Congress sessions the HCP presented at
    • diagnosesobjectOptional
      Conditions the HCP diagnosed or referred for
    • industryobjectOptional
      Manufacturers the HCP received non-meal payments from, as reported to CMS Open Payments. A payment is a financial relationship, not evidence the HCP uses the product; use 'not' on manufacturers to screen out conflicts of interest
    • leaderboardsobjectOptional
      The HCP's decile on per-indication leaderboards
    • namestringOptional
      Name for this group. Echoed in matchedFilterGroups on every result the group produced, and in validate warnings about the group
    • practiceSettingobjectOptional
      The kind of organization the HCP currently works at. An HCP carries every setting that applies
    • prescribingobjectOptional
      Drugs the HCP prescribed or administered over the trailing twelve months
    • proceduresobjectOptional
      Procedures the HCP performed or ordered
    • professionalobjectOptional
      Who the HCP is and where they practice
    • publicationsobjectOptional
      Publications the HCP authored, by MeSH topic
    • trialsobjectOptional
      Clinical trials the HCP is linked to on the trial record
  • paginationobjectOptional
    Page-based pagination controls
Headers
x-api-key Required · API key for authentication

Response

  • countinteger (int64)
    Number of HCPs matching the search criteria. Not capped at the 5,000 results the search endpoint can page through.
  • hasProblemsboolean
    Whether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete; problems, where the response has it, says which.
  • isApproximateboolean
    Whether count is an estimate. Always false: every matching HCP is counted exactly.
  • isRetryableboolean
    When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
  • isSuccessboolean
    true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • warningsstring[]
    Non-fatal warnings about the search, such as a brand, ingredient or class that expands to more values than are searched

Status codes