{"endPoints":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","description":"Limits results","required":false,"dataType":"string","paramType":"query"},{"name":"humanOnly","description":"Returns results only from human visitors","required":false,"dataType":"string","paramType":"query"},{"name":"sortByFrequency","description":"Sorts results by frequency","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordResult]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"RecentViews","summary":"Fetches recent views from the website.","suggestedName":"getRecentViews","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/words/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"Stats type to fetch","required":false,"dataType":"string","paramType":"path"},{"name":"object","description":"Object identifier","required":false,"dataType":"string","paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordFrequency]","errorResponses":[{"reason":"Invalid dimension for WordFrequency data or Object Identifier not found.","code":400}],"condition":"any"}],"category":"Stats","summary":"Gets WordFrequency data","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/dictionaryStats","description":"","operations":[{"parameters":[{"name":"sourceDictionary","description":"Dictionary name to fetch stats for","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"dictionaryStats","errorResponses":[{"reason":"Invalid dictionary name supplied.","code":404}],"condition":"any"}],"category":"Stats","summary":"Gets Dictionary Statistics data","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/firstUsed","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[basicWordUsage]","errorResponses":[{"reason":"No data found for corpus.","code":404}],"condition":"any"}],"category":"Stats","summary":"Gets Dictionary Statistics data","suggestedName":"getWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus","description":"","operations":[{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/corpus.{format}/totalDocumentCount","description":"","operations":[{"response":[{"valueType":"long","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"CorpusCounters","summary":"Returns the count of documents in the Corpus.","suggestedName":"getTotalDocumentCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/processText","description":"","operations":[{"parameters":[{"description":"Text body to process.","required":false,"dataType":"string","paramType":"body"},{"name":"split","description":"Tells the processor to split multiple sentences from the input.  Default is true.","required":false,"dataType":"string","paramType":"query"},{"name":"rank","description":"Flag to invoke the ranking logic.  Default is false.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"List[sentence]","errorResponses":[{"reason":"Invalid text supplied.","code":400}],"condition":"any"}],"category":"TextProcessing","summary":"Processes text input.","suggestedName":"processText","deprecated":false,"open":false,"notes":"Returns tagged and processed text based on the input string.","httpMethod":"POST"}]},{"path":"/corpus.{format}/punctuationFactor","description":"","operations":[{"response":[{"valueType":"punctuationFactor","errorResponses":[{"reason":"No data available.","code":404}],"condition":"any"}],"category":"TextProcessing","summary":"Returns corpus-wide PunctuationFactor.","suggestedName":"getPunctuationFactor","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/phraseFeedback","description":"","operations":[{"parameters":[{"description":"Phrase to store.","required":false,"dataType":"string","paramType":"body"}],"response":[{"valueType":"List[sentence]","errorResponses":[{"reason":"Invalid phrase supplied.","code":400}],"condition":"any"}],"category":"TextProcessing","summary":"Receives info on phrases which should be captured","suggestedName":"getPunctuationFactor","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/corpus.{format}/documentStats","description":"","operations":[{"parameters":[{"name":"documentStatsType","description":"Type of statistics to return","required":false,"dataType":"string","paramType":"query"},{"name":"id","description":"ID of statistics type to return.","required":false,"dataType":"string","paramType":"query"},{"name":"split","description":"Flag to invoke the ranking logic.  Default is false.","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"basicDocumentStats","errorResponses":[{"reason":"Invalid stats type supplied.","code":400}],"condition":"any"}],"category":"Stats","summary":"Returns document-level stats.","suggestedName":"getDocumentStats","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/words","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordFrequency]","errorResponses":[{"reason":"No corpus frequency data available.","code":400}],"condition":"any"}],"category":"Stats","summary":"Gets corpus-level WordFrequency","suggestedName":"getCorpusWordFrequencies","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/dymInternal/{wordstring}","description":"","operations":[{"parameters":[{"name":"wordstring","description":"Returns results only from human visitors","required":false,"dataType":"string","paramType":"path"}],"response":[{"valueType":"relationshipMap","errorResponses":[{"reason":"No data available.","code":404},{"reason":"Invalid word supplied.","code":400}],"condition":"any"}],"category":"Unused","summary":"Returns word relationships.","suggestedName":"getDym","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/recentListedWords","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximun results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordListingHistory]","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"RecentListedWords","summary":"Returns recently listed words.","suggestedName":"getRecentListedWords","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word of interest","required":false,"dataType":"string","paramType":"query"},{"name":"contextString","description":"Sentence word appears in","required":false,"dataType":"string","paramType":"query"},{"name":"title","description":"Word of interest","required":false,"dataType":"string","paramType":"query"},{"name":"metadataId","description":"Word of interest","required":false,"dataType":"string","paramType":"query"},{"name":"partnerId","description":"Partner Id","required":false,"dataType":"string","paramType":"query"},{"name":"sourceUrl","description":"Document source URL","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"contextualLookupResponse","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"ContextualLookup","summary":"Mock method to return Contextual Lookup info.","suggestedName":"getMockContextualLookupInfo","deprecated":false,"open":false,"notes":"Internal Only","httpMethod":"GET"},{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"contextualLookupRequest","paramType":"query"}],"response":[{"valueType":"contextualLookupResponse","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"ContextualLookup","summary":"Fetches ContextualLookup info.","suggestedName":"getContextualLookupInfo","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/corpus.{format}/totalWordCount","description":"","operations":[{"response":[{"valueType":"long","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"CorpusCounters","summary":"Returns the count of tokens in the Corpus.","suggestedName":"getTotalTokensCount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/corpus.{format}/sentenceCount","description":"","operations":[{"response":[{"valueType":"long","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"CorpusCounters","summary":"Returns the count of sentences in the Corpus.","suggestedName":"getTotalSentencesCount","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"sentence","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","paramType":"List[scoredWord]"},{"name":"display","required":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"paramType":"long"},{"name":"rating","required":false,"paramType":"int"}]},{"name":"wordFrequency","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"relationshipMap","fields":[{"name":"sourceWordstring","required":false,"paramType":"string"},{"name":"suggestion","required":false,"wrapperName":"suggestions","paramType":"List[suggestion]"}]},{"name":"punctuationFactor","fields":[{"name":"totalCount","required":false,"paramType":"long"},{"name":"wordId","required":false,"paramType":"long"},{"name":"periodCount","required":false,"paramType":"long"},{"name":"exclamationPointCount","required":false,"paramType":"long"},{"name":"questionMarkCount","required":false,"paramType":"long"}]},{"name":"lookupExample","fields":[{"name":"uRL","required":false,"paramType":"string"},{"name":"sourceName","required":false,"paramType":"string"},{"name":"exampleString","required":false,"paramType":"string"}]},{"name":"long","fields":[{"name":"value","required":false,"paramType":"long"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"basicWordUsage","fields":[{"name":"year","required":false,"paramType":"integer"},{"name":"wordstring","required":false,"paramType":"string"},{"name":"documentId","required":false,"paramType":"long"},{"name":"sentenceId","required":false,"paramType":"long"}]},{"name":"wordListingHistory","fields":[{"name":"wordString","required":false,"paramType":"string"},{"name":"wordId","required":false,"paramType":"long"},{"name":"listingCount","required":false,"paramType":"long"}]},{"name":"dictionaryStats","fields":[{"name":"dictionaryName","required":false,"paramType":"string"},{"name":"wordCount","required":false,"paramType":"int"},{"name":"defintionCount","required":false,"paramType":"int"},{"name":"exampleCount","required":false,"paramType":"int"},{"name":"textPronunciationCount","required":false,"paramType":"int"},{"name":"wordsWithRelationship","required":false,"paramType":"Map[string,integer]"},{"name":"relationshipLinks","required":false,"paramType":"Map[string,integer]"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"wordResult","fields":[{"name":"count","required":false,"paramType":"long"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"paramType":"long"},{"name":"wordType","required":false,"paramType":"string"},{"name":"position","required":false,"paramType":"int"},{"name":"word","required":false,"paramType":"string"},{"name":"score","required":false,"paramType":"float"},{"name":"sentenceId","required":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"paramType":"string"}]},{"name":"contextualLookupResponse","fields":[{"name":"examples","required":false,"wrapperName":"lookupExamples","paramType":"List[lookupExample]"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"paramType":"string"},{"name":"type","required":false,"paramType":"string"},{"name":"sentencesCount","required":false,"paramType":"long"},{"name":"documentsCount","required":false,"paramType":"long"},{"name":"tokensCount","required":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"paramType":"long"},{"name":"wordsCount","required":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"paramType":"long"}]},{"name":"suggestion","fields":[{"name":"type","required":false,"paramType":"int"},{"name":"wordstring","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]}]}