{
  "success": {
    "v": 2,
    "description": "Summary counts of dictionary terms mentioned in all documents",
    "options": {
      "parameters": {
        "term": "Term to find (returns documents which include the term)",
        "dictionary": "If specified, only terms within the dictionary are considered. Can be comma-separated list of dictionary names.",
        "dict_id": "The internal ID of the dictionary. Can be comma-separated list of dictionary IDs.",
        "publisher": "Publisher/database source of publications (e.g. USGS, Elsevier). If not specified, all sources are shown",
        "docid": "internal document ID(s); separate multiple docid values with commas. Gets known terms for specifie documents.",
        "show_docids": "(Requires term parameter as well) Return a list of internal GDD document IDs that contain the term",
        "hierarchy_includes": "If specified, only terms which have a hierarchy that includes the listed string are returned",
        "hierarchy_present": "If true, requires that at least one additional entity from the terms' hierarchy be present in order to be returned",
        "external_id": "(Requires dict_id or dictionary parameter as well) Search for a term by its ID within the external (source) database",
        "show_external_id": "If true, returns the ID stored within the terms' external source, if applicable"
      },
      "output_formats": [
        "json"
      ],
      "examples": [
        "/api/terms?term=Gea",
        "/api/terms?docid=54b43243e138239d86849175&dictionary=pbdb",
        "/api/terms?dict_id=4",
        "/api/terms?term=Gea&publisher=Elsevier",
        "/api/terms?term=Leggada tenella&show_docids",
        "/api/terms?dictionary=pbdb&hierarchy_includes=Mus",
        "/api/terms?external_id=175037&hierarchy_present=true&dict_id=44&show_external_id=true"
      ],
      "fields": {
        "term": "The keyword term found in one (or more) document",
        "n_docs": "The number of documents which match the term",
        "n_hits": "The total number of instances of the term within the document (or across all documents)",
        "n_pubs": "The total number of unique publications/journals which include mentions of the term",
        "n_sources": "The number of publishers whose publications include a mention of the term",
        "last_updated": "The date the dictionary was last ingested into the corpus",
        "classification": "The hierarchy stored (if any) for a given term"
      }
    },
    "license": "https://creativecommons.org/licenses/by-nc/2.0/"
  }
}