cohorts().preview()

Takes a JSON object of filters in the request body and returns a “preview” of the cohort that would result from passing a similar request to the cohort save endpoint. This preview consists of two lists: the lists of case barcodes, and the list of sample barcodes. Authentication is not required.

Example:

curl "https://api-dot-isb-cgc.appspot.com/_ah/api/isb_cgc_ccle_api/v3/cohorts/preview?program_short_name=CCLE-BLCA&program_short_name=CCLE-LUSC&gender=Male"

API explorer example:

Click here to see this endpoint in Google’s API explorer.

Python API Client Example:

from googleapiclient.discovery import build
import httplib2

def get_unauthorized_service():
        api = 'isb_cgc_ccle_api'
        version = 'v3'
        site = 'https://api-dot-isb-cgc.appspot.com'
        discovery_url = '%s/_ah/api/discovery/v1/apis/%s/%s/rest' % (site, api, version)
        return build(api, version, discoveryServiceUrl=discovery_url, http=httplib2.Http())

service = get_unauthorized_service()
body = {'program_short_name': ['CCLE-BLCA', 'CCLE-LUSC'], 'gender': Male}
data = service.cohorts().preview(**body).execute()

Request

HTTP request:

POST https://api-dot-isb-cgc.appspot.com/_ah/api/isb_cgc_ccle_api/v3/tcga/cohorts/preview?fields=case_count%2Ccases%2Csample_count%2Csamples

{

“Common”: {

“project_short_name”: [

“CCLE-BLCA”, “CCLE-LUSC”

]

}, “Clinical”: {

“gender”: [

“Male”

]

}

}

Parameters

Parameter name	Value	Description
case_barcode	string	Optional.
case_gdc_id	string	Optional.
disease_code	string	Optional.
endpoint_type	string	Optional.
gender	string	Optional.
hist_subtype	string	Optional.
histology	string	Optional.
program_name	string	Optional.
project_short_name	string	Optional.
sample_barcode	string	Optional.
sample_gdc_id	string	Optional.
sample_type	string	Optional.
site_primary	string	Optional.
source	string	Optional.
summary_file_count	integer	Optional.
summary_file_count_gte	integer	Optional.
summary_file_count_lte	integer	Optional.

Response

If successful, this method returns a response body with the following structure:

{
  "case_count": integer,
  "cases": [string],
  "sample_count": integer,
  "samples": [string]
}

Parameter name	Value	Description
case_count	integer	Number of cases in the cohort.
cases[]	list	List of cases barcodes in the cohort.
sample_count	integer	Number of samples in the cohort.
samples[]	list	List of sample barcodes in the cohort.

---

Have feedback or corrections? You can file an issue here or email us at feedback@isb-cgc.org.