POST/v3/live/healthcare/hcp/{aggkHcpId}/drugs-investigated
Get HCP drugs investigated
Returns every drug studied in clinical trials a healthcare professional is linked to, by MeSH descriptor. Filter by trial start year range, MeSH descriptor, registry-record links only and minimum volume; results are ordered by trials summed over the requested years, largest first. Paginated with limit (default 100, max 1000) and an opaque cursor. Consumes 1 credit, billed once per distinct HCP per billing period.
Path parameters
- aggkHcpIdstringRequiredAggK HCP ID
Request body
- meshIdsstring[]OptionalOnly these MeSH descriptor IDs
- includeNonDrugInterventionsbooleanOptionalAlso return trial interventions that are not drugs, such as procedures and behavioural arms (default false)
- onRecordOnlybooleanOptionalCount only trials where the HCP is named on the registry record, excluding links through a publication or payment (default true, matching focusAreas and topIndications). Ordering and minTrialCount use trialCountOnRecord when true and trialCount when false
- minTrialCountinteger (int64)OptionalOnly drugs with at least this many trials over the requested years
- limitinteger (int32)OptionalMaximum number of concepts to return (default 100, max 1000)
- cursorstringOptionalOpaque cursor returned by a previous page; omit to fetch the first page. Valid only with the same filters that produced it
- yearsobjectOptionalYears to include, inclusive at both ends. Totals, ordering and minimum filters are computed over this range; omit for all years
- maxinteger (int32)OptionalMaximum value (inclusive)
- mininteger (int32)OptionalMinimum value (inclusive)
- metadataobjectOptionalOptional metadata to associate with the request. Will be returned in the response.
- Headers
x-api-keyRequired · API key for authentication
Response
- nextCursorstringCursor for the next page; absent when there are no more results
- resultsobject[]Drugs studied in trials the HCP is linked to, one entry per MeSH descriptor
- isSuccessboolean
truewhen the request was answered with a result.falsemeans no result was returned: checkisRetryable, which istruewhen a data source failed or timed out andfalsewhen the input matched nothing. - isRetryablebooleanWhen
isSuccessisfalse, whether sending the same input again could succeed. AlwaystruewhenisSuccessistrue. - hasProblemsbooleanWhether 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. - metadataobjectCaller-supplied metadata echoed back from the request.
- inputParametersobjectCaller-supplied inputs echoed back in the response