Skip to main content
Return filtered functional profile results as JSON. The returned JSON is similar in structure to the results returned by the functional profile results route. However, this route returns a simplified and filtered version of the results, which only includes a specified functional group, metric, and taxa stratification option. All ambiguous results, such as unmapped or ungrouped entries, are filtered out.
PropertyDescription
n_mapped integerThe number of reads that were successfully mapped to a gene family or pathway.
n_reads integerThe number of reads present in the sample.
table arrayAn array of objects consisting of individual functional groups (format below).
The table array contains results for a single functional group and metric, and also includes taxonomic information. Each object in the array has the following fields:
PropertyDescription
id stringA group-specific unique ID, e.g., GO:0006096, PF16874, COG0148.
name stringThe name of the function.
value numberGene family or pathway abundance in the specified metric.
taxon_id stringThe NCBI taxonomy ID for the organism associated with this function.
taxon_name stringThe name of the organism.
Warning: The above JSON format is specific to the current version of the functional analysis job. This format is stable and guaranteed to remain stable for this version of the job. However, future versions of the functional analysis job may alter the format or introduce new changes. Please use caution and include fallbacks when writing non-exploratory code using the above route. Please also feel free to reach out if you’d like to discuss this format and any forthcoming changes with us.