Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url https://app.onecodex.com/api/v1/functional_profiles/{id}/results \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.onecodex.com/api/v1/functional_profiles/{id}/results"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.onecodex.com/api/v1/functional_profiles/{id}/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.onecodex.com/api/v1/functional_profiles/{id}/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.onecodex.com/api/v1/functional_profiles/{id}/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.onecodex.com/api/v1/functional_profiles/{id}/results")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.onecodex.com/api/v1/functional_profiles/{id}/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodycurl --request GET \
--url https://app.onecodex.com/api/v1/functional_profiles/{id}/results \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.onecodex.com/api/v1/functional_profiles/{id}/results"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.onecodex.com/api/v1/functional_profiles/{id}/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.onecodex.com/api/v1/functional_profiles/{id}/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.onecodex.com/api/v1/functional_profiles/{id}/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.onecodex.com/api/v1/functional_profiles/{id}/results")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.onecodex.com/api/v1/functional_profiles/{id}/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body| Property | Description |
|---|---|
| n_mapped integer | The number of reads that were successfully mapped to a gene family or pathway. |
| n_reads integer | The number of reads present in the sample. |
| table array | An array of objects consisting of individual functional groups (format below). |
table array contains results across all functional groups and gene families, as well as taxonomic
information.
Each object in the array has the following fields:
| Property | Description |
|---|---|
| group_name string | The name of the functional group this result corresponds to. This will be one of the following: pathways, metacyc, eggnog, go, ko, ec, pfam, or reaction. |
| id string | A group-specific unique ID, e.g., GO:0006096, PF16874, COG0148. |
| metric string | The quantitative metric represented by the value field. This field will be one of the following values: cpm (counts per million), rpk (reads per kilobase), abundance, complete_abundance, or coverage. The abundance, complete_abundance and coverage metrics will only be present for pathway results, while cpm and rpk metrics are present for all other functional groups. |
| name string | The name of the function. |
| taxa_stratified boolean | A boolean indicating whether or not this result is associated with a specific organism. |
| taxon_id string | The NCBI taxonomy ID for the organism associated with this function. |
| taxon_name string | The name of the organism. |
| value number | Gene family or pathway abundance in the unit specified by the metric field. |
