Skip to main content
GET
GET functional_profiles filtered_results
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. 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:
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.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Query Parameters

functional_group
enum<string>
required
Available options:
pathways,
metacyc,
eggnog,
go,
ko,
ec,
pfam,
reaction
metric
enum<string>
required
Available options:
rpk,
cpm,
abundance,
coverage,
complete_abundance
taxa_stratified
boolean
default:false

Response

200 - application/json

OK

n_mapped
integer
required
Required range: x >= 0
n_reads
integer
required
Required range: x >= 0
table
_FunctionalFilteredResultsRow · object[]
required