DSLD Label API

API for accessing and searching label stored in the Dietary Supplement Label Database (DSLD). When testing through SwaggerHub, please not that the API returns large result sets. In this case it is recommended to lower the size parameter to 10.
Contact Info: ODScomments@mail.nih.gov
Version: 8.1.2
BasePath:/dsld/v8/
CC0 1.0 Universal (CC0 1.0)
https://creativecommons.org/publicdomain/zero/1.0/

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
get /brand-products
paginated record browsing by keyword or letter for products matching a brand name (brandProducts)
Allows API consumer to retrieve a paginated list of label info by product name, or a paginated list based on a query term executed against product name for a given brand

Query parameters

q (required)
Query Parameter — brand name for which products are to be listed
from (optional)
Query Parameter — number of start record for pagination, default is 0 default: 0 format: int32
size (optional)
Query Parameter — number of records to return, starting at from default: 1000 format: int32

Return type

brandProductResult

Example data

Content-Type: application/json
{
  "hits" : [ {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ "sort", "sort" ],
    "_score" : 6.02745618307040320615897144307382404804229736328125
  }, {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ "sort", "sort" ],
    "_score" : 6.02745618307040320615897144307382404804229736328125
  } ],
  "total" : "{}",
  "max_score" : 0.80082819046101150206595775671303272247314453125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria brandProductResult

500

bad input parameter
Up 
get /browse-brands
paginated record browsing by keyword or letter (browseBrands)
Allows API consumer to retrieve a paginated list of brands by brand name, or a paginated list based on a query term executed against brand name

Query parameters

method (required)
Query Parameter — specifies operational mode
q (required)
Query Parameter — query term, single letter or 'Other'
from (optional)
Query Parameter — number of start record for pagination, default is 0 default: 0 format: int32
size (optional)
Query Parameter — number of records to return, starting at from default: 1000 format: int32

Return type

browseBrandResult

Example data

Content-Type: application/json
{
  "hits" : [ {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ "sort", "sort" ],
    "_score" : 6.02745618307040320615897144307382404804229736328125
  }, {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ "sort", "sort" ],
    "_score" : 6.02745618307040320615897144307382404804229736328125
  } ],
  "total" : "{}",
  "max_score" : 0.80082819046101150206595775671303272247314453125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria browseBrandResult

500

bad input parameter
Up 
get /browse-ingredientgroups
paginated record browsing by keyword or letter (browseIngredientGroups)
Allows API consumer to retrieve a paginated list of ingredient groups/categories, or a paginated list based on a query term executed against ingredient name/category

Query parameters

method (required)
Query Parameter — specifies operational mode
q (required)
Query Parameter — query term, single letter or 'Other'
from (optional)
Query Parameter — number of start record for pagination, default is 0 default: 0 format: int32
size (optional)
Query Parameter — number of records to return, starting at from default: 1000 format: int32

Return type

browseIngredientGroupsResult

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria browseIngredientGroupsResult

500

bad input parameter
Up 
get /browse-products
paginated record browsing by keyword or letter (browseProducts)
Allows API consumer to retrieve a paginated list of labels by product name, or a paginated list based on a query term executed against product name

Query parameters

method (required)
Query Parameter — specifies operational mode
q (required)
Query Parameter — query term, single letter or 'Other'
from (optional)
Query Parameter — number of start record for pagination, default is 0 default: 0 format: int32
size (optional)
Query Parameter — number of records to return, starting at from default: 1000 format: int32

Return type

browseProductResult

Example data

Content-Type: application/json
{
  "hits" : [ {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ "sort", "sort" ],
    "_score" : 6.02745618307040320615897144307382404804229736328125
  }, {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ "sort", "sort" ],
    "_score" : 6.02745618307040320615897144307382404804229736328125
  } ],
  "total" : "{}",
  "max_score" : 0.80082819046101150206595775671303272247314453125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria browseProductResult

500

