variant/segment/get

Retrieve segments

Parameters

NameRequiredDefaultDescriptionExample
segmentIDfalseSegment id to retrieve1
segmentGroupIDfalseRetrieve all segments in a segment group1
indexContentfalseLimit segements to indexContentJohn.3
docIDfalseLimit segements to where docID has data. Can also be a range91035-91037
breakoutSublabelReadingsfalsetruewhether or not to break out sublabel readings into their own readingsfalse
detailfalsecompleteadd extra detail if desiredextra
formatfalsespecified at session openresponse output format (json|xml|csv|gchart)json

Examples

Errors

usage0