bad input parameter
Up 
get /factsheets
factsheet for ingredient group/synonyms/primary ingredient (factsheet)
Allows API consumer to retrieve a paginated list of labels by product name, or a paginated list based on a query term executed against product name

Query parameters

q (required)
Query Parameter — primary ingredient, spelling as supplied by result in browse-ingredientgroups

Return type

FactSheet

Example data

Content-Type: application/json
{
  "hits" : [ {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "_score" : 6.02745618307040320615897144307382404804229736328125
  }, {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "_score" : 6.02745618307040320615897144307382404804229736328125
  } ],
  "total" : "{}",
  "max_score" : 0.80082819046101150206595775671303272247314453125
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria FactSheet

500

bad input parameter
Up 
get /label/{dsldId}
retrieve data for a single label (getLabel)
Retrieves a label by unique dsldId.

Path parameters

dsldId (required)
Path Parameter — label ID

Return type

Label

Example data

Content-Type: application/json
{
  "langualProductType" : "langualProductType",
  "entryDate" : "2016-08-29T00:00:00.000Z",
  "dsldId" : 0,
  "statementGroups" : [ {
    "groupName" : "groupName",
    "statements" : "statements"
  }, {
    "groupName" : "groupName",
    "statements" : "statements"
  } ],
  "ipSymbol" : "ipSymbol",
  "productName" : "productName",
  "langualClaimsOrUses" : "langualClaimsOrUses",
  "dietarySupplementsFacts" : [ {
    "driFootNotes" : "driFootNotes",
    "otherTargetGroups" : "otherTargetGroups",
    "servingsPerContainer" : 6,
    "labelFootNotes" : "labelFootNotes",
    "dailyValueTargetGroups" : "dailyValueTargetGroups",
    "targetGroupId" : "3970",
    "ingredients" : [ {
      "childInfo" : [ {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      }, {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      } ],
      "data" : [ {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      }, {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      } ],
      "dvPercent" : 5,
      "name" : "name",
      "altName" : "altName",
      "dvFactor" : 2.3021358869347654518833223846741020679473876953125
    }, {
      "childInfo" : [ {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      }, {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      } ],
      "data" : [ {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      }, {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      } ],
      "dvPercent" : 5,
      "name" : "name",
      "altName" : "altName",
      "dvFactor" : 2.3021358869347654518833223846741020679473876953125
    } ],
    "servingSizeUnitName" : "servingSizeUnitName",
    "servingSizeQuantity" : 7,
    "otheringredients" : "{}",
    "targetGroupName" : "targetGroupName",
    "usageSuggestion" : "{}"
  }, {
    "driFootNotes" : "driFootNotes",
    "otherTargetGroups" : "otherTargetGroups",
    "servingsPerContainer" : 6,
    "labelFootNotes" : "labelFootNotes",
    "dailyValueTargetGroups" : "dailyValueTargetGroups",
    "targetGroupId" : "3970",
    "ingredients" : [ {
      "childInfo" : [ {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      }, {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      } ],
      "data" : [ {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      }, {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      } ],
      "dvPercent" : 5,
      "name" : "name",
      "altName" : "altName",
      "dvFactor" : 2.3021358869347654518833223846741020679473876953125
    }, {
      "childInfo" : [ {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      }, {
        "prefix" : "prefix",
        "percentage" : "percentage",
        "name" : "name",
        "altName" : "altName",
        "botanicalInfo" : "botanicalInfo"
      } ],
      "data" : [ {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      }, {
        "ingredientEntryCategory" : "ingredientEntryCategory",
        "sfbQuantityQuantity" : 1,
        "relationalOperatorOperatorSymbol" : "relationalOperatorOperatorSymbol",
        "ingredientEntrySubspecies" : "ingredientEntrySubspecies",
        "unitName" : "unitName",
        "blendAncestry" : "blendAncestry",
        "sfbDvPercent" : 5.962133916683182377482808078639209270477294921875,
        "ingredientEntryPlantPart" : "ingredientEntryPlantPart",
        "ingredientEntryNotes" : "ingredientEntryNotes",
        "ingredientEntrySpecies" : "ingredientEntrySpecies",
        "ingredientEntryGenus" : "ingredientEntryGenus",
        "ingredientEntryIpSymbolId" : "ingredientEntryIpSymbolId"
      } ],
      "dvPercent" : 5,
      "name" : "name",
      "altName" : "altName",
      "dvFactor" : 2.3021358869347654518833223846741020679473876953125
    } ],
    "servingSizeUnitName" : "servingSizeUnitName",
    "servingSizeQuantity" : 7,
    "otheringredients" : "{}",
    "targetGroupName" : "targetGroupName",
    "usageSuggestion" : "{}"
  } ],
  "langualCodes" : [ {
    "targetGroup" : [ "targetGroup", "targetGroup" ],
    "claimsOrUses" : [ "claimsOrUses", "claimsOrUses" ],
    "supplementForm" : [ "supplementForm", "supplementForm" ],
    "productType" : [ "productType", "productType" ]
  }, {
    "targetGroup" : [ "targetGroup", "targetGroup" ],
    "claimsOrUses" : [ "claimsOrUses", "claimsOrUses" ],
    "supplementForm" : [ "supplementForm", "supplementForm" ],
    "productType" : [ "productType", "productType" ]
  } ],
  "langualTargetGroup" : "langualTargetGroup",
  "statementOfIdentity" : "statementOfIdentity",
  "netContentQuantities" : "netContentQuantities",
  "offMarket" : 9,
  "langualSupplementForm" : "langualSupplementForm",
  "sku" : "sku",
  "nhanesId" : "nhanesId",
  "brand" : "brand",
  "outerPackaging" : "outerPackaging",
  "servingSize" : [ {
    "size" : "size",
    "type" : "type"
  }, {
    "size" : "size",
    "type" : "type"
  } ],
  "events" : [ {
    "date" : "date",
    "name" : "name"
  }, {
    "date" : "date",
    "name" : "name"
  } ],
  "contacts" : [ {
    "zip" : "zip",
    "country" : "country",
    "isDistributor" : "isDistributor",
    "city" : "city",
    "webAddress" : "webAddress",
    "isManufacturer" : "isManufacturer",
    "contactType" : "contactType",
    "isPackager" : "isPackager",
    "isReseller" : "isReseller",
    "phoneNumber" : "phoneNumber",
    "streetAddress" : "streetAddress",
    "name" : "name",
    "state" : "state",
    "isOther" : "isOther",
    "email" : "email"
  }, {
    "zip" : "zip",
    "country" : "country",
    "isDistributor" : "isDistributor",
    "city" : "city",
    "webAddress" : "webAddress",
    "isManufacturer" : "isManufacturer",
    "contactType" : "contactType",
    "isPackager" : "isPackager",
    "isReseller" : "isReseller",
    "phoneNumber" : "phoneNumber",
    "streetAddress" : "streetAddress",
    "name" : "name",
    "state" : "state",
    "isOther" : "isOther",
    "email" : "email"
  } ],
  "suggestedUse" : "suggestedUse"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

data for a single label Label

500

bad input parameter
Up 
get /search-filter
primary search API call (searchFilter)
Allows API consumer to retrieve a set of labels by product name matching a complex combination of search terms and filters

Query parameters

q (optional)
Query Parameter — query term, will search for submitted tokens across all label fields, use quotes to find exact multi token matches
from (optional)
Query Parameter — number of start record for pagination, default is 0 default: 0 format: int32
size (optional)
Query Parameter — number of records to return, starting at from default: 1000 format: int32
sort_by (optional)
Query Parameter — specifies sort_by mode
sort_order (optional)
Query Parameter — specifies sort_by mode
status (optional)
Query Parameter — filter for market status, optional parameter, 2 all, 1 on market, 0 off market
date_start (optional)
Query Parameter — filter for entryDate start year, optional parameter, use 4 digit year YYYY
date_end (optional)
Query Parameter — filter for entryDate end year, optional parameter, use 4 digit year YYYY
product_name (optional)
Query Parameter — filter for product name(s), one or more separated by comma. optional, requires product name to contain submitted token
product_type (optional)
Query Parameter — filter for product type, one ore more codes separated by comma. Codes are a1305 Amino Acid/Protein,a1306 Botanical,a1326 Fiber and Other Nutrients,a1310 Omega 3 and Other Fatty Acids,a1302 Vitamin,a1299 Mineral,a1316 Single Vitamin and Mineral,a1315 Multi-Vitamin and Mineral (MVM),a1317 Botanicals with Nutrients,a1309 Non-Nutrient/Non-Botanical,a1325 Other Combinations
ingredient_name (optional)
Query Parameter — filter for ingredient name, one or more separated by comma, optional, requires ingredient name to contain submitted token, or the ingredient to be synonymous with submitted token
ingredient_group (optional)
Query Parameter — filter for ingredient group, one ore more codes separated by comma. Codes are amino_acid,animal_part_or_source,blend,botanical,sugars,complex_carbohydrate,enzyme,fat,fatty_acid,fiber,hormone,chemical,bacteria,protein,vitamin,mineral,other,tbd
brand (optional)
Query Parameter — filter for brand name, one or more separated by comma, optional, requires brand name to contain submitted token
target_group (optional)
Query Parameter — filter for product target group, one ore more codes separated by comma. Codes are p0250 All Adults and Children Four Years and Above,p0192 Children 1 to 4 Years,p0266 Infants,p0253 Pregnant and Lactating
supplement_form (optional)
Query Parameter — filter for product supplement form, one ore more codes separated by comma. Codes are e0164 Bars,e0159 Capsules,e0161 Softgel Capsules,e0155 Tablets and Pills,e0176 Gummies and Jellies,e0165 Liquids,e0174 Lozenges,e0162 Powders,e0172 Other (e.g. tea bag),e0177 Unknown
label_claim (optional)
Query Parameter — filter for label statements and claims, one or more separated by comma, optional, requires label statement type to contain submitted token
claim_type (optional)
Query Parameter — filter for claim type present on label, one ore more codes separated by comma. Codes are p0065 Nutrient,p0265 Structure/Function,p0124 Approved Health,p0264 Qualified Health,p0115 All Other,p0276 No Claims

Return type

SearchResult

Example data

Content-Type: application/json
{
  "hits" : [ {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ 6.02745618307040320615897144307382404804229736328125, 6.02745618307040320615897144307382404804229736328125 ],
    "_score" : 0.80082819046101150206595775671303272247314453125
  }, {
    "_index" : "_index",
    "_type" : "_type",
    "_source" : "{}",
    "_id" : "_id",
    "sort" : [ 6.02745618307040320615897144307382404804229736328125, 6.02745618307040320615897144307382404804229736328125 ],
    "_score" : 0.80082819046101150206595775671303272247314453125
  } ],
  "stats" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria SearchResult

500

bad input parameter
Up 
get /search-filter-histogram
search API supporting call, generates histogram of labels over time based on selection criterica (searchFilterHistogram)
Allows API consumer to retrieve a of labels by product name matching a complex combination of search terms and filters

Query parameters

q (optional)
Query Parameter — query term, will search for submitted tokens across all label fields, use quotes to find exact multi token matches
from (optional)
Query Parameter — number of start record for pagination, default is 0 default: 0 format: int32
size (optional)
Query Parameter — number of records to return, starting at from default: 1000 format: int32
sort_by (optional)
Query Parameter — specifies sort_by mode
sort_order (optional)
Query Parameter — specifies sort_by mode
status (optional)
Query Parameter — filter for market status, optional parameter, 2 all, 1 on market, 0 off market
date_start (optional)
Query Parameter — filter for entryDate start year, optional parameter, use 4 digit year YYYY
date_end (optional)
Query Parameter — filter for entryDate end year, optional parameter, use 4 digit year YYYY
product_name (optional)
Query Parameter — filter for product name(s), one or more separated by comma. optional, requires product name to contain submitted token
product_type (optional)
Query Parameter — filter for product type, one ore more codes separated by comma. Codes are a1305 Amino Acid/Protein,a1306 Botanical,a1326 Fiber and Other Nutrients,a1310 Omega 3 and Other Fatty Acids,a1302 Vitamin,a1299 Mineral,a1316 Single Vitamin and Mineral,a1315 Multi-Vitamin and Mineral (MVM),a1317 Botanicals with Nutrients,a1309 Non-Nutrient/Non-Botanical,a1325 Other Combinations
ingredient_name (optional)
Query Parameter — filter for ingredient name, one or more separated by comma, optional, requires ingredient name to contain submitted token, or the ingredient to be synonymous with submitted token
ingredient_group (optional)
Query Parameter — filter for ingredient group, one ore more codes separated by comma. Codes are amino_acid,animal_part_or_source,blend,botanical,sugars,complex_carbohydrate,enzyme,fat,fatty_acid,fiber,hormone,chemical,bacteria,protein,vitamin,mineral,other,tbd
brand (optional)
Query Parameter — filter for brand name, one or more separated by comma, optional, requires brand name to contain submitted token
target_group (optional)
Query Parameter — filter for product target group, one ore more codes separated by comma. Codes are p0250 All Adults and Children Four Years and Above,p0192 Children 1 to 4 Years,p0266 Infants,p0253 Pregnant and Lactating
supplement_form (optional)
Query Parameter — filter for product supplement form, one ore more codes separated by comma. Codes are e0164 Bars,e0159 Capsules,e0161 Softgel Capsules,e0155 Tablets and Pills,e0176 Gummies and Jellies,e0165 Liquids,e0174 Lozenges,e0162 Powders,e0172 Other (e.g. tea bag),e0177 Unknown
label_claim (optional)
Query Parameter — filter for label statements and claims, one or more separated by comma, optional, requires label statement type to contain submitted token
claim_type (optional)
Query Parameter — filter for claim type present on label, one ore more codes separated by comma. Codes are p0065 Nutrient,p0265 Structure/Function,p0124 Approved Health,p0264 Qualified Health,p0115 All Other,p0276 No Claims

Return type

SearchHistogramResult

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

search results matching criteria SearchHistogramResult

500

bad input parameter

Models

[ Jump to Methods ]

Table of Contents

  1. Contact -
  2. DietarySupplementsFact -
  3. Event -
  4. FactSheet -
  5. FactSheetGroup -
  6. FactSheetHit -
  7. FactSheetSource -
  8. HistogramEntry -
  9. Ingredient -
  10. IngredientChild -
  11. IngredientData -
  12. Label -
  13. LangualCode -
  14. OtherIngredient -
  15. SearchHistogramResult -
  16. SearchResult -
  17. SearchResultDietarySupplementsFact -
  18. SearchResultHit -
  19. SearchResultIngredient -
  20. SearchResultIngredientData -
  21. ServingSize -
  22. SingleFactSheet -
  23. StatementGroup -
  24. Stats -
  25. TruncatedBrandProductLabel -
  26. TruncatedBrowseBrandLabel -
  27. TruncatedBrowseProductLabel -
  28. TruncatedSearchResultLabel -
  29. UsageSuggestion -
  30. brandProductHit -
  31. brandProductResult -
  32. browseBrandHit -
  33. browseBrandResult -
  34. browseIngredientGroupHit -
  35. browseIngredientGroupInfo -
  36. browseIngredientGroupsResult -
  37. browseProductHit -
  38. browseProductResult -
  39. browseTotal -

Contact - Up

zip (optional)
String
country (optional)
String
isDistributor (optional)
String
city (optional)
String
webAddress (optional)
String
isManufacturer (optional)
String
contactType (optional)
String
isPackager (optional)
String
isReseller (optional)
String
phoneNumber (optional)
String
streetAddress (optional)
String
name (optional)
String
state (optional)
String
isOther (optional)
String
email (optional)
String

DietarySupplementsFact - Up

driFootNotes (optional)
String
otherTargetGroups (optional)
String
servingsPerContainer (optional)
Integer
labelFootNotes (optional)
String
dailyValueTargetGroups (optional)
String
targetGroupId (optional)
String 3970 - Adults and children 4 or more years of age, 3971 - Infants, 3972 - Children less than 4 years of age, 3973 Pregnant and lactating women
Enum:
3970
3971
3972
3973
ingredients (optional)
array[Ingredient]
servingSizeUnitName (optional)
String
servingSizeQuantity (optional)
Integer
otheringredients (optional)
Object
targetGroupName (optional)
String
usageSuggestion (optional)
Object

Event - Up

date (optional)
String
name (optional)
String

FactSheet - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[FactSheetHit]

FactSheetGroup - Up

groupName (optional)
String
nutrientInfo (optional)
Object disregard
factsheets (optional)
array[SingleFactSheet]
synonyms (optional)
String
groupId (optional)
Integer internal group id, disregard
category (optional)
String ingredient categorization
nhanesInfo (optional)
Object disregard

FactSheetHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect 'doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object

FactSheetSource - Up

ingredient (optional)
String the primary ingredient name
group (optional)
array[FactSheetGroup]

HistogramEntry - Up

key_as_string (optional)
String date labels were added
key (optional)
Integer elasticsearch encoding of date labels were added
doc_count (optional)
Integer label count

Ingredient - Up

childInfo (optional)
array[IngredientChild]
data (optional)
array[IngredientData]
dvPercent (optional)
Integer
name (optional)
String
altName (optional)
String
dvFactor (optional)
BigDecimal

IngredientChild - Up

prefix (optional)
String
percentage (optional)
String
name (optional)
String
altName (optional)
String
botanicalInfo (optional)
String

IngredientData - Up

blendAncestry (optional)
String
relationalOperatorOperatorSymbol (optional)
String
ingredientEntrySubspecies (optional)
String
sfbQuantityQuantity (optional)
Integer
unitName (optional)
String
sfbDvPercent (optional)
BigDecimal
ingredientEntryPlantPart (optional)
String
ingredientEntryNotes (optional)
String
ingredientEntryGenus (optional)
String
ingredientEntryCategory (optional)
String
ingredientEntrySpecies (optional)
String
ingredientEntryIpSymbolId (optional)
String

Label - Up

langualProductType (optional)
String
entryDate (optional)
date format: date
example: 2016-08-29T00:00:00.000Z
dsldId
Integer
statementGroups (optional)
array[StatementGroup]
ipSymbol (optional)
String
productName (optional)
String
langualClaimsOrUses (optional)
String
dietarySupplementsFacts (optional)
array[DietarySupplementsFact]
langualCodes (optional)
array[LangualCode]
langualTargetGroup (optional)
String
statementOfIdentity (optional)
String
netContentQuantities (optional)
String
offMarket (optional)
Integer
langualSupplementForm (optional)
String
sku (optional)
String
nhanesId (optional)
String
brand (optional)
String
outerPackaging (optional)
String
servingSize (optional)
array[ServingSize]
events (optional)
array[Event]
contacts (optional)
array[Contact]
suggestedUse (optional)
String

LangualCode - Up

claimsOrUses (optional)
array[String]
productType (optional)
array[String]
supplementForm (optional)
array[String]
targetGroup (optional)
array[String]

OtherIngredient - Up

text (optional)
String
type (optional)
String

SearchHistogramResult - Up

SearchResult - Up

hits (optional)
array[SearchResultHit]
stats (optional)
Object

SearchResultDietarySupplementsFact - Up

ingredients (optional)
array[SearchResultIngredient]

SearchResultHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect 'doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[BigDecimal] score, on/off market sorting

SearchResultIngredient - Up

data (optional)
array[SearchResultIngredientData]
name (optional)
String

SearchResultIngredientData - Up

ingredientEntryCategory (optional)
String

ServingSize - Up

size (optional)
String
type (optional)
String

SingleFactSheet - Up

offsite factsheet references
name (optional)
String external factsheet name
url (optional)
String external factsheet URL

StatementGroup - Up

groupName (optional)
String
statements (optional)
String

Stats - Up

count (optional)
Integer
pct (optional)
BigDecimal

TruncatedBrandProductLabel - Up

langualProductType (optional)
String
entryDate (optional)
date format: date
example: 2016-08-29T00:00:00.000Z
dsldId
Integer
statementGroups (optional)
array[StatementGroup]
productName (optional)
String
langualClaimsOrUses (optional)
String
dietarySupplementsFacts (optional)
array[DietarySupplementsFact]
langualCodes (optional)
array[LangualCode]
langualTargetGroup (optional)
String
statementOfIdentity (optional)
String
netContentQuantities (optional)
String
offMarket (optional)
Integer
langualSupplementForm (optional)
String
sku (optional)
String
nhanesId (optional)
String
brand (optional)
String
outerPackaging (optional)
String
servingSize (optional)
array[ServingSize]
events (optional)
array[Event]
contacts (optional)
array[Contact]
suggestedUse (optional)
String

TruncatedBrowseBrandLabel - Up

brand (optional)
String

TruncatedBrowseProductLabel - Up

netContentQuantities (optional)
String
offMarket (optional)
Integer
langualSupplementForm (optional)
String
servingSize (optional)
array[ServingSize]
productName (optional)
String

TruncatedSearchResultLabel - Up

langualProductType (optional)
String
langualTargetGroup (optional)
String
entryDate (optional)
date format: date
example: 2016-08-29T00:00:00.000Z
netContentQuantities (optional)
String
offMarket (optional)
Integer
langualSupplementForm (optional)
String
brand (optional)
String
productName (optional)
String
langualClaimsOrUses (optional)
String
dietarySupplementsFacts (optional)
array[SearchResultDietarySupplementsFact]

UsageSuggestion - Up

text (optional)
String
type (optional)
String

brandProductHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect 'doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[String]

brandProductResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[brandProductHit]

browseBrandHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect 'doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[String]

browseBrandResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[browseBrandHit]

browseIngredientGroupHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect 'doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[String]

browseIngredientGroupInfo - Up

cntSynSrc (optional)
Integer number of synonyms/sources
synSrc (optional)
String delimited list of synonyms/sources
rowNum (optional)
String disregard
grpId (optional)
BigDecimal internal group reference id
primIng (optional)
String primary ingredient
category (optional)
String group categorization
count (optional)
BigDecimal total number of products containing one of the ingredients in the synonym/categorization group
cntNhanes (optional)
BigDecimal number of products in NHanes containing one of the ingredients in the synonym/categorization group
sort (optional)
array[String]

browseIngredientGroupsResult - Up

browseProductHit - Up

_index (optional)
String Elasticsearch index used.
_type (optional)
String expect 'doc'
_id (optional)
String unique id, see dsldId
_score (optional)
BigDecimal match score or null
_source (optional)
Object
sort (optional)
array[String]

browseProductResult - Up

total (optional)
Object
max_score (optional)
BigDecimal maximum elasticsearch match score
hits (optional)
array[browseProductHit]

browseTotal - Up

value (optional)
Integer
relation (optional)
String relation in the response will indicate if the value returned is accurate ("eq") or a lower bound of the total ("gte")
Enum:
gte
eq