From b3a2d9b5d12b2601aeb4da0ac07115455af82aca Mon Sep 17 00:00:00 2001 From: Danielle Callan Date: Tue, 9 Jan 2024 12:52:34 -0500 Subject: [PATCH 1/5] update schema to return correlation bipartite network thresholds used --- api.raml | 4 ++-- schema/url/correlation/correlation.raml | 9 ++++++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/api.raml b/api.raml index 06825b2e..f58d3429 100644 --- a/api.raml +++ b/api.raml @@ -540,7 +540,7 @@ securitySchemes: 200: body: application/json: - type: lib.BipartiteNetworkPostResponse + type: lib.CorrelationBipartiteNetworkPostResponse /correlationassaymetadata/visualizations: displayName: Visualizations for discovering corrleations between assay data and sample metadata @@ -555,7 +555,7 @@ securitySchemes: 200: body: application/json: - type: lib.BipartiteNetworkPostResponse + type: lib.CorrelationBipartiteNetworkPostResponse /distributions/visualizations: displayName: Visualizations for exploring distributions of data. diff --git a/schema/url/correlation/correlation.raml b/schema/url/correlation/correlation.raml index 1db76a32..730bb2c4 100644 --- a/schema/url/correlation/correlation.raml +++ b/schema/url/correlation/correlation.raml @@ -10,4 +10,11 @@ types: required: false correlationCoefThreshold: type: number - required: false \ No newline at end of file + required: false + + CorrelationBipartiteNetworkPostResponse: + additionalProperties: false + type: BipartiteNetworkPostResponse + properties: + significanceThreshold: number + correlationCoefThreshold: number \ No newline at end of file From 7b2ed95e393c5dd3a66472c4bb528421ef8314b4 Mon Sep 17 00:00:00 2001 From: Danielle Callan Date: Tue, 9 Jan 2024 12:53:07 -0500 Subject: [PATCH 2/5] update java to reflect correlation bipartite network api change and return thresholds used --- .../correlation/AbstractCorrelationBipartiteNetwork.java | 4 +++- .../org/veupathdb/service/eda/ds/service/AppsService.java | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java b/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java index d018ba6c..f77316fd 100644 --- a/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java +++ b/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java @@ -130,8 +130,10 @@ protected void writeResults(OutputStream out, Map dataStrea bipartiteNetwork.setData(bipartiteNetworkData); bipartiteNetwork.setConfig(bipartiteNetworkConfig); - BipartiteNetworkPostResponse response = new BipartiteNetworkPostResponseImpl(); + CorrelationBipartiteNetworkPostResponse response = new CorrelationBipartiteNetworkPostResponseImpl(); response.setBipartitenetwork(bipartiteNetwork); + response.setSignificanceThreshold(pValueThreshold); + response.setCorrelationCoefThreshold(correlationCoefThreshold); JsonUtil.Jackson.writeValue(out, response); out.flush(); diff --git a/src/main/java/org/veupathdb/service/eda/ds/service/AppsService.java b/src/main/java/org/veupathdb/service/eda/ds/service/AppsService.java index aa81f16c..d0f9a541 100644 --- a/src/main/java/org/veupathdb/service/eda/ds/service/AppsService.java +++ b/src/main/java/org/veupathdb/service/eda/ds/service/AppsService.java @@ -348,14 +348,14 @@ public PostAppsDifferentialabundanceVisualizationsVolcanoplotResponse postAppsDi @Override public PostAppsCorrelationassaymetadataVisualizationsBipartitenetworkResponse postAppsCorrelationassaymetadataVisualizationsBipartitenetwork(CorrelationAssayMetadataBipartitenetworkPostRequest entity) { return wrapPlugin(() -> PostAppsCorrelationassaymetadataVisualizationsBipartitenetworkResponse.respond200WithApplicationJson( - new BipartiteNetworkPostResponseStream(processRequest(new CorrelationAssayMetadataBipartitenetworkPlugin(), entity)))); + new CorrelationBipartiteNetworkPostResponseStream(processRequest(new CorrelationAssayMetadataBipartitenetworkPlugin(), entity)))); } @DisableJackson @Override public PostAppsCorrelationassayassayVisualizationsBipartitenetworkResponse postAppsCorrelationassayassayVisualizationsBipartitenetwork(CorrelationAssayAssayBipartitenetworkPostRequest entity) { return wrapPlugin(() -> PostAppsCorrelationassayassayVisualizationsBipartitenetworkResponse.respond200WithApplicationJson( - new BipartiteNetworkPostResponseStream(processRequest(new CorrelationAssayAssayBipartitenetworkPlugin(), entity)))); + new CorrelationBipartiteNetworkPostResponseStream(processRequest(new CorrelationAssayAssayBipartitenetworkPlugin(), entity)))); } @DisableJackson From a19390719c13a5b9b1f7a26985b924b365aad023 Mon Sep 17 00:00:00 2001 From: Danielle Callan Date: Tue, 9 Jan 2024 12:53:17 -0500 Subject: [PATCH 3/5] update docs --- docs/api.html | 8 ++++---- schema/library.raml | 6 ++++++ src/main/resources/api.html | 8 ++++---- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/api.html b/docs/api.html index ec8f20f3..ba8c9753 100644 --- a/docs/api.html +++ b/docs/api.html @@ -1222,7 +1222,7 @@ bindFilters(); }); -

EDA Workspace Data Service API vv1.0.0

link

Resources

post /filter-aware-metadata/continuous-variable

 

Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.

curl -X POST \
+		

EDA Workspace Data Service API vv1.0.0

link

Resources

post /filter-aware-metadata/continuous-variable

 

Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
   undefined/filter-aware-metadata/continuous-variable

Request Body chevron_right expand_more

ContinuousVariableMetadataPostRequest ContinuousVariableMetadataPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ContinuousVariableMetadataSpec

config.variable*object

Inherits: object

config.variable.entityId*string
config.variable.variableId*string
config.metadata*array
config.metadata[]string
Enum:
  • binRanges
  • median

200 OK chevron_right expand_more

ContinuousVariableMetadataPostResponse ContinuousVariableMetadataPostResponse

application/json

Inherits: object

ParameterTypeDescription
binRangesobject

Inherits: object

binRanges.equalInterval*array
binRanges.equalInterval[]object

Inherits: lib.Range

binRanges.equalInterval[].min*string
binRanges.equalInterval[].max*string
binRanges.equalInterval[].label*string
binRanges.quantile*array
binRanges.quantile[]object

Inherits: lib.Range

binRanges.quantile[].min*string
binRanges.quantile[].max*string
binRanges.quantile[].label*string
binRanges.standardDeviation*array
binRanges.standardDeviation[]object

Inherits: lib.Range

binRanges.standardDeviation[].min*string
binRanges.standardDeviation[].max*string
binRanges.standardDeviation[].label*string
mediannumber

get /apps

 

200 OK chevron_right expand_more

AppsGetResponse AppsGetResponse

application/json

Additional properties: Yes

Inherits: object

ParameterTypeDescription
apps*array
apps[]object

Inherits: lib.AppOverview

apps[].name*string
apps[].displayName*string
apps[].description*string
apps[].projects*array
apps[].projects[]string
apps[].computeNamestring
apps[].visualizations*array
apps[].visualizations[]object

Inherits: lib.VisualizationOverview

apps[].visualizations[].name*string
apps[].visualizations[].displayName*string
apps[].visualizations[].description*string
apps[].visualizations[].projects*array
apps[].visualizations[].projects[]string
apps[].visualizations[].maxPanels*number
apps[].visualizations[].dataElementConstraintsarray
apps[].visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

apps[].visualizations[].dataElementConstraints[].//*object

Inherits: object

apps[].visualizations[].dataElementConstraints[].//.isRequired*boolean
apps[].visualizations[].dataElementConstraints[].//.isTemporal*boolean
apps[].visualizations[].dataElementConstraints[].//.isCollection*boolean
apps[].visualizations[].dataElementConstraints[].//.isCompositional*boolean
apps[].visualizations[].dataElementConstraints[].//.isProportion*boolean
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
apps[].visualizations[].dataElementConstraints[].//.minNumVars*number
apps[].visualizations[].dataElementConstraints[].//.maxNumVars*number
apps[].visualizations[].dataElementConstraints[].//.minNumValues*number
apps[].visualizations[].dataElementConstraints[].//.maxNumValues*number
apps[].visualizations[].dataElementConstraints[].//.allowedTypesarray
apps[].visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

apps[].visualizations[].dataElementConstraints[].//.allowedShapesarray
apps[].visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

apps[].visualizations[].dataElementConstraints[].//.description*string
apps[].visualizations[].dataElementDependencyOrderarray
apps[].visualizations[].dataElementDependencyOrder[]array
apps[].visualizations[].dataElementDependencyOrder[][]string

post /apps/standalone-map/visualizations/map-markers

 

Returns data required to make Standalone Map markers

curl -X POST \
@@ -1339,10 +1339,10 @@
   undefined/apps/differentialabundance/visualizations/volcanoplot

Request Body chevron_right expand_more

DifferentialAbundanceVolcanoplotPostRequest DifferentialAbundanceVolcanoplotPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

computeConfig.comparator.variable*object

Inherits: object

computeConfig.comparator.variable.entityId*string
computeConfig.comparator.variable.variableId*string
computeConfig.comparator.groupA*array
computeConfig.comparator.groupA[]object

Inherits: lib.Range

computeConfig.comparator.groupA[].min*string
computeConfig.comparator.groupA[].max*string
computeConfig.comparator.groupA[].label*string
computeConfig.comparator.groupB*array
computeConfig.comparator.groupB[]object

Inherits: lib.Range

computeConfig.comparator.groupB[].min*string
computeConfig.comparator.groupB[].max*string
computeConfig.comparator.groupB[].label*string
computeConfig.differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

computeConfig.pValueFloorstring
config*object

Inherits: lib.EmptyDataPluginSpec

200 OK chevron_right expand_more

DifferentialAbundanceStatsResponse DifferentialAbundanceStatsResponse

application/json

Additional properties: Yes

Inherits: object

ParameterTypeDescription
effectSizeLabel*string
statistics*object

Additional properties: Yes

Inherits: object

statistics.effectSize*array
statistics.effectSize[]string
statistics.pValue*array
statistics.pValue[]string
statistics.adjustedPValue*array
statistics.adjustedPValue[]string
statistics.pointId*array
statistics.pointId[]string
pvalueFloorstring
adjustedPValueFloorstring

post /apps/correlationassayassay/visualizations/bipartitenetwork

 

Returns data required to create a bipartite network from a correlation matrix.

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
-  undefined/apps/correlationassayassay/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

BipartiteNetworkPostResponse BipartiteNetworkPostResponse

application/json

Inherits: object

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

post /apps/correlationassaymetadata/visualizations/bipartitenetwork

 

Returns data required to create a bipartite network from a correlation matrix.

curl -X POST \
+  undefined/apps/correlationassayassay/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse

application/json

ParameterTypeDescription
bipartitenetwork*object

Inherits: lib.BipartiteNetwork

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: lib.LinkData

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string
significanceThreshold*number
correlationCoefThreshold*number

post /apps/correlationassaymetadata/visualizations/bipartitenetwork

 

Returns data required to create a bipartite network from a correlation matrix.

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
-  undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

BipartiteNetworkPostResponse BipartiteNetworkPostResponse

application/json

Inherits: object

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

post /apps/distributions/visualizations/histogram

 

Returns data required to create a histogram visualization.
Java impl- NA
R impl- working

curl -X POST \
+  undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse

application/json

ParameterTypeDescription
bipartitenetwork*object

Inherits: lib.BipartiteNetwork

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: lib.LinkData

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string
significanceThreshold*number
correlationCoefThreshold*number

post /apps/distributions/visualizations/histogram

 

Returns data required to create a histogram visualization.
Java impl- NA
R impl- working

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
   undefined/apps/distributions/visualizations/histogram

Request Body chevron_right expand_more

HistogramPostRequest HistogramPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HistogramSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

200 OK chevron_right expand_more

HistogramPostResponse HistogramPostResponse

application/json

Inherits: object

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: lib.HistogramData

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.config*object

Inherits: lib.PlotConfig

histogram.config.completeCasesAllVars*number
histogram.config.completeCasesAxesVars*number
histogram.config.variables*array
histogram.config.variables[]object

Inherits: object

histogram.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.config.variables[].variableSpec.entityId*string
histogram.config.variables[].variableSpec.variableId*string
histogram.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.config.variables[].displayNamestring
histogram.config.variables[].displayRangeMinany
histogram.config.variables[].displayRangeMaxany
histogram.config.variables[].vocabularyarray
histogram.config.variables[].vocabulary[]string
histogram.config.variables[].imputeZero*boolean
histogram.config.variables[].hasStudyDependentVocabularyboolean
histogram.config.variables[].isCollection*boolean
histogram.config.variables[].membersarray
histogram.config.variables[].members[]object

Inherits: lib.VariableSpec

histogram.config.variables[].members[].entityId*string
histogram.config.variables[].members[].variableId*string
histogram.config.binSlider*object

Inherits: lib.BinSlider

histogram.config.binSlider.min*number
histogram.config.binSlider.max*number
histogram.config.binSlider.step*number
histogram.config.binSpec*object

Inherits: lib.BinSpec

histogram.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
histogram.config.binSpec.valuenumber
histogram.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

histogram.config.binSpec.rangeunion
histogram.config.binSpec.rangeanyOf
Any of the following types.
histogram.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

histogram.config.binSpec.range{NumberRange}..min*number
histogram.config.binSpec.range{NumberRange}..max*number
histogram.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

histogram.config.binSpec.range{DateRange}..min*string
histogram.config.binSpec.range{DateRange}..max*string
histogram.config.summary*object

Additional properties: Yes

Inherits: object

histogram.config.summary.min*string
histogram.config.summary.q1*string
histogram.config.summary.median*string
histogram.config.summary.mean*string
histogram.config.summary.q3*string
histogram.config.summary.max*string
histogram.config.viewport*object

Inherits: lib.NumericViewport

histogram.config.viewport.xMin*string
histogram.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

post /apps/distributions/visualizations/boxplot

 

Returns data required to create a boxplot visualization
Java impl- NA
R impl- working

curl -X POST \
@@ -1387,7 +1387,7 @@
 }

get /metrics

 

Prometheus metrics for the service.

curl -X GET \
   undefined/metrics

200 OK chevron_right expand_more

text/plain

text/plain

Security Schemes

Security Scheme header-auth

header-auth

Authentication based on a WDK auth cookie.

Headers chevron_right expand_more

ParameterTypeDescription
Auth_Key*string

Authorization header.

curl -X <method> \
   -H "Auth_Key: <value>" \
-  /<path>

Types

Type VariableClass (string)

VariableClass
Enum:
  • native
  • derived
  • computed

Inherits: string

Type PlotReferenceValue (string)

PlotReferenceValue
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

Type VariableMapping (object)

VariableMapping

Inherits: object

Model

ParameterTypeDescription
variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variableSpec*object

Inherits: lib.VariableSpec

variableSpec.entityId*string
variableSpec.variableId*string
plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

displayNamestring
displayRangeMinany
displayRangeMaxany
vocabularyarray
vocabulary[]string
imputeZero*boolean
hasStudyDependentVocabularyboolean
isCollection*boolean
membersarray
members[]object

Inherits: lib.VariableSpec

members[].entityId*string
members[].variableId*string

Type API_Filter (object)

API_Filter

Additional properties: Yes

Discriminator: type

Inherits: object

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

Type API_FilterType (string)

API_FilterType
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: string

Type API_BooleanOperationType (string)

API_BooleanOperationType
Enum:
  • intersect
  • union

Inherits: string

Type API_MultiFilterSubFilter (object)

API_MultiFilterSubFilter

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
stringSet*array
stringSet[]string

Type API_MultiFilter (object)

API_MultiFilter

Additional properties: Yes

Discriminator: type

Discriminator value: multiFilter

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

operation*string
Enum:
  • intersect
  • union

Inherits: string

variableId*string
subFilters*array
subFilters[]object

Additional properties: Yes

Inherits: object

subFilters[].variableId*string
subFilters[].stringSet*array
subFilters[].stringSet[]string

Type API_StringSetFilter (object)

API_StringSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: stringSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
stringSet*array
stringSet[]string

Type API_NumberSetFilter (object)

API_NumberSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
numberSet*array
numberSet[]number

Type API_DateSetFilter (object)

API_DateSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
dateSet*array
dateSet[]string

Type API_NumberRangeFilter (object)

API_NumberRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*number
max*number

Type API_DateRangeFilter (object)

API_DateRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*string
max*string

Type API_LongitudeRangeFilter (object)

API_LongitudeRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: longitudeRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
left*number
right*number

Type DerivedVariableSpec (object)

DerivedVariableSpec

Model

ParameterTypeDescription
entityId*string
variableId*string
functionName*string
displayName*string
config*object

Type VariableSpec (object)

VariableSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
variableId*string

Type CollectionSpec (object)

CollectionSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
collectionId*string

Type DataElementConstraint (object)

DataElementConstraint

Inherits: object

Model

ParameterTypeDescription
isRequired*boolean
isTemporal*boolean
isCollection*boolean
isCompositional*boolean
isProportion*boolean
allowedNormalizationMethods*array
allowedNormalizationMethods[]string
minNumVars*number
maxNumVars*number
minNumValues*number
maxNumValues*number
allowedTypesarray
allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

allowedShapesarray
allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

description*string

Type DataElementConstraintPattern (object)

DataElementConstraintPattern

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
//*object

Inherits: object

//.isRequired*boolean
//.isTemporal*boolean
//.isCollection*boolean
//.isCompositional*boolean
//.isProportion*boolean
//.allowedNormalizationMethods*array
//.allowedNormalizationMethods[]string
//.minNumVars*number
//.maxNumVars*number
//.minNumValues*number
//.maxNumValues*number
//.allowedTypesarray
//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

//.allowedShapesarray
//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

//.description*string

Type EntityTabularPostResponse (object)

EntityTabularPostResponse

Inherits: object

Model

ParameterTypeDescription
tabular*array
tabular[]array
tabular[][]string

Type Range (object)

Range

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type LabeledRange (object)

LabeledRange

Inherits: lib.Range

Model

ParameterTypeDescription
min*string
max*string
label*string

Type API_VariableType (string)

API_VariableType
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: string

Type API_VariableDataShape (string)

API_VariableDataShape
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: string

Type API_PagingConfig (object)

API_PagingConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
numRowsinteger

Format: int64

offsetinteger

Format: int64

Type BinUnits (string)

BinUnits
Enum:
  • day
  • week
  • month
  • year

Inherits: string

Type ValueSpec (string)

ValueSpec
Enum:
  • count
  • proportion

Inherits: string

Type AlphaDivComputeConfig (object)

AlphaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

Type AlphaDivMethod (string)

AlphaDivMethod
Enum:
  • shannon
  • simpson
  • evenness

Inherits: string

Type BetaDivComputeConfig (object)

BetaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

Type BetaDivDissimilarityMethod (string)

BetaDivDissimilarityMethod
Enum:
  • bray
  • jaccard
  • jsd

Inherits: string

Type CorrelationComputeConfig (object)

CorrelationComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

Type CorrelationMethod (string)

CorrelationMethod
Enum:
  • spearman
  • pearson

Inherits: string

Type Correlation1Collection (object)

Correlation1Collection

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string

Type Correlation2Collections (object)

Correlation2Collections

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable1*object

Inherits: object

collectionVariable1.entityId*string
collectionVariable1.collectionId*string
collectionVariable2*object

Inherits: object

collectionVariable2.entityId*string
collectionVariable2.collectionId*string

Type DifferentialAbundanceComputeConfig (object)

DifferentialAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

comparator.variable*object

Inherits: object

comparator.variable.entityId*string
comparator.variable.variableId*string
comparator.groupA*array
comparator.groupA[]object

Inherits: lib.Range

comparator.groupA[].min*string
comparator.groupA[].max*string
comparator.groupA[].label*string
comparator.groupB*array
comparator.groupB[]object

Inherits: lib.Range

comparator.groupB[].min*string
comparator.groupB[].max*string
comparator.groupB[].label*string
differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

pValueFloorstring

Type DifferentialAbundanceMethod (string)

DifferentialAbundanceMethod
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: string

Type ComparatorSpec (object)

ComparatorSpec

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
groupA*array
groupA[]object

Inherits: lib.Range

groupA[].min*string
groupA[].max*string
groupA[].label*string
groupB*array
groupB[]object

Inherits: lib.Range

groupB[].min*string
groupB[].max*string
groupB[].label*string

Type DifferentialAbundanceStats (object)

DifferentialAbundanceStats

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSize*array
effectSize[]string
pValue*array
pValue[]string
adjustedPValue*array
adjustedPValue[]string
pointId*array
pointId[]string

Type DifferentialAbundanceStatsResponse (object)

DifferentialAbundanceStatsResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSizeLabel*string
statistics*object

Additional properties: Yes

Inherits: object

statistics.effectSize*array
statistics.effectSize[]string
statistics.pValue*array
statistics.pValue[]string
statistics.adjustedPValue*array
statistics.adjustedPValue[]string
statistics.pointId*array
statistics.pointId[]string
pvalueFloorstring
adjustedPValueFloorstring

Type ExampleComputeConfig (object)

ExampleComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
inputVariable*object

Inherits: object

inputVariable.entityId*string
inputVariable.variableId*string
valueSuffix*string

Type RankedAbundanceComputeConfig (object)

RankedAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

Type RankingMethod (string)

RankingMethod
Enum:
  • median
  • q3
  • variance
  • max

Inherits: string

Type AbundanceBoxplotPostRequest (object)

AbundanceBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AbundanceScatterplotPostRequest (object)

AbundanceScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivBoxplotPostRequest (object)

AlphaDivBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivScatterplotPostRequest (object)

AlphaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AppsGetResponse (object)

AppsGetResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
apps*array
apps[]object

Inherits: lib.AppOverview

apps[].name*string
apps[].displayName*string
apps[].description*string
apps[].projects*array
apps[].projects[]string
apps[].computeNamestring
apps[].visualizations*array
apps[].visualizations[]object

Inherits: lib.VisualizationOverview

apps[].visualizations[].name*string
apps[].visualizations[].displayName*string
apps[].visualizations[].description*string
apps[].visualizations[].projects*array
apps[].visualizations[].projects[]string
apps[].visualizations[].maxPanels*number
apps[].visualizations[].dataElementConstraintsarray
apps[].visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

apps[].visualizations[].dataElementConstraints[].//*object

Inherits: object

apps[].visualizations[].dataElementConstraints[].//.isRequired*boolean
apps[].visualizations[].dataElementConstraints[].//.isTemporal*boolean
apps[].visualizations[].dataElementConstraints[].//.isCollection*boolean
apps[].visualizations[].dataElementConstraints[].//.isCompositional*boolean
apps[].visualizations[].dataElementConstraints[].//.isProportion*boolean
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
apps[].visualizations[].dataElementConstraints[].//.minNumVars*number
apps[].visualizations[].dataElementConstraints[].//.maxNumVars*number
apps[].visualizations[].dataElementConstraints[].//.minNumValues*number
apps[].visualizations[].dataElementConstraints[].//.maxNumValues*number
apps[].visualizations[].dataElementConstraints[].//.allowedTypesarray
apps[].visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

apps[].visualizations[].dataElementConstraints[].//.allowedShapesarray
apps[].visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

apps[].visualizations[].dataElementConstraints[].//.description*string
apps[].visualizations[].dataElementDependencyOrderarray
apps[].visualizations[].dataElementDependencyOrder[]array
apps[].visualizations[].dataElementDependencyOrder[][]string

Type AppOverview (object)

AppOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
computeNamestring
visualizations*array
visualizations[]object

Inherits: lib.VisualizationOverview

visualizations[].name*string
visualizations[].displayName*string
visualizations[].description*string
visualizations[].projects*array
visualizations[].projects[]string
visualizations[].maxPanels*number
visualizations[].dataElementConstraintsarray
visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

visualizations[].dataElementConstraints[].//*object

Inherits: object

visualizations[].dataElementConstraints[].//.isRequired*boolean
visualizations[].dataElementConstraints[].//.isTemporal*boolean
visualizations[].dataElementConstraints[].//.isCollection*boolean
visualizations[].dataElementConstraints[].//.isCompositional*boolean
visualizations[].dataElementConstraints[].//.isProportion*boolean
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
visualizations[].dataElementConstraints[].//.minNumVars*number
visualizations[].dataElementConstraints[].//.maxNumVars*number
visualizations[].dataElementConstraints[].//.minNumValues*number
visualizations[].dataElementConstraints[].//.maxNumValues*number
visualizations[].dataElementConstraints[].//.allowedTypesarray
visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

visualizations[].dataElementConstraints[].//.allowedShapesarray
visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

visualizations[].dataElementConstraints[].//.description*string
visualizations[].dataElementDependencyOrderarray
visualizations[].dataElementDependencyOrder[]array
visualizations[].dataElementDependencyOrder[][]string

Type VisualizationOverview (object)

VisualizationOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
maxPanels*number
dataElementConstraintsarray
dataElementConstraints[]object

Additional properties: Yes

Inherits: object

dataElementConstraints[].//*object

Inherits: object

dataElementConstraints[].//.isRequired*boolean
dataElementConstraints[].//.isTemporal*boolean
dataElementConstraints[].//.isCollection*boolean
dataElementConstraints[].//.isCompositional*boolean
dataElementConstraints[].//.isProportion*boolean
dataElementConstraints[].//.allowedNormalizationMethods*array
dataElementConstraints[].//.allowedNormalizationMethods[]string
dataElementConstraints[].//.minNumVars*number
dataElementConstraints[].//.maxNumVars*number
dataElementConstraints[].//.minNumValues*number
dataElementConstraints[].//.maxNumValues*number
dataElementConstraints[].//.allowedTypesarray
dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataElementConstraints[].//.allowedShapesarray
dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

dataElementConstraints[].//.description*string
dataElementDependencyOrderarray
dataElementDependencyOrder[]array
dataElementDependencyOrder[][]string

Type BetaDivScatterplotPostRequest (object)

BetaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

config*object

Inherits: lib.BetaDivScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string

Type BetaDivScatterplotSpec (object)

BetaDivScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type CorrelationBipartitenetworkSpec (object)

CorrelationBipartitenetworkSpec

Inherits: object

Model

ParameterTypeDescription
significanceThresholdnumber
correlationCoefThresholdnumber

Type CorrelationAssayAssayBipartitenetworkPostRequest (object)

CorrelationAssayAssayBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)

CorrelationAssayMetadataBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type DifferentialAbundanceVolcanoplotPostRequest (object)

DifferentialAbundanceVolcanoplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

computeConfig.comparator.variable*object

Inherits: object

computeConfig.comparator.variable.entityId*string
computeConfig.comparator.variable.variableId*string
computeConfig.comparator.groupA*array
computeConfig.comparator.groupA[]object

Inherits: lib.Range

computeConfig.comparator.groupA[].min*string
computeConfig.comparator.groupA[].max*string
computeConfig.comparator.groupA[].label*string
computeConfig.comparator.groupB*array
computeConfig.comparator.groupB[]object

Inherits: lib.Range

computeConfig.comparator.groupB[].min*string
computeConfig.comparator.groupB[].max*string
computeConfig.comparator.groupB[].label*string
computeConfig.differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

computeConfig.pValueFloorstring
config*object

Inherits: lib.EmptyDataPluginSpec

Type ContinuousVariableMetadataPostRequest (object)

ContinuousVariableMetadataPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ContinuousVariableMetadataSpec

config.variable*object

Inherits: object

config.variable.entityId*string
config.variable.variableId*string
config.metadata*array
config.metadata[]string
Enum:
  • binRanges
  • median

Type ContinuousVariableMetadataSpec (object)

ContinuousVariableMetadataSpec

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
metadata*array
metadata[]string
Enum:
  • binRanges
  • median

Type AllBinRanges (object)

AllBinRanges

Inherits: object

Model

ParameterTypeDescription
equalInterval*array
equalInterval[]object

Inherits: lib.Range

equalInterval[].min*string
equalInterval[].max*string
equalInterval[].label*string
quantile*array
quantile[]object

Inherits: lib.Range

quantile[].min*string
quantile[].max*string
quantile[].label*string
standardDeviation*array
standardDeviation[]object

Inherits: lib.Range

standardDeviation[].min*string
standardDeviation[].max*string
standardDeviation[].label*string

Type ContinuousVariableMetadataPostResponse (object)

ContinuousVariableMetadataPostResponse

Inherits: object

Model

ParameterTypeDescription
binRangesobject

Inherits: object

binRanges.equalInterval*array
binRanges.equalInterval[]object

Inherits: lib.Range

binRanges.equalInterval[].min*string
binRanges.equalInterval[].max*string
binRanges.equalInterval[].label*string
binRanges.quantile*array
binRanges.quantile[]object

Inherits: lib.Range

binRanges.quantile[].min*string
binRanges.quantile[].max*string
binRanges.quantile[].label*string
binRanges.standardDeviation*array
binRanges.standardDeviation[]object

Inherits: lib.Range

binRanges.standardDeviation[].min*string
binRanges.standardDeviation[].max*string
binRanges.standardDeviation[].label*string
mediannumber

Type NodeData (object)

NodeData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
id*string

Type LinkData (object)

LinkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
source*object

Additional properties: Yes

Inherits: object

source.id*string
target*object

Additional properties: Yes

Inherits: object

target.id*string
strokeWidth*string
color*string

Type NetworkData (object)

NetworkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string

Type NetworkConfig (object)

NetworkConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type BipartiteNetworkConfig (object)

BipartiteNetworkConfig

Additional properties: Yes

Inherits: lib.NetworkConfig

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
column1Metadata*string
column2Metadata*string

Type BipartiteNetworkData (object)

BipartiteNetworkData

Additional properties: Yes

Inherits: lib.NetworkData

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string
column1NodeIDs*array
column1NodeIDs[]string
column2NodeIDs*array
column2NodeIDs[]string

Type BipartiteNetwork (object)

BipartiteNetwork

Inherits: object

Model

ParameterTypeDescription
data*object

Additional properties: Yes

Inherits: lib.NetworkData

data.nodes*array
data.nodes[]object

Additional properties: Yes

Inherits: object

data.nodes[].id*string
data.links*array
data.links[]object

Additional properties: Yes

Inherits: object

data.links[].source*object

Additional properties: Yes

Inherits: object

data.links[].source.id*string
data.links[].target*object

Additional properties: Yes

Inherits: object

data.links[].target.id*string
data.links[].strokeWidth*string
data.links[].color*string
data.column1NodeIDs*array
data.column1NodeIDs[]string
data.column2NodeIDs*array
data.column2NodeIDs[]string
config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

config.variablesarray
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.column1Metadata*string
config.column2Metadata*string

Type BipartiteNetworkPostResponse (object)

BipartiteNetworkPostResponse

Inherits: object

Model

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

Type BarplotPostRequest (object)

BarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BarplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type BarplotSpec (object)

BarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Barplot (object)

Barplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BarplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BarplotPostResponse (object)

BarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: lib.BarplotData

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.config*object

Inherits: lib.PlotConfig

barplot.config.completeCasesAllVars*number
barplot.config.completeCasesAxesVars*number
barplot.config.variables*array
barplot.config.variables[]object

Inherits: object

barplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.config.variables[].variableSpec.entityId*string
barplot.config.variables[].variableSpec.variableId*string
barplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.config.variables[].displayNamestring
barplot.config.variables[].displayRangeMinany
barplot.config.variables[].displayRangeMaxany
barplot.config.variables[].vocabularyarray
barplot.config.variables[].vocabulary[]string
barplot.config.variables[].imputeZero*boolean
barplot.config.variables[].hasStudyDependentVocabularyboolean
barplot.config.variables[].isCollection*boolean
barplot.config.variables[].membersarray
barplot.config.variables[].members[]object

Inherits: lib.VariableSpec

barplot.config.variables[].members[].entityId*string
barplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BoxplotPostRequest (object)

BoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BoxplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type BoxplotSpec (object)

BoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Boxplot (object)

Boxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BoxplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BoxplotPostResponse (object)

BoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: lib.BoxplotData

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.config*object

Inherits: lib.PlotConfig

boxplot.config.completeCasesAllVars*number
boxplot.config.completeCasesAxesVars*number
boxplot.config.variables*array
boxplot.config.variables[]object

Inherits: object

boxplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.config.variables[].variableSpec.entityId*string
boxplot.config.variables[].variableSpec.variableId*string
boxplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.config.variables[].displayNamestring
boxplot.config.variables[].displayRangeMinany
boxplot.config.variables[].displayRangeMaxany
boxplot.config.variables[].vocabularyarray
boxplot.config.variables[].vocabulary[]string
boxplot.config.variables[].imputeZero*boolean
boxplot.config.variables[].hasStudyDependentVocabularyboolean
boxplot.config.variables[].isCollection*boolean
boxplot.config.variables[].membersarray
boxplot.config.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.config.variables[].members[].entityId*string
boxplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number
statsTablearray
statsTable[]object

Inherits: lib.BoxplotStatsTable

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].xVariableDetailsobject

Inherits: object

statsTable[].xVariableDetails.entityId*string
statsTable[].xVariableDetails.variableId*string
statsTable[].xVariableDetails.value*string
statsTable[].statistic*string
statsTable[].pvalue*number
statsTable[].parameter*array
statsTable[].parameter[]number
statsTable[].method*string
statsTable[].statsError*string

Type ContTableStatsTable (object)

ContTableStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
pvalue*array
pvalue[]number
degreesFreedom*array
degreesFreedom[]number
chisq*array
chisq[]number

Type ContTablePostResponse (object)

ContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].pvalue*array
statsTable[].pvalue[]number
statsTable[].degreesFreedom*array
statsTable[].degreesFreedom[]number
statsTable[].chisq*array
statsTable[].chisq[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type DensityplotPostRequest (object)

DensityplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.DensityplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type DensityplotSpec (object)

DensityplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Densityplot (object)

Densityplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.DensityplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].densityY*array
data[].densityY[]number
data[].densityX*array
data[].densityX[]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type DensityplotPostResponse (object)

DensityplotPostResponse

Inherits: object

Model

ParameterTypeDescription
densityplot*object

Inherits: object

densityplot.data*array
densityplot.data[]object

Inherits: lib.DensityplotData

densityplot.data[].overlayVariableDetailsobject

Inherits: object

densityplot.data[].overlayVariableDetails.entityId*string
densityplot.data[].overlayVariableDetails.variableId*string
densityplot.data[].overlayVariableDetails.value*string
densityplot.data[].facetVariableDetailsarray

Max. items: 2

densityplot.data[].facetVariableDetails[]object

Inherits: object

densityplot.data[].facetVariableDetails[].entityId*string
densityplot.data[].facetVariableDetails[].variableId*string
densityplot.data[].facetVariableDetails[].value*string
densityplot.data[].densityY*array
densityplot.data[].densityY[]number
densityplot.data[].densityX*array
densityplot.data[].densityX[]number
densityplot.config*object

Inherits: lib.PlotConfig

densityplot.config.completeCasesAllVars*number
densityplot.config.completeCasesAxesVars*number
densityplot.config.variables*array
densityplot.config.variables[]object

Inherits: object

densityplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

densityplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

densityplot.config.variables[].variableSpec.entityId*string
densityplot.config.variables[].variableSpec.variableId*string
densityplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

densityplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

densityplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

densityplot.config.variables[].displayNamestring
densityplot.config.variables[].displayRangeMinany
densityplot.config.variables[].displayRangeMaxany
densityplot.config.variables[].vocabularyarray
densityplot.config.variables[].vocabulary[]string
densityplot.config.variables[].imputeZero*boolean
densityplot.config.variables[].hasStudyDependentVocabularyboolean
densityplot.config.variables[].isCollection*boolean
densityplot.config.variables[].membersarray
densityplot.config.variables[].members[]object

Inherits: lib.VariableSpec

densityplot.config.variables[].members[].entityId*string
densityplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HeatmapPostRequest (object)

HeatmapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HeatmapSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • collection
  • series
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.zAxisVariableobject

Inherits: object

config.zAxisVariable.entityId*string
config.zAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type HeatmapSpec (object)

HeatmapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • collection
  • series
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
zAxisVariableobject

Inherits: object

zAxisVariable.entityId*string
zAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Heatmap (object)

Heatmap

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HeatmapData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]array
data[].value[][]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type HeatmapPostResponse (object)

HeatmapPostResponse

Inherits: object

Model

ParameterTypeDescription
heatmap*object

Inherits: object

heatmap.data*array
heatmap.data[]object

Inherits: lib.HeatmapData

heatmap.data[].facetVariableDetailsarray

Max. items: 2

heatmap.data[].facetVariableDetails[]object

Inherits: object

heatmap.data[].facetVariableDetails[].entityId*string
heatmap.data[].facetVariableDetails[].variableId*string
heatmap.data[].facetVariableDetails[].value*string
heatmap.data[].value*array
heatmap.data[].value[]array
heatmap.data[].value[][]number
heatmap.data[].label*array
heatmap.data[].label[]string
heatmap.config*object

Inherits: lib.PlotConfig

heatmap.config.completeCasesAllVars*number
heatmap.config.completeCasesAxesVars*number
heatmap.config.variables*array
heatmap.config.variables[]object

Inherits: object

heatmap.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

heatmap.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

heatmap.config.variables[].variableSpec.entityId*string
heatmap.config.variables[].variableSpec.variableId*string
heatmap.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

heatmap.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

heatmap.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

heatmap.config.variables[].displayNamestring
heatmap.config.variables[].displayRangeMinany
heatmap.config.variables[].displayRangeMaxany
heatmap.config.variables[].vocabularyarray
heatmap.config.variables[].vocabulary[]string
heatmap.config.variables[].imputeZero*boolean
heatmap.config.variables[].hasStudyDependentVocabularyboolean
heatmap.config.variables[].isCollection*boolean
heatmap.config.variables[].membersarray
heatmap.config.variables[].members[]object

Inherits: lib.VariableSpec

heatmap.config.variables[].members[].entityId*string
heatmap.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HistogramPostRequest (object)

HistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HistogramSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramSpec (object)

HistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type HistogramSummary (object)

HistogramSummary

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
min*string
q1*string
median*string
mean*string
q3*string
max*string

Type HistogramConfig (object)

HistogramConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSlider*object

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
summary*object

Additional properties: Yes

Inherits: object

summary.min*string
summary.q1*string
summary.median*string
summary.mean*string
summary.q3*string
summary.max*string
viewport*object

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Histogram (object)

Histogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HistogramData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSlider*object

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.summary*object

Additional properties: Yes

Inherits: object

config.summary.min*string
config.summary.q1*string
config.summary.median*string
config.summary.mean*string
config.summary.q3*string
config.summary.max*string
config.viewport*object

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramPostResponse (object)

HistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: lib.HistogramData

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.config*object

Inherits: lib.PlotConfig

histogram.config.completeCasesAllVars*number
histogram.config.completeCasesAxesVars*number
histogram.config.variables*array
histogram.config.variables[]object

Inherits: object

histogram.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.config.variables[].variableSpec.entityId*string
histogram.config.variables[].variableSpec.variableId*string
histogram.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.config.variables[].displayNamestring
histogram.config.variables[].displayRangeMinany
histogram.config.variables[].displayRangeMaxany
histogram.config.variables[].vocabularyarray
histogram.config.variables[].vocabulary[]string
histogram.config.variables[].imputeZero*boolean
histogram.config.variables[].hasStudyDependentVocabularyboolean
histogram.config.variables[].isCollection*boolean
histogram.config.variables[].membersarray
histogram.config.variables[].members[]object

Inherits: lib.VariableSpec

histogram.config.variables[].members[].entityId*string
histogram.config.variables[].members[].variableId*string
histogram.config.binSlider*object

Inherits: lib.BinSlider

histogram.config.binSlider.min*number
histogram.config.binSlider.max*number
histogram.config.binSlider.step*number
histogram.config.binSpec*object

Inherits: lib.BinSpec

histogram.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
histogram.config.binSpec.valuenumber
histogram.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

histogram.config.binSpec.rangeunion
histogram.config.binSpec.rangeanyOf
Any of the following types.
histogram.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

histogram.config.binSpec.range{NumberRange}..min*number
histogram.config.binSpec.range{NumberRange}..max*number
histogram.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

histogram.config.binSpec.range{DateRange}..min*string
histogram.config.binSpec.range{DateRange}..max*string
histogram.config.summary*object

Additional properties: Yes

Inherits: object

histogram.config.summary.min*string
histogram.config.summary.q1*string
histogram.config.summary.median*string
histogram.config.summary.mean*string
histogram.config.summary.q3*string
histogram.config.summary.max*string
histogram.config.viewport*object

Inherits: lib.NumericViewport

histogram.config.viewport.xMin*string
histogram.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type LineplotPostRequest (object)

LineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.LineplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotSpec (object)

LineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type LineplotConfig (object)

LineplotConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSliderobject

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Lineplot (object)

Lineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.LineplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSliderobject

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotPostResponse (object)

LineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: lib.LineplotData

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.config*object

Inherits: lib.PlotConfig

lineplot.config.completeCasesAllVars*number
lineplot.config.completeCasesAxesVars*number
lineplot.config.variables*array
lineplot.config.variables[]object

Inherits: object

lineplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.config.variables[].variableSpec.entityId*string
lineplot.config.variables[].variableSpec.variableId*string
lineplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.config.variables[].displayNamestring
lineplot.config.variables[].displayRangeMinany
lineplot.config.variables[].displayRangeMaxany
lineplot.config.variables[].vocabularyarray
lineplot.config.variables[].vocabulary[]string
lineplot.config.variables[].imputeZero*boolean
lineplot.config.variables[].hasStudyDependentVocabularyboolean
lineplot.config.variables[].isCollection*boolean
lineplot.config.variables[].membersarray
lineplot.config.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.config.variables[].members[].entityId*string
lineplot.config.variables[].members[].variableId*string
lineplot.config.binSliderobject

Inherits: lib.BinSlider

lineplot.config.binSlider.min*number
lineplot.config.binSlider.max*number
lineplot.config.binSlider.step*number
lineplot.config.binSpecobject

Inherits: lib.BinSpec

lineplot.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
lineplot.config.binSpec.valuenumber
lineplot.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

lineplot.config.binSpec.rangeunion
lineplot.config.binSpec.rangeanyOf
Any of the following types.
lineplot.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

lineplot.config.binSpec.range{NumberRange}..min*number
lineplot.config.binSpec.range{NumberRange}..max*number
lineplot.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

lineplot.config.binSpec.range{DateRange}..min*string
lineplot.config.binSpec.range{DateRange}..max*string
lineplot.config.viewportobject

Inherits: lib.NumericViewport

lineplot.config.viewport.xMin*string
lineplot.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapMarkersOverlayPostRequest (object)

MapMarkersOverlayPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapMarkersOverlaySpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.longitudeVariableobject

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariableobject

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewportobject

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlaySpec (object)

MapMarkersOverlaySpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

longitudeVariableobject

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariableobject

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewportobject

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlayConfig (object)

MapMarkersOverlayConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlay (object)

MapMarkersOverlay

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.MapMarkersOverlayData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlayPostResponse (object)

MapMarkersOverlayPostResponse

Inherits: object

Model

ParameterTypeDescription
mapMarkers*object

Inherits: object

mapMarkers.data*array
mapMarkers.data[]object

Inherits: lib.MapMarkersOverlayData

mapMarkers.data[].facetVariableDetailsarray

Max. items: 2

mapMarkers.data[].facetVariableDetails[]object

Inherits: object

mapMarkers.data[].facetVariableDetails[].entityId*string
mapMarkers.data[].facetVariableDetails[].variableId*string
mapMarkers.data[].facetVariableDetails[].value*string
mapMarkers.data[].value*array
mapMarkers.data[].value[]number
mapMarkers.data[].label*array
mapMarkers.data[].label[]string
mapMarkers.config*object

Inherits: lib.PlotConfig

mapMarkers.config.completeCasesAllVars*number
mapMarkers.config.completeCasesAxesVars*number
mapMarkers.config.variables*array
mapMarkers.config.variables[]object

Inherits: object

mapMarkers.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mapMarkers.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].variableSpec.entityId*string
mapMarkers.config.variables[].variableSpec.variableId*string
mapMarkers.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mapMarkers.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mapMarkers.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mapMarkers.config.variables[].displayNamestring
mapMarkers.config.variables[].displayRangeMinany
mapMarkers.config.variables[].displayRangeMaxany
mapMarkers.config.variables[].vocabularyarray
mapMarkers.config.variables[].vocabulary[]string
mapMarkers.config.variables[].imputeZero*boolean
mapMarkers.config.variables[].hasStudyDependentVocabularyboolean
mapMarkers.config.variables[].isCollection*boolean
mapMarkers.config.variables[].membersarray
mapMarkers.config.variables[].members[]object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].members[].entityId*string
mapMarkers.config.variables[].members[].variableId*string
mapMarkers.config.viewport*object

Inherits: lib.GeolocationViewport

mapMarkers.config.viewport.latitude*object

Inherits: lib.NumericViewport

mapMarkers.config.viewport.latitude.xMin*string
mapMarkers.config.viewport.latitude.xMax*string
mapMarkers.config.viewport.longitude*object

Inherits: lib.LongitudeViewport

mapMarkers.config.viewport.longitude.left*number
mapMarkers.config.viewport.longitude.right*number
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapPostRequest (object)

MapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapSpec (object)

MapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapConfig (object)

MapConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesGeoVar*number

Type MapPostResponse (object)

MapPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.MapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number
config*object

Inherits: object

config.completeCasesGeoVar*number

Type MapElementInfo (object)

MapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type ScatterplotPostRequest (object)

ScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type ScatterplotSpec (object)

ScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Scatterplot (object)

Scatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.ScatterplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotPostResponse (object)

ScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: lib.ScatterplotData

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.config*object

Inherits: lib.PlotConfig

scatterplot.config.completeCasesAllVars*number
scatterplot.config.completeCasesAxesVars*number
scatterplot.config.variables*array
scatterplot.config.variables[]object

Inherits: object

scatterplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.config.variables[].variableSpec.entityId*string
scatterplot.config.variables[].variableSpec.variableId*string
scatterplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.config.variables[].displayNamestring
scatterplot.config.variables[].displayRangeMinany
scatterplot.config.variables[].displayRangeMaxany
scatterplot.config.variables[].vocabularyarray
scatterplot.config.variables[].vocabulary[]string
scatterplot.config.variables[].imputeZero*boolean
scatterplot.config.variables[].hasStudyDependentVocabularyboolean
scatterplot.config.variables[].isCollection*boolean
scatterplot.config.variables[].membersarray
scatterplot.config.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.config.variables[].members[].entityId*string
scatterplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type TablePostRequest (object)

TablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.TableSpec

config.outputEntityId*string
config.outputVariable*array
config.outputVariable[]object

Inherits: object

config.outputVariable[].entityId*string
config.outputVariable[].variableId*string
config.pagingConfig*object

Additional properties: Yes

Inherits: object

config.pagingConfig.numRowsinteger

Format: int64

config.pagingConfig.offsetinteger

Format: int64

Type TableSpec (object)

TableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
outputVariable*array
outputVariable[]object

Inherits: object

outputVariable[].entityId*string
outputVariable[].variableId*string
pagingConfig*object

Additional properties: Yes

Inherits: object

pagingConfig.numRowsinteger

Format: int64

pagingConfig.offsetinteger

Format: int64

Type TablePostResponse (object)

TablePostResponse

Inherits: object

Model

ParameterTypeDescription
columns*array
columns[]object

Inherits: object

columns[].entityId*string
columns[].variableId*string
rows*array
rows[]array
rows[][]string

Type TwoByTwoSpec (object)

TwoByTwoSpec

Inherits: lib.MosaicSpec

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
xAxisReferenceValue*string
yAxisReferenceValue*string

Type TwoByTwoPostRequest (object)

TwoByTwoPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.xAxisReferenceValue*string
config.yAxisReferenceValue*string

Type Statistic (object)

Statistic

Inherits: object

Model

ParameterTypeDescription
value*number
confidenceIntervalstring
confidenceLevelnumber
pvalue*string

Type TwoByTwoStatsTable (object)

TwoByTwoStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
chisq*object

Inherits: object

chisq.value*number
chisq.confidenceIntervalstring
chisq.confidenceLevelnumber
chisq.pvalue*string
fisher*object

Inherits: object

fisher.value*number
fisher.confidenceIntervalstring
fisher.confidenceLevelnumber
fisher.pvalue*string
prevalenceobject

Inherits: object

prevalence.value*number
prevalence.confidenceIntervalstring
prevalence.confidenceLevelnumber
prevalence.pvalue*string
oddsratioobject

Inherits: object

oddsratio.value*number
oddsratio.confidenceIntervalstring
oddsratio.confidenceLevelnumber
oddsratio.pvalue*string
relativeriskobject

Inherits: object

relativerisk.value*number
relativerisk.confidenceIntervalstring
relativerisk.confidenceLevelnumber
relativerisk.pvalue*string
sensitivityobject

Inherits: object

sensitivity.value*number
sensitivity.confidenceIntervalstring
sensitivity.confidenceLevelnumber
sensitivity.pvalue*string
specificityobject

Inherits: object

specificity.value*number
specificity.confidenceIntervalstring
specificity.confidenceLevelnumber
specificity.pvalue*string
posPredictiveValueobject

Inherits: object

posPredictiveValue.value*number
posPredictiveValue.confidenceIntervalstring
posPredictiveValue.confidenceLevelnumber
posPredictiveValue.pvalue*string
negPredictiveValueobject

Inherits: object

negPredictiveValue.value*number
negPredictiveValue.confidenceIntervalstring
negPredictiveValue.confidenceLevelnumber
negPredictiveValue.pvalue*string

Type TwoByTwoPostResponse (object)

TwoByTwoPostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BarplotData (object)

BarplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type MapMarkersOverlayData (object)

MapMarkersOverlayData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type BoxplotData (object)

BoxplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
lowerfence*array
lowerfence[]number
upperfence*array
upperfence[]number
q1*array
q1[]number
q3*array
q3[]number
median*array
median[]number
outliersarray
outliers[]array
outliers[][]number
rawDataarray
rawData[]array
rawData[][]number
meanarray
mean[]number
label*array
label[]string

Type BoxplotStatsTable (object)

BoxplotStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xVariableDetailsobject

Inherits: object

xVariableDetails.entityId*string
xVariableDetails.variableId*string
xVariableDetails.value*string
statistic*string
pvalue*number
parameter*array
parameter[]number
method*string
statsError*string

Type HistogramData (object)

HistogramData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
binStart*array
binStart[]string
binEnd*array
binEnd[]string
binLabel*array
binLabel[]string

Type BinSlider (object)

BinSlider

Inherits: object

Model

ParameterTypeDescription
min*number
max*number
step*number

Type HeatmapData (object)

HeatmapData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]array
value[][]number
label*array
label[]string

Type MosaicPostRequest (object)

MosaicPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type MosaicSpec (object)

MosaicSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type MosaicData (object)

MosaicData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xLabel*array
xLabel[]string
yLabel*array
yLabel[]array
yLabel[][]string
value*array
value[]array
value[][]number

Type Mosaic (object)

Mosaic

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotData (object)

ScatterplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
smoothedMeanXarray
smoothedMeanX[]string
smoothedMeanYarray
smoothedMeanY[]number
smoothedMeanSEarray
smoothedMeanSE[]number
smoothedMeanErrorstring
bestFitLineXarray
bestFitLineX[]string
bestFitLineYarray
bestFitLineY[]number
r2number

Type DensityplotData (object)

DensityplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
densityY*array
densityY[]number
densityX*array
densityX[]number

Type LineplotData (object)

LineplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
binStartarray
binStart[]string
binEndarray
binEnd[]string
binSampleSizearray
binSampleSize[]union

Inherits: lib.SampleSize

binSampleSize[]anyOf
Any of the following types.
binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

binSampleSize[]{SimpleSampleSize}..N*number
binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

binSampleSize[]{ProportionSampleSize}..numeratorN*number
binSampleSize[]{ProportionSampleSize}..denominatorN*number
errorBarsarray
errorBars[]object

Inherits: lib.ErrorBar

errorBars[].lowerBound*number
errorBars[].upperBound*number
errorBars[].error*string

Type PlotConfig (object)

PlotConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type SampleSizeTable (object)

SampleSizeTable

Inherits: object

Model

ParameterTypeDescription
xVariableDetailsarray
xVariableDetails[]object

Inherits: object

xVariableDetails[].entityId*string
xVariableDetails[].variableId*string
xVariableDetails[].value*string
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
size*array
size[]number

Type VariableCompleteCases (object)

VariableCompleteCases

Inherits: object

Model

ParameterTypeDescription
variableDetails*object

Inherits: object

variableDetails.entityId*string
variableDetails.variableId*string
completeCases*number

Type CategoricalDistributionPostRequest (object)

CategoricalDistributionPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.variableId*string

Type CategoricalDistributionBin (object)

CategoricalDistributionBin

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
label*string
value*number

Type CategoricalDistributionPostResponse (object)

CategoricalDistributionPostResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
countDistribution*array
countDistribution[]object

Additional properties: Yes

Inherits: object

countDistribution[].label*string
countDistribution[].value*number
proportionDistribution*array
proportionDistribution[]object

Additional properties: Yes

Inherits: object

proportionDistribution[].label*string
proportionDistribution[].value*number

Type ExampleComputeVizPostRequest (object)

ExampleComputeVizPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ExampleComputeVizSpec

config.prefixVar*object

Inherits: object

config.prefixVar.entityId*string
config.prefixVar.variableId*string
computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.inputVariable*object

Inherits: object

computeConfig.inputVariable.entityId*string
computeConfig.inputVariable.variableId*string
computeConfig.valueSuffix*string

Type ExampleComputeVizSpec (object)

ExampleComputeVizSpec

Inherits: object

Model

ParameterTypeDescription
prefixVar*object

Inherits: object

prefixVar.entityId*string
prefixVar.variableId*string

Type ExampleComputeVizPostResponse (object)

ExampleComputeVizPostResponse

Inherits: object

Model

ParameterTypeDescription
countPluginResult*integer
numEmptyValues*integer
longestConcatenatedValue*string
avgConcatenatedLength*number

Type MultiStreamPostRequest (object)

MultiStreamPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MultiStreamSpec

config.entityId*string

Type MultiStreamSpec (object)

MultiStreamSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostRequest (object)

RecordCountPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.RecordCountSpec

config.entityId*string

Type RecordCountSpec (object)

RecordCountSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostResponse (object)

RecordCountPostResponse

Inherits: object

Model

ParameterTypeDescription
recordCount*integer

Type TestCollectionsPostRequest (object)

TestCollectionsPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.collectionId*string

Type CollectionFloatingBarplotPostRequest (object)

CollectionFloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string

Type CollectionFloatingBarplotSpec (object)

CollectionFloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string

Type CollectionFloatingBoxplotPostRequest (object)

CollectionFloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingBoxplotSpec (object)

CollectionFloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingContTablePostRequest (object)

CollectionFloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.xAxisVariable.collection*object

Inherits: object

config.xAxisVariable.collection.entityId*string
config.xAxisVariable.collection.collectionId*string
config.xAxisVariable.selectedMembers*array
config.xAxisVariable.selectedMembers[]object

Inherits: object

config.xAxisVariable.selectedMembers[].entityId*string
config.xAxisVariable.selectedMembers[].variableId*string
config.xAxisVariable.selectedValuesarray
config.xAxisVariable.selectedValues[]string

Type CollectionFloatingContTableSpec (object)

CollectionFloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

xAxisVariable.collection*object

Inherits: object

xAxisVariable.collection.entityId*string
xAxisVariable.collection.collectionId*string
xAxisVariable.selectedMembers*array
xAxisVariable.selectedMembers[]object

Inherits: object

xAxisVariable.selectedMembers[].entityId*string
xAxisVariable.selectedMembers[].variableId*string
xAxisVariable.selectedValuesarray
xAxisVariable.selectedValues[]string

Type CollectionFloatingHistogramPostRequest (object)

CollectionFloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingHistogramSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.binSpec*object

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingHistogramSpec (object)

CollectionFloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
binSpec*object

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type CollectionFloatingLineplotPostRequest (object)

CollectionFloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string
config.binSpecobject

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingLineplotSpec (object)

CollectionFloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string
binSpecobject

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type StandaloneCollectionMapMarkerPostRequest (object)

StandaloneCollectionMapMarkerPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for a map marker

Inherits: lib.StandaloneCollectionMapMarkerSpec

config.outputEntityId*string

Entity ID associated with collection variable of interest.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number
config.collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.collection.collection*object

Inherits: object

config.collection.collection.entityId*string
config.collection.collection.collectionId*string
config.collection.selectedMembers*array
config.collection.selectedMembers[]object

Inherits: object

config.collection.selectedMembers[].entityId*string
config.collection.selectedMembers[].variableId*string
config.aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type StandaloneCollectionMapMarkerSpec (object)

StandaloneCollectionMapMarkerSpec

Specification for a map marker

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity ID associated with collection variable of interest.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number
collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

collection.collection*object

Inherits: object

collection.collection.entityId*string
collection.collection.collectionId*string
collection.selectedMembers*array
collection.selectedMembers[]object

Inherits: object

collection.selectedMembers[].entityId*string
collection.selectedMembers[].variableId*string
aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type CollectionOverlayConfig (object)

CollectionOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string

Type CollectionMapMarkerElement (object)

CollectionMapMarkerElement

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number
values*array
values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

values[].variableId*string
values[].value*number
values[].confidenceInterval*object

Inherits: lib.NumberRange

values[].confidenceInterval.min*number
values[].confidenceInterval.max*number
values[].n*number

Type CollectionMemberAggregate (object)

CollectionMemberAggregate

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
value*number
confidenceInterval*object

Inherits: lib.NumberRange

confidenceInterval.min*number
confidenceInterval.max*number
n*number

Type StandaloneCollectionMapMarkerPostResponse (object)

StandaloneCollectionMapMarkerPostResponse

Inherits: object

Model

ParameterTypeDescription
markers*array
markers[]object

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

markers[].entityCount*number
markers[].avgLat*number
markers[].avgLon*number
markers[].minLat*number
markers[].minLon*number
markers[].maxLat*number
markers[].maxLon*number
markers[].values*array
markers[].values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

markers[].values[].variableId*string
markers[].values[].value*number
markers[].values[].confidenceInterval*object

Inherits: lib.NumberRange

markers[].values[].confidenceInterval.min*number
markers[].values[].confidenceInterval.max*number
markers[].values[].n*number

Type FloatingBarplotPostRequest (object)

FloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string

Type FloatingBarplotSpec (object)

FloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string

Type FloatingBarplot (object)

FloatingBarplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBarplotPostResponse (object)

FloatingBarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: object

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.variables*array
barplot.variables[]object

Inherits: object

barplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.variables[].variableSpec.entityId*string
barplot.variables[].variableSpec.variableId*string
barplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.variables[].displayNamestring
barplot.variables[].displayRangeMinany
barplot.variables[].displayRangeMaxany
barplot.variables[].vocabularyarray
barplot.variables[].vocabulary[]string
barplot.variables[].imputeZero*boolean
barplot.variables[].hasStudyDependentVocabularyboolean
barplot.variables[].isCollection*boolean
barplot.variables[].membersarray
barplot.variables[].members[]object

Inherits: lib.VariableSpec

barplot.variables[].members[].entityId*string
barplot.variables[].members[].variableId*string

Type FloatingBoxplotPostRequest (object)

FloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplotSpec (object)

FloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplot (object)

FloatingBoxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBoxplotPostResponse (object)

FloatingBoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: object

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.variables*array
boxplot.variables[]object

Inherits: object

boxplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.variables[].variableSpec.entityId*string
boxplot.variables[].variableSpec.variableId*string
boxplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.variables[].displayNamestring
boxplot.variables[].displayRangeMinany
boxplot.variables[].displayRangeMaxany
boxplot.variables[].vocabularyarray
boxplot.variables[].vocabulary[]string
boxplot.variables[].imputeZero*boolean
boxplot.variables[].hasStudyDependentVocabularyboolean
boxplot.variables[].isCollection*boolean
boxplot.variables[].membersarray
boxplot.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.variables[].members[].entityId*string
boxplot.variables[].members[].variableId*string

Type FloatingContTablePostRequest (object)

FloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string

Type FloatingContTableSpec (object)

FloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string

Type FloatingContTable (object)

FloatingContTable

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingContTablePostResponse (object)

FloatingContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: object

mosaic.data*array
mosaic.data[]object

Inherits: object

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.variables*array
mosaic.variables[]object

Inherits: object

mosaic.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.variables[].variableSpec.entityId*string
mosaic.variables[].variableSpec.variableId*string
mosaic.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.variables[].displayNamestring
mosaic.variables[].displayRangeMinany
mosaic.variables[].displayRangeMaxany
mosaic.variables[].vocabularyarray
mosaic.variables[].vocabulary[]string
mosaic.variables[].imputeZero*boolean
mosaic.variables[].hasStudyDependentVocabularyboolean
mosaic.variables[].isCollection*boolean
mosaic.variables[].membersarray
mosaic.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.variables[].members[].entityId*string
mosaic.variables[].members[].variableId*string
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string

Type FloatingHistogramPostRequest (object)

FloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingHistogramSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingHistogramSpec (object)

FloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingHistogram (object)

FloatingHistogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingHistogramPostResponse (object)

FloatingHistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: object

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.variables*array
histogram.variables[]object

Inherits: object

histogram.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.variables[].variableSpec.entityId*string
histogram.variables[].variableSpec.variableId*string
histogram.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.variables[].displayNamestring
histogram.variables[].displayRangeMinany
histogram.variables[].displayRangeMaxany
histogram.variables[].vocabularyarray
histogram.variables[].vocabulary[]string
histogram.variables[].imputeZero*boolean
histogram.variables[].hasStudyDependentVocabularyboolean
histogram.variables[].isCollection*boolean
histogram.variables[].membersarray
histogram.variables[].members[]object

Inherits: lib.VariableSpec

histogram.variables[].members[].entityId*string
histogram.variables[].members[].variableId*string

Type FloatingLineplotPostRequest (object)

FloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingLineplotSpec (object)

FloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingLineplot (object)

FloatingLineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingLineplotPostResponse (object)

FloatingLineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: object

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.variables*array
lineplot.variables[]object

Inherits: object

lineplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.variables[].variableSpec.entityId*string
lineplot.variables[].variableSpec.variableId*string
lineplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.variables[].displayNamestring
lineplot.variables[].displayRangeMinany
lineplot.variables[].displayRangeMaxany
lineplot.variables[].vocabularyarray
lineplot.variables[].vocabulary[]string
lineplot.variables[].imputeZero*boolean
lineplot.variables[].hasStudyDependentVocabularyboolean
lineplot.variables[].isCollection*boolean
lineplot.variables[].membersarray
lineplot.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.variables[].members[].entityId*string
lineplot.variables[].members[].variableId*string

Type FloatingScatterplotPostRequest (object)

FloatingScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingScatterplotSpec

config.outputEntityId*string
config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplotSpec (object)

FloatingScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplot (object)

FloatingScatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingScatterplotPostResponse (object)

FloatingScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: object

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.variables*array
scatterplot.variables[]object

Inherits: object

scatterplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.variables[].variableSpec.entityId*string
scatterplot.variables[].variableSpec.variableId*string
scatterplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.variables[].displayNamestring
scatterplot.variables[].displayRangeMinany
scatterplot.variables[].displayRangeMaxany
scatterplot.variables[].vocabularyarray
scatterplot.variables[].vocabulary[]string
scatterplot.variables[].imputeZero*boolean
scatterplot.variables[].hasStudyDependentVocabularyboolean
scatterplot.variables[].isCollection*boolean
scatterplot.variables[].membersarray
scatterplot.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.variables[].members[].entityId*string
scatterplot.variables[].members[].variableId*string

Type StandaloneMapBubblesLegendPostRequest (object)

StandaloneMapBubblesLegendPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapBubblesLegendSpec

config.outputEntityId*string
config.colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

config.colorLegendConfig.geoAggregateVariable*object

Inherits: object

config.colorLegendConfig.geoAggregateVariable.entityId*string
config.colorLegendConfig.geoAggregateVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.sizeConfig*object

Inherits: lib.SizeLegendConfig

config.sizeConfig.geoAggregateVariable*object

Inherits: object

config.sizeConfig.geoAggregateVariable.entityId*string
config.sizeConfig.geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendSpec (object)

StandaloneMapBubblesLegendSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

colorLegendConfig.geoAggregateVariable*object

Inherits: object

colorLegendConfig.geoAggregateVariable.entityId*string
colorLegendConfig.geoAggregateVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

sizeConfig*object

Inherits: lib.SizeLegendConfig

sizeConfig.geoAggregateVariable*object

Inherits: object

sizeConfig.geoAggregateVariable.entityId*string
sizeConfig.geoAggregateVariable.variableId*string

Type OverlayLegendConfig (object)

OverlayLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

quantitativeOverlayConfig.overlayVariable*object

Inherits: object

quantitativeOverlayConfig.overlayVariable.entityId*string
quantitativeOverlayConfig.overlayVariable.variableId*string
quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type SizeLegendConfig (object)

SizeLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendPostResponse (object)

StandaloneMapBubblesLegendPostResponse

Inherits: object

Model

ParameterTypeDescription
minColorValue*string
maxColorValue*string
minSizeValue*number
maxSizeValue*number

Type StandaloneMapBubblesPostRequest (object)

StandaloneMapBubblesPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for map bubbles.

Inherits: lib.StandaloneMapBubblesSpec

config.outputEntityId*string

Entity whose cardinality will be reported per marker.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapBubblesSpec (object)

StandaloneMapBubblesSpec

Specification for map bubbles.

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity whose cardinality will be reported per marker.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapBubblesPostResponse (object)

StandaloneMapBubblesPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.ColoredMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValue*string
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type ColoredMapElementInfo (object)

ColoredMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValue*string
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type StandaloneMapMarkersPostRequest (object)

StandaloneMapMarkersPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapMarkersSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapMarkersSpec (object)

StandaloneMapMarkersSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapMarkersPostResponse (object)

StandaloneMapMarkersPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.StandaloneMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValues*array
mapElements[].overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

mapElements[].overlayValues[].binStart*string
mapElements[].overlayValues[].binEnd*string
mapElements[].overlayValues[].binLabel*string
mapElements[].overlayValues[].value*number
mapElements[].overlayValues[].count*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type OverlayType (string)

OverlayType
Enum:
  • continuous
  • categorical

Inherits: string

Type OverlayConfig (object)

OverlayConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type ContinousOverlayConfig (object)

ContinousOverlayConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRange

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string

Type CategoricalOverlayConfig (object)

CategoricalOverlayConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]string

Type StandaloneMapElementInfo (object)

StandaloneMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string
overlayValues[].value*number
overlayValues[].count*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type DataPluginRequestBase (object)

DataPluginRequestBase

Inherits: object

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

Type EmptyDataPluginSpec (object)

EmptyDataPluginSpec

Inherits: object

Model

ParameterTypeDescription

Type StringBoolean (string)

StringBoolean
Enum:
  • TRUE
  • FALSE

Inherits: string

Type StrataVariableDetails (object)

StrataVariableDetails

Model

ParameterTypeDescription
entityId*string
variableId*string
value*string

Type BinSpec (object)

BinSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
  • numBins
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type BinWidthSpec (object)

BinWidthSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type NumberRange (object)

NumberRange

Inherits: object

Model

ParameterTypeDescription
min*number
max*number

Type DateRange (object)

DateRange

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type NumericViewport (object)

NumericViewport

Inherits: object

Model

ParameterTypeDescription
xMin*string
xMax*string

Type LongitudeViewport (object)

LongitudeViewport

Inherits: object

Model

ParameterTypeDescription
left*number
right*number

Type GeolocationViewport (object)

GeolocationViewport

Inherits: object

Model

ParameterTypeDescription
latitude*object

Inherits: object

latitude.xMin*string
latitude.xMax*string
longitude*object

Inherits: object

longitude.left*number
longitude.right*number

Type ErrorBar (object)

ErrorBar

Inherits: object

Model

ParameterTypeDescription
lowerBound*number
upperBound*number
error*string

Type SimpleSampleSize (object)

SimpleSampleSize

Inherits: object

Model

ParameterTypeDescription
N*number

Type ProportionSampleSize (object)

ProportionSampleSize

Inherits: object

Model

ParameterTypeDescription
numeratorN*number
denominatorN*number

Type SampleSize (union)

SampleSize

Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize

Model

ParameterTypeDescription
anyOf
Any of the following types.
{SimpleSampleSize}object

Inherits: object

{SimpleSampleSize}.N*number
{ProportionSampleSize}object

Inherits: object

{ProportionSampleSize}.numeratorN*number
{ProportionSampleSize}.denominatorN*number

Type ShowMissingness (string)

ShowMissingness
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type ShowMissingnessNoAxes (string)

ShowMissingnessNoAxes
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type BoxplotWith1ComputeSpec (object)

BoxplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: string

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: string

xAxisVariableobject

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type ScatterplotWith1ComputeSpec (object)

ScatterplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Aggregator (string)

Aggregator
Enum:
  • mean
  • median

Inherits: string

Type QuantitativeOverlayConfig (object)

QuantitativeOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type QuantitativeAggregationConfig (object)

QuantitativeAggregationConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type ContinuousAggregationConfig (object)

ContinuousAggregationConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

aggregator*string
Enum:
  • mean
  • median

Inherits: string

Type CategoricalAggregationConfig (object)

CategoricalAggregationConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

numeratorValues*array
numeratorValues[]string
denominatorValues*array
denominatorValues[]string

Type CollectionOverlayConfigWithValues (object)

CollectionOverlayConfigWithValues

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string
selectedValuesarray
selectedValues[]string

Type LegacyLabeledRange (object)

LegacyLabeledRange

Inherits: object

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string

Type LegacyLabeledRangeWithCountAndValue (object)

LegacyLabeledRangeWithCountAndValue

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string
value*number
count*number

Type Error (object)

Error

Discriminator: status

Inherits: object

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Type ErrorType (string)

ErrorType
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: string

Type BadRequestError (object)

Bad Request

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Examples

{
+  /<path>

Types

Type VariableClass (string)

VariableClass
Enum:
  • native
  • derived
  • computed

Inherits: string

Type PlotReferenceValue (string)

PlotReferenceValue
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

Type VariableMapping (object)

VariableMapping

Inherits: object

Model

ParameterTypeDescription
variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variableSpec*object

Inherits: lib.VariableSpec

variableSpec.entityId*string
variableSpec.variableId*string
plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

displayNamestring
displayRangeMinany
displayRangeMaxany
vocabularyarray
vocabulary[]string
imputeZero*boolean
hasStudyDependentVocabularyboolean
isCollection*boolean
membersarray
members[]object

Inherits: lib.VariableSpec

members[].entityId*string
members[].variableId*string

Type API_Filter (object)

API_Filter

Additional properties: Yes

Discriminator: type

Inherits: object

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

Type API_FilterType (string)

API_FilterType
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: string

Type API_BooleanOperationType (string)

API_BooleanOperationType
Enum:
  • intersect
  • union

Inherits: string

Type API_MultiFilterSubFilter (object)

API_MultiFilterSubFilter

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
stringSet*array
stringSet[]string

Type API_MultiFilter (object)

API_MultiFilter

Additional properties: Yes

Discriminator: type

Discriminator value: multiFilter

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

operation*string
Enum:
  • intersect
  • union

Inherits: string

variableId*string
subFilters*array
subFilters[]object

Additional properties: Yes

Inherits: object

subFilters[].variableId*string
subFilters[].stringSet*array
subFilters[].stringSet[]string

Type API_StringSetFilter (object)

API_StringSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: stringSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
stringSet*array
stringSet[]string

Type API_NumberSetFilter (object)

API_NumberSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
numberSet*array
numberSet[]number

Type API_DateSetFilter (object)

API_DateSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
dateSet*array
dateSet[]string

Type API_NumberRangeFilter (object)

API_NumberRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*number
max*number

Type API_DateRangeFilter (object)

API_DateRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*string
max*string

Type API_LongitudeRangeFilter (object)

API_LongitudeRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: longitudeRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
left*number
right*number

Type DerivedVariableSpec (object)

DerivedVariableSpec

Model

ParameterTypeDescription
entityId*string
variableId*string
functionName*string
displayName*string
config*object

Type VariableSpec (object)

VariableSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
variableId*string

Type CollectionSpec (object)

CollectionSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
collectionId*string

Type DataElementConstraint (object)

DataElementConstraint

Inherits: object

Model

ParameterTypeDescription
isRequired*boolean
isTemporal*boolean
isCollection*boolean
isCompositional*boolean
isProportion*boolean
allowedNormalizationMethods*array
allowedNormalizationMethods[]string
minNumVars*number
maxNumVars*number
minNumValues*number
maxNumValues*number
allowedTypesarray
allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

allowedShapesarray
allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

description*string

Type DataElementConstraintPattern (object)

DataElementConstraintPattern

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
//*object

Inherits: object

//.isRequired*boolean
//.isTemporal*boolean
//.isCollection*boolean
//.isCompositional*boolean
//.isProportion*boolean
//.allowedNormalizationMethods*array
//.allowedNormalizationMethods[]string
//.minNumVars*number
//.maxNumVars*number
//.minNumValues*number
//.maxNumValues*number
//.allowedTypesarray
//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

//.allowedShapesarray
//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

//.description*string

Type EntityTabularPostResponse (object)

EntityTabularPostResponse

Inherits: object

Model

ParameterTypeDescription
tabular*array
tabular[]array
tabular[][]string

Type Range (object)

Range

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type LabeledRange (object)

LabeledRange

Inherits: lib.Range

Model

ParameterTypeDescription
min*string
max*string
label*string

Type API_VariableType (string)

API_VariableType
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: string

Type API_VariableDataShape (string)

API_VariableDataShape
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: string

Type API_PagingConfig (object)

API_PagingConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
numRowsinteger

Format: int64

offsetinteger

Format: int64

Type BinUnits (string)

BinUnits
Enum:
  • day
  • week
  • month
  • year

Inherits: string

Type ValueSpec (string)

ValueSpec
Enum:
  • count
  • proportion

Inherits: string

Type AlphaDivComputeConfig (object)

AlphaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

Type AlphaDivMethod (string)

AlphaDivMethod
Enum:
  • shannon
  • simpson
  • evenness

Inherits: string

Type BetaDivComputeConfig (object)

BetaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

Type BetaDivDissimilarityMethod (string)

BetaDivDissimilarityMethod
Enum:
  • bray
  • jaccard
  • jsd

Inherits: string

Type CorrelationComputeConfig (object)

CorrelationComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

Type CorrelationMethod (string)

CorrelationMethod
Enum:
  • spearman
  • pearson

Inherits: string

Type Correlation1Collection (object)

Correlation1Collection

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string

Type Correlation2Collections (object)

Correlation2Collections

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable1*object

Inherits: object

collectionVariable1.entityId*string
collectionVariable1.collectionId*string
collectionVariable2*object

Inherits: object

collectionVariable2.entityId*string
collectionVariable2.collectionId*string

Type DifferentialAbundanceComputeConfig (object)

DifferentialAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

comparator.variable*object

Inherits: object

comparator.variable.entityId*string
comparator.variable.variableId*string
comparator.groupA*array
comparator.groupA[]object

Inherits: lib.Range

comparator.groupA[].min*string
comparator.groupA[].max*string
comparator.groupA[].label*string
comparator.groupB*array
comparator.groupB[]object

Inherits: lib.Range

comparator.groupB[].min*string
comparator.groupB[].max*string
comparator.groupB[].label*string
differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

pValueFloorstring

Type DifferentialAbundanceMethod (string)

DifferentialAbundanceMethod
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: string

Type ComparatorSpec (object)

ComparatorSpec

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
groupA*array
groupA[]object

Inherits: lib.Range

groupA[].min*string
groupA[].max*string
groupA[].label*string
groupB*array
groupB[]object

Inherits: lib.Range

groupB[].min*string
groupB[].max*string
groupB[].label*string

Type DifferentialAbundanceStats (object)

DifferentialAbundanceStats

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSize*array
effectSize[]string
pValue*array
pValue[]string
adjustedPValue*array
adjustedPValue[]string
pointId*array
pointId[]string

Type DifferentialAbundanceStatsResponse (object)

DifferentialAbundanceStatsResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSizeLabel*string
statistics*object

Additional properties: Yes

Inherits: object

statistics.effectSize*array
statistics.effectSize[]string
statistics.pValue*array
statistics.pValue[]string
statistics.adjustedPValue*array
statistics.adjustedPValue[]string
statistics.pointId*array
statistics.pointId[]string
pvalueFloorstring
adjustedPValueFloorstring

Type ExampleComputeConfig (object)

ExampleComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
inputVariable*object

Inherits: object

inputVariable.entityId*string
inputVariable.variableId*string
valueSuffix*string

Type RankedAbundanceComputeConfig (object)

RankedAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

Type RankingMethod (string)

RankingMethod
Enum:
  • median
  • q3
  • variance
  • max

Inherits: string

Type AbundanceBoxplotPostRequest (object)

AbundanceBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AbundanceScatterplotPostRequest (object)

AbundanceScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivBoxplotPostRequest (object)

AlphaDivBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivScatterplotPostRequest (object)

AlphaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AppsGetResponse (object)

AppsGetResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
apps*array
apps[]object

Inherits: lib.AppOverview

apps[].name*string
apps[].displayName*string
apps[].description*string
apps[].projects*array
apps[].projects[]string
apps[].computeNamestring
apps[].visualizations*array
apps[].visualizations[]object

Inherits: lib.VisualizationOverview

apps[].visualizations[].name*string
apps[].visualizations[].displayName*string
apps[].visualizations[].description*string
apps[].visualizations[].projects*array
apps[].visualizations[].projects[]string
apps[].visualizations[].maxPanels*number
apps[].visualizations[].dataElementConstraintsarray
apps[].visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

apps[].visualizations[].dataElementConstraints[].//*object

Inherits: object

apps[].visualizations[].dataElementConstraints[].//.isRequired*boolean
apps[].visualizations[].dataElementConstraints[].//.isTemporal*boolean
apps[].visualizations[].dataElementConstraints[].//.isCollection*boolean
apps[].visualizations[].dataElementConstraints[].//.isCompositional*boolean
apps[].visualizations[].dataElementConstraints[].//.isProportion*boolean
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
apps[].visualizations[].dataElementConstraints[].//.minNumVars*number
apps[].visualizations[].dataElementConstraints[].//.maxNumVars*number
apps[].visualizations[].dataElementConstraints[].//.minNumValues*number
apps[].visualizations[].dataElementConstraints[].//.maxNumValues*number
apps[].visualizations[].dataElementConstraints[].//.allowedTypesarray
apps[].visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

apps[].visualizations[].dataElementConstraints[].//.allowedShapesarray
apps[].visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

apps[].visualizations[].dataElementConstraints[].//.description*string
apps[].visualizations[].dataElementDependencyOrderarray
apps[].visualizations[].dataElementDependencyOrder[]array
apps[].visualizations[].dataElementDependencyOrder[][]string

Type AppOverview (object)

AppOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
computeNamestring
visualizations*array
visualizations[]object

Inherits: lib.VisualizationOverview

visualizations[].name*string
visualizations[].displayName*string
visualizations[].description*string
visualizations[].projects*array
visualizations[].projects[]string
visualizations[].maxPanels*number
visualizations[].dataElementConstraintsarray
visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

visualizations[].dataElementConstraints[].//*object

Inherits: object

visualizations[].dataElementConstraints[].//.isRequired*boolean
visualizations[].dataElementConstraints[].//.isTemporal*boolean
visualizations[].dataElementConstraints[].//.isCollection*boolean
visualizations[].dataElementConstraints[].//.isCompositional*boolean
visualizations[].dataElementConstraints[].//.isProportion*boolean
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
visualizations[].dataElementConstraints[].//.minNumVars*number
visualizations[].dataElementConstraints[].//.maxNumVars*number
visualizations[].dataElementConstraints[].//.minNumValues*number
visualizations[].dataElementConstraints[].//.maxNumValues*number
visualizations[].dataElementConstraints[].//.allowedTypesarray
visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

visualizations[].dataElementConstraints[].//.allowedShapesarray
visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

visualizations[].dataElementConstraints[].//.description*string
visualizations[].dataElementDependencyOrderarray
visualizations[].dataElementDependencyOrder[]array
visualizations[].dataElementDependencyOrder[][]string

Type VisualizationOverview (object)

VisualizationOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
maxPanels*number
dataElementConstraintsarray
dataElementConstraints[]object

Additional properties: Yes

Inherits: object

dataElementConstraints[].//*object

Inherits: object

dataElementConstraints[].//.isRequired*boolean
dataElementConstraints[].//.isTemporal*boolean
dataElementConstraints[].//.isCollection*boolean
dataElementConstraints[].//.isCompositional*boolean
dataElementConstraints[].//.isProportion*boolean
dataElementConstraints[].//.allowedNormalizationMethods*array
dataElementConstraints[].//.allowedNormalizationMethods[]string
dataElementConstraints[].//.minNumVars*number
dataElementConstraints[].//.maxNumVars*number
dataElementConstraints[].//.minNumValues*number
dataElementConstraints[].//.maxNumValues*number
dataElementConstraints[].//.allowedTypesarray
dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataElementConstraints[].//.allowedShapesarray
dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

dataElementConstraints[].//.description*string
dataElementDependencyOrderarray
dataElementDependencyOrder[]array
dataElementDependencyOrder[][]string

Type BetaDivScatterplotPostRequest (object)

BetaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

config*object

Inherits: lib.BetaDivScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string

Type BetaDivScatterplotSpec (object)

BetaDivScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type CorrelationBipartitenetworkSpec (object)

CorrelationBipartitenetworkSpec

Inherits: object

Model

ParameterTypeDescription
significanceThresholdnumber
correlationCoefThresholdnumber

Type CorrelationBipartiteNetworkPostResponse (object)

CorrelationBipartiteNetworkPostResponse

Model

ParameterTypeDescription
bipartitenetwork*object

Inherits: lib.BipartiteNetwork

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: lib.LinkData

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string
significanceThreshold*number
correlationCoefThreshold*number

Type CorrelationAssayAssayBipartitenetworkPostRequest (object)

CorrelationAssayAssayBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)

CorrelationAssayMetadataBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type DifferentialAbundanceVolcanoplotPostRequest (object)

DifferentialAbundanceVolcanoplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

computeConfig.comparator.variable*object

Inherits: object

computeConfig.comparator.variable.entityId*string
computeConfig.comparator.variable.variableId*string
computeConfig.comparator.groupA*array
computeConfig.comparator.groupA[]object

Inherits: lib.Range

computeConfig.comparator.groupA[].min*string
computeConfig.comparator.groupA[].max*string
computeConfig.comparator.groupA[].label*string
computeConfig.comparator.groupB*array
computeConfig.comparator.groupB[]object

Inherits: lib.Range

computeConfig.comparator.groupB[].min*string
computeConfig.comparator.groupB[].max*string
computeConfig.comparator.groupB[].label*string
computeConfig.differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

computeConfig.pValueFloorstring
config*object

Inherits: lib.EmptyDataPluginSpec

Type ContinuousVariableMetadataPostRequest (object)

ContinuousVariableMetadataPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ContinuousVariableMetadataSpec

config.variable*object

Inherits: object

config.variable.entityId*string
config.variable.variableId*string
config.metadata*array
config.metadata[]string
Enum:
  • binRanges
  • median

Type ContinuousVariableMetadataSpec (object)

ContinuousVariableMetadataSpec

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
metadata*array
metadata[]string
Enum:
  • binRanges
  • median

Type AllBinRanges (object)

AllBinRanges

Inherits: object

Model

ParameterTypeDescription
equalInterval*array
equalInterval[]object

Inherits: lib.Range

equalInterval[].min*string
equalInterval[].max*string
equalInterval[].label*string
quantile*array
quantile[]object

Inherits: lib.Range

quantile[].min*string
quantile[].max*string
quantile[].label*string
standardDeviation*array
standardDeviation[]object

Inherits: lib.Range

standardDeviation[].min*string
standardDeviation[].max*string
standardDeviation[].label*string

Type ContinuousVariableMetadataPostResponse (object)

ContinuousVariableMetadataPostResponse

Inherits: object

Model

ParameterTypeDescription
binRangesobject

Inherits: object

binRanges.equalInterval*array
binRanges.equalInterval[]object

Inherits: lib.Range

binRanges.equalInterval[].min*string
binRanges.equalInterval[].max*string
binRanges.equalInterval[].label*string
binRanges.quantile*array
binRanges.quantile[]object

Inherits: lib.Range

binRanges.quantile[].min*string
binRanges.quantile[].max*string
binRanges.quantile[].label*string
binRanges.standardDeviation*array
binRanges.standardDeviation[]object

Inherits: lib.Range

binRanges.standardDeviation[].min*string
binRanges.standardDeviation[].max*string
binRanges.standardDeviation[].label*string
mediannumber

Type NodeData (object)

NodeData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
id*string

Type LinkData (object)

LinkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
source*object

Additional properties: Yes

Inherits: object

source.id*string
target*object

Additional properties: Yes

Inherits: object

target.id*string
strokeWidth*string
color*string

Type NetworkData (object)

NetworkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string

Type NetworkConfig (object)

NetworkConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type BipartiteNetworkConfig (object)

BipartiteNetworkConfig

Additional properties: Yes

Inherits: lib.NetworkConfig

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
column1Metadata*string
column2Metadata*string

Type BipartiteNetworkData (object)

BipartiteNetworkData

Additional properties: Yes

Inherits: lib.NetworkData

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string
column1NodeIDs*array
column1NodeIDs[]string
column2NodeIDs*array
column2NodeIDs[]string

Type BipartiteNetwork (object)

BipartiteNetwork

Inherits: object

Model

ParameterTypeDescription
data*object

Additional properties: Yes

Inherits: lib.NetworkData

data.nodes*array
data.nodes[]object

Additional properties: Yes

Inherits: object

data.nodes[].id*string
data.links*array
data.links[]object

Additional properties: Yes

Inherits: object

data.links[].source*object

Additional properties: Yes

Inherits: object

data.links[].source.id*string
data.links[].target*object

Additional properties: Yes

Inherits: object

data.links[].target.id*string
data.links[].strokeWidth*string
data.links[].color*string
data.column1NodeIDs*array
data.column1NodeIDs[]string
data.column2NodeIDs*array
data.column2NodeIDs[]string
config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

config.variablesarray
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.column1Metadata*string
config.column2Metadata*string

Type BipartiteNetworkPostResponse (object)

BipartiteNetworkPostResponse

Inherits: object

Model

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

Type BarplotPostRequest (object)

BarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BarplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type BarplotSpec (object)

BarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Barplot (object)

Barplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BarplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BarplotPostResponse (object)

BarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: lib.BarplotData

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.config*object

Inherits: lib.PlotConfig

barplot.config.completeCasesAllVars*number
barplot.config.completeCasesAxesVars*number
barplot.config.variables*array
barplot.config.variables[]object

Inherits: object

barplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.config.variables[].variableSpec.entityId*string
barplot.config.variables[].variableSpec.variableId*string
barplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.config.variables[].displayNamestring
barplot.config.variables[].displayRangeMinany
barplot.config.variables[].displayRangeMaxany
barplot.config.variables[].vocabularyarray
barplot.config.variables[].vocabulary[]string
barplot.config.variables[].imputeZero*boolean
barplot.config.variables[].hasStudyDependentVocabularyboolean
barplot.config.variables[].isCollection*boolean
barplot.config.variables[].membersarray
barplot.config.variables[].members[]object

Inherits: lib.VariableSpec

barplot.config.variables[].members[].entityId*string
barplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BoxplotPostRequest (object)

BoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BoxplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type BoxplotSpec (object)

BoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Boxplot (object)

Boxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BoxplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BoxplotPostResponse (object)

BoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: lib.BoxplotData

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.config*object

Inherits: lib.PlotConfig

boxplot.config.completeCasesAllVars*number
boxplot.config.completeCasesAxesVars*number
boxplot.config.variables*array
boxplot.config.variables[]object

Inherits: object

boxplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.config.variables[].variableSpec.entityId*string
boxplot.config.variables[].variableSpec.variableId*string
boxplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.config.variables[].displayNamestring
boxplot.config.variables[].displayRangeMinany
boxplot.config.variables[].displayRangeMaxany
boxplot.config.variables[].vocabularyarray
boxplot.config.variables[].vocabulary[]string
boxplot.config.variables[].imputeZero*boolean
boxplot.config.variables[].hasStudyDependentVocabularyboolean
boxplot.config.variables[].isCollection*boolean
boxplot.config.variables[].membersarray
boxplot.config.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.config.variables[].members[].entityId*string
boxplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number
statsTablearray
statsTable[]object

Inherits: lib.BoxplotStatsTable

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].xVariableDetailsobject

Inherits: object

statsTable[].xVariableDetails.entityId*string
statsTable[].xVariableDetails.variableId*string
statsTable[].xVariableDetails.value*string
statsTable[].statistic*string
statsTable[].pvalue*number
statsTable[].parameter*array
statsTable[].parameter[]number
statsTable[].method*string
statsTable[].statsError*string

Type ContTableStatsTable (object)

ContTableStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
pvalue*array
pvalue[]number
degreesFreedom*array
degreesFreedom[]number
chisq*array
chisq[]number

Type ContTablePostResponse (object)

ContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].pvalue*array
statsTable[].pvalue[]number
statsTable[].degreesFreedom*array
statsTable[].degreesFreedom[]number
statsTable[].chisq*array
statsTable[].chisq[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type DensityplotPostRequest (object)

DensityplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.DensityplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type DensityplotSpec (object)

DensityplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Densityplot (object)

Densityplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.DensityplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].densityY*array
data[].densityY[]number
data[].densityX*array
data[].densityX[]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type DensityplotPostResponse (object)

DensityplotPostResponse

Inherits: object

Model

ParameterTypeDescription
densityplot*object

Inherits: object

densityplot.data*array
densityplot.data[]object

Inherits: lib.DensityplotData

densityplot.data[].overlayVariableDetailsobject

Inherits: object

densityplot.data[].overlayVariableDetails.entityId*string
densityplot.data[].overlayVariableDetails.variableId*string
densityplot.data[].overlayVariableDetails.value*string
densityplot.data[].facetVariableDetailsarray

Max. items: 2

densityplot.data[].facetVariableDetails[]object

Inherits: object

densityplot.data[].facetVariableDetails[].entityId*string
densityplot.data[].facetVariableDetails[].variableId*string
densityplot.data[].facetVariableDetails[].value*string
densityplot.data[].densityY*array
densityplot.data[].densityY[]number
densityplot.data[].densityX*array
densityplot.data[].densityX[]number
densityplot.config*object

Inherits: lib.PlotConfig

densityplot.config.completeCasesAllVars*number
densityplot.config.completeCasesAxesVars*number
densityplot.config.variables*array
densityplot.config.variables[]object

Inherits: object

densityplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

densityplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

densityplot.config.variables[].variableSpec.entityId*string
densityplot.config.variables[].variableSpec.variableId*string
densityplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

densityplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

densityplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

densityplot.config.variables[].displayNamestring
densityplot.config.variables[].displayRangeMinany
densityplot.config.variables[].displayRangeMaxany
densityplot.config.variables[].vocabularyarray
densityplot.config.variables[].vocabulary[]string
densityplot.config.variables[].imputeZero*boolean
densityplot.config.variables[].hasStudyDependentVocabularyboolean
densityplot.config.variables[].isCollection*boolean
densityplot.config.variables[].membersarray
densityplot.config.variables[].members[]object

Inherits: lib.VariableSpec

densityplot.config.variables[].members[].entityId*string
densityplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HeatmapPostRequest (object)

HeatmapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HeatmapSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • collection
  • series
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.zAxisVariableobject

Inherits: object

config.zAxisVariable.entityId*string
config.zAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type HeatmapSpec (object)

HeatmapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • collection
  • series
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
zAxisVariableobject

Inherits: object

zAxisVariable.entityId*string
zAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Heatmap (object)

Heatmap

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HeatmapData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]array
data[].value[][]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type HeatmapPostResponse (object)

HeatmapPostResponse

Inherits: object

Model

ParameterTypeDescription
heatmap*object

Inherits: object

heatmap.data*array
heatmap.data[]object

Inherits: lib.HeatmapData

heatmap.data[].facetVariableDetailsarray

Max. items: 2

heatmap.data[].facetVariableDetails[]object

Inherits: object

heatmap.data[].facetVariableDetails[].entityId*string
heatmap.data[].facetVariableDetails[].variableId*string
heatmap.data[].facetVariableDetails[].value*string
heatmap.data[].value*array
heatmap.data[].value[]array
heatmap.data[].value[][]number
heatmap.data[].label*array
heatmap.data[].label[]string
heatmap.config*object

Inherits: lib.PlotConfig

heatmap.config.completeCasesAllVars*number
heatmap.config.completeCasesAxesVars*number
heatmap.config.variables*array
heatmap.config.variables[]object

Inherits: object

heatmap.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

heatmap.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

heatmap.config.variables[].variableSpec.entityId*string
heatmap.config.variables[].variableSpec.variableId*string
heatmap.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

heatmap.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

heatmap.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

heatmap.config.variables[].displayNamestring
heatmap.config.variables[].displayRangeMinany
heatmap.config.variables[].displayRangeMaxany
heatmap.config.variables[].vocabularyarray
heatmap.config.variables[].vocabulary[]string
heatmap.config.variables[].imputeZero*boolean
heatmap.config.variables[].hasStudyDependentVocabularyboolean
heatmap.config.variables[].isCollection*boolean
heatmap.config.variables[].membersarray
heatmap.config.variables[].members[]object

Inherits: lib.VariableSpec

heatmap.config.variables[].members[].entityId*string
heatmap.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HistogramPostRequest (object)

HistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HistogramSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramSpec (object)

HistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type HistogramSummary (object)

HistogramSummary

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
min*string
q1*string
median*string
mean*string
q3*string
max*string

Type HistogramConfig (object)

HistogramConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSlider*object

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
summary*object

Additional properties: Yes

Inherits: object

summary.min*string
summary.q1*string
summary.median*string
summary.mean*string
summary.q3*string
summary.max*string
viewport*object

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Histogram (object)

Histogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HistogramData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSlider*object

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.summary*object

Additional properties: Yes

Inherits: object

config.summary.min*string
config.summary.q1*string
config.summary.median*string
config.summary.mean*string
config.summary.q3*string
config.summary.max*string
config.viewport*object

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramPostResponse (object)

HistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: lib.HistogramData

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.config*object

Inherits: lib.PlotConfig

histogram.config.completeCasesAllVars*number
histogram.config.completeCasesAxesVars*number
histogram.config.variables*array
histogram.config.variables[]object

Inherits: object

histogram.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.config.variables[].variableSpec.entityId*string
histogram.config.variables[].variableSpec.variableId*string
histogram.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.config.variables[].displayNamestring
histogram.config.variables[].displayRangeMinany
histogram.config.variables[].displayRangeMaxany
histogram.config.variables[].vocabularyarray
histogram.config.variables[].vocabulary[]string
histogram.config.variables[].imputeZero*boolean
histogram.config.variables[].hasStudyDependentVocabularyboolean
histogram.config.variables[].isCollection*boolean
histogram.config.variables[].membersarray
histogram.config.variables[].members[]object

Inherits: lib.VariableSpec

histogram.config.variables[].members[].entityId*string
histogram.config.variables[].members[].variableId*string
histogram.config.binSlider*object

Inherits: lib.BinSlider

histogram.config.binSlider.min*number
histogram.config.binSlider.max*number
histogram.config.binSlider.step*number
histogram.config.binSpec*object

Inherits: lib.BinSpec

histogram.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
histogram.config.binSpec.valuenumber
histogram.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

histogram.config.binSpec.rangeunion
histogram.config.binSpec.rangeanyOf
Any of the following types.
histogram.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

histogram.config.binSpec.range{NumberRange}..min*number
histogram.config.binSpec.range{NumberRange}..max*number
histogram.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

histogram.config.binSpec.range{DateRange}..min*string
histogram.config.binSpec.range{DateRange}..max*string
histogram.config.summary*object

Additional properties: Yes

Inherits: object

histogram.config.summary.min*string
histogram.config.summary.q1*string
histogram.config.summary.median*string
histogram.config.summary.mean*string
histogram.config.summary.q3*string
histogram.config.summary.max*string
histogram.config.viewport*object

Inherits: lib.NumericViewport

histogram.config.viewport.xMin*string
histogram.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type LineplotPostRequest (object)

LineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.LineplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotSpec (object)

LineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type LineplotConfig (object)

LineplotConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSliderobject

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Lineplot (object)

Lineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.LineplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSliderobject

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotPostResponse (object)

LineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: lib.LineplotData

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.config*object

Inherits: lib.PlotConfig

lineplot.config.completeCasesAllVars*number
lineplot.config.completeCasesAxesVars*number
lineplot.config.variables*array
lineplot.config.variables[]object

Inherits: object

lineplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.config.variables[].variableSpec.entityId*string
lineplot.config.variables[].variableSpec.variableId*string
lineplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.config.variables[].displayNamestring
lineplot.config.variables[].displayRangeMinany
lineplot.config.variables[].displayRangeMaxany
lineplot.config.variables[].vocabularyarray
lineplot.config.variables[].vocabulary[]string
lineplot.config.variables[].imputeZero*boolean
lineplot.config.variables[].hasStudyDependentVocabularyboolean
lineplot.config.variables[].isCollection*boolean
lineplot.config.variables[].membersarray
lineplot.config.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.config.variables[].members[].entityId*string
lineplot.config.variables[].members[].variableId*string
lineplot.config.binSliderobject

Inherits: lib.BinSlider

lineplot.config.binSlider.min*number
lineplot.config.binSlider.max*number
lineplot.config.binSlider.step*number
lineplot.config.binSpecobject

Inherits: lib.BinSpec

lineplot.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
lineplot.config.binSpec.valuenumber
lineplot.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

lineplot.config.binSpec.rangeunion
lineplot.config.binSpec.rangeanyOf
Any of the following types.
lineplot.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

lineplot.config.binSpec.range{NumberRange}..min*number
lineplot.config.binSpec.range{NumberRange}..max*number
lineplot.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

lineplot.config.binSpec.range{DateRange}..min*string
lineplot.config.binSpec.range{DateRange}..max*string
lineplot.config.viewportobject

Inherits: lib.NumericViewport

lineplot.config.viewport.xMin*string
lineplot.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapMarkersOverlayPostRequest (object)

MapMarkersOverlayPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapMarkersOverlaySpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.longitudeVariableobject

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariableobject

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewportobject

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlaySpec (object)

MapMarkersOverlaySpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

longitudeVariableobject

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariableobject

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewportobject

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlayConfig (object)

MapMarkersOverlayConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlay (object)

MapMarkersOverlay

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.MapMarkersOverlayData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlayPostResponse (object)

MapMarkersOverlayPostResponse

Inherits: object

Model

ParameterTypeDescription
mapMarkers*object

Inherits: object

mapMarkers.data*array
mapMarkers.data[]object

Inherits: lib.MapMarkersOverlayData

mapMarkers.data[].facetVariableDetailsarray

Max. items: 2

mapMarkers.data[].facetVariableDetails[]object

Inherits: object

mapMarkers.data[].facetVariableDetails[].entityId*string
mapMarkers.data[].facetVariableDetails[].variableId*string
mapMarkers.data[].facetVariableDetails[].value*string
mapMarkers.data[].value*array
mapMarkers.data[].value[]number
mapMarkers.data[].label*array
mapMarkers.data[].label[]string
mapMarkers.config*object

Inherits: lib.PlotConfig

mapMarkers.config.completeCasesAllVars*number
mapMarkers.config.completeCasesAxesVars*number
mapMarkers.config.variables*array
mapMarkers.config.variables[]object

Inherits: object

mapMarkers.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mapMarkers.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].variableSpec.entityId*string
mapMarkers.config.variables[].variableSpec.variableId*string
mapMarkers.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mapMarkers.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mapMarkers.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mapMarkers.config.variables[].displayNamestring
mapMarkers.config.variables[].displayRangeMinany
mapMarkers.config.variables[].displayRangeMaxany
mapMarkers.config.variables[].vocabularyarray
mapMarkers.config.variables[].vocabulary[]string
mapMarkers.config.variables[].imputeZero*boolean
mapMarkers.config.variables[].hasStudyDependentVocabularyboolean
mapMarkers.config.variables[].isCollection*boolean
mapMarkers.config.variables[].membersarray
mapMarkers.config.variables[].members[]object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].members[].entityId*string
mapMarkers.config.variables[].members[].variableId*string
mapMarkers.config.viewport*object

Inherits: lib.GeolocationViewport

mapMarkers.config.viewport.latitude*object

Inherits: lib.NumericViewport

mapMarkers.config.viewport.latitude.xMin*string
mapMarkers.config.viewport.latitude.xMax*string
mapMarkers.config.viewport.longitude*object

Inherits: lib.LongitudeViewport

mapMarkers.config.viewport.longitude.left*number
mapMarkers.config.viewport.longitude.right*number
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapPostRequest (object)

MapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapSpec (object)

MapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapConfig (object)

MapConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesGeoVar*number

Type MapPostResponse (object)

MapPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.MapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number
config*object

Inherits: object

config.completeCasesGeoVar*number

Type MapElementInfo (object)

MapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type ScatterplotPostRequest (object)

ScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type ScatterplotSpec (object)

ScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Scatterplot (object)

Scatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.ScatterplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotPostResponse (object)

ScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: lib.ScatterplotData

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.config*object

Inherits: lib.PlotConfig

scatterplot.config.completeCasesAllVars*number
scatterplot.config.completeCasesAxesVars*number
scatterplot.config.variables*array
scatterplot.config.variables[]object

Inherits: object

scatterplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.config.variables[].variableSpec.entityId*string
scatterplot.config.variables[].variableSpec.variableId*string
scatterplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.config.variables[].displayNamestring
scatterplot.config.variables[].displayRangeMinany
scatterplot.config.variables[].displayRangeMaxany
scatterplot.config.variables[].vocabularyarray
scatterplot.config.variables[].vocabulary[]string
scatterplot.config.variables[].imputeZero*boolean
scatterplot.config.variables[].hasStudyDependentVocabularyboolean
scatterplot.config.variables[].isCollection*boolean
scatterplot.config.variables[].membersarray
scatterplot.config.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.config.variables[].members[].entityId*string
scatterplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type TablePostRequest (object)

TablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.TableSpec

config.outputEntityId*string
config.outputVariable*array
config.outputVariable[]object

Inherits: object

config.outputVariable[].entityId*string
config.outputVariable[].variableId*string
config.pagingConfig*object

Additional properties: Yes

Inherits: object

config.pagingConfig.numRowsinteger

Format: int64

config.pagingConfig.offsetinteger

Format: int64

Type TableSpec (object)

TableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
outputVariable*array
outputVariable[]object

Inherits: object

outputVariable[].entityId*string
outputVariable[].variableId*string
pagingConfig*object

Additional properties: Yes

Inherits: object

pagingConfig.numRowsinteger

Format: int64

pagingConfig.offsetinteger

Format: int64

Type TablePostResponse (object)

TablePostResponse

Inherits: object

Model

ParameterTypeDescription
columns*array
columns[]object

Inherits: object

columns[].entityId*string
columns[].variableId*string
rows*array
rows[]array
rows[][]string

Type TwoByTwoSpec (object)

TwoByTwoSpec

Inherits: lib.MosaicSpec

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
xAxisReferenceValue*string
yAxisReferenceValue*string

Type TwoByTwoPostRequest (object)

TwoByTwoPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.xAxisReferenceValue*string
config.yAxisReferenceValue*string

Type Statistic (object)

Statistic

Inherits: object

Model

ParameterTypeDescription
value*number
confidenceIntervalstring
confidenceLevelnumber
pvalue*string

Type TwoByTwoStatsTable (object)

TwoByTwoStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
chisq*object

Inherits: object

chisq.value*number
chisq.confidenceIntervalstring
chisq.confidenceLevelnumber
chisq.pvalue*string
fisher*object

Inherits: object

fisher.value*number
fisher.confidenceIntervalstring
fisher.confidenceLevelnumber
fisher.pvalue*string
prevalenceobject

Inherits: object

prevalence.value*number
prevalence.confidenceIntervalstring
prevalence.confidenceLevelnumber
prevalence.pvalue*string
oddsratioobject

Inherits: object

oddsratio.value*number
oddsratio.confidenceIntervalstring
oddsratio.confidenceLevelnumber
oddsratio.pvalue*string
relativeriskobject

Inherits: object

relativerisk.value*number
relativerisk.confidenceIntervalstring
relativerisk.confidenceLevelnumber
relativerisk.pvalue*string
sensitivityobject

Inherits: object

sensitivity.value*number
sensitivity.confidenceIntervalstring
sensitivity.confidenceLevelnumber
sensitivity.pvalue*string
specificityobject

Inherits: object

specificity.value*number
specificity.confidenceIntervalstring
specificity.confidenceLevelnumber
specificity.pvalue*string
posPredictiveValueobject

Inherits: object

posPredictiveValue.value*number
posPredictiveValue.confidenceIntervalstring
posPredictiveValue.confidenceLevelnumber
posPredictiveValue.pvalue*string
negPredictiveValueobject

Inherits: object

negPredictiveValue.value*number
negPredictiveValue.confidenceIntervalstring
negPredictiveValue.confidenceLevelnumber
negPredictiveValue.pvalue*string

Type TwoByTwoPostResponse (object)

TwoByTwoPostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BarplotData (object)

BarplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type MapMarkersOverlayData (object)

MapMarkersOverlayData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type BoxplotData (object)

BoxplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
lowerfence*array
lowerfence[]number
upperfence*array
upperfence[]number
q1*array
q1[]number
q3*array
q3[]number
median*array
median[]number
outliersarray
outliers[]array
outliers[][]number
rawDataarray
rawData[]array
rawData[][]number
meanarray
mean[]number
label*array
label[]string

Type BoxplotStatsTable (object)

BoxplotStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xVariableDetailsobject

Inherits: object

xVariableDetails.entityId*string
xVariableDetails.variableId*string
xVariableDetails.value*string
statistic*string
pvalue*number
parameter*array
parameter[]number
method*string
statsError*string

Type HistogramData (object)

HistogramData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
binStart*array
binStart[]string
binEnd*array
binEnd[]string
binLabel*array
binLabel[]string

Type BinSlider (object)

BinSlider

Inherits: object

Model

ParameterTypeDescription
min*number
max*number
step*number

Type HeatmapData (object)

HeatmapData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]array
value[][]number
label*array
label[]string

Type MosaicPostRequest (object)

MosaicPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type MosaicSpec (object)

MosaicSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type MosaicData (object)

MosaicData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xLabel*array
xLabel[]string
yLabel*array
yLabel[]array
yLabel[][]string
value*array
value[]array
value[][]number

Type Mosaic (object)

Mosaic

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotData (object)

ScatterplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
smoothedMeanXarray
smoothedMeanX[]string
smoothedMeanYarray
smoothedMeanY[]number
smoothedMeanSEarray
smoothedMeanSE[]number
smoothedMeanErrorstring
bestFitLineXarray
bestFitLineX[]string
bestFitLineYarray
bestFitLineY[]number
r2number

Type DensityplotData (object)

DensityplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
densityY*array
densityY[]number
densityX*array
densityX[]number

Type LineplotData (object)

LineplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
binStartarray
binStart[]string
binEndarray
binEnd[]string
binSampleSizearray
binSampleSize[]union

Inherits: lib.SampleSize

binSampleSize[]anyOf
Any of the following types.
binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

binSampleSize[]{SimpleSampleSize}..N*number
binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

binSampleSize[]{ProportionSampleSize}..numeratorN*number
binSampleSize[]{ProportionSampleSize}..denominatorN*number
errorBarsarray
errorBars[]object

Inherits: lib.ErrorBar

errorBars[].lowerBound*number
errorBars[].upperBound*number
errorBars[].error*string

Type PlotConfig (object)

PlotConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type SampleSizeTable (object)

SampleSizeTable

Inherits: object

Model

ParameterTypeDescription
xVariableDetailsarray
xVariableDetails[]object

Inherits: object

xVariableDetails[].entityId*string
xVariableDetails[].variableId*string
xVariableDetails[].value*string
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
size*array
size[]number

Type VariableCompleteCases (object)

VariableCompleteCases

Inherits: object

Model

ParameterTypeDescription
variableDetails*object

Inherits: object

variableDetails.entityId*string
variableDetails.variableId*string
completeCases*number

Type CategoricalDistributionPostRequest (object)

CategoricalDistributionPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.variableId*string

Type CategoricalDistributionBin (object)

CategoricalDistributionBin

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
label*string
value*number

Type CategoricalDistributionPostResponse (object)

CategoricalDistributionPostResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
countDistribution*array
countDistribution[]object

Additional properties: Yes

Inherits: object

countDistribution[].label*string
countDistribution[].value*number
proportionDistribution*array
proportionDistribution[]object

Additional properties: Yes

Inherits: object

proportionDistribution[].label*string
proportionDistribution[].value*number

Type ExampleComputeVizPostRequest (object)

ExampleComputeVizPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ExampleComputeVizSpec

config.prefixVar*object

Inherits: object

config.prefixVar.entityId*string
config.prefixVar.variableId*string
computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.inputVariable*object

Inherits: object

computeConfig.inputVariable.entityId*string
computeConfig.inputVariable.variableId*string
computeConfig.valueSuffix*string

Type ExampleComputeVizSpec (object)

ExampleComputeVizSpec

Inherits: object

Model

ParameterTypeDescription
prefixVar*object

Inherits: object

prefixVar.entityId*string
prefixVar.variableId*string

Type ExampleComputeVizPostResponse (object)

ExampleComputeVizPostResponse

Inherits: object

Model

ParameterTypeDescription
countPluginResult*integer
numEmptyValues*integer
longestConcatenatedValue*string
avgConcatenatedLength*number

Type MultiStreamPostRequest (object)

MultiStreamPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MultiStreamSpec

config.entityId*string

Type MultiStreamSpec (object)

MultiStreamSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostRequest (object)

RecordCountPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.RecordCountSpec

config.entityId*string

Type RecordCountSpec (object)

RecordCountSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostResponse (object)

RecordCountPostResponse

Inherits: object

Model

ParameterTypeDescription
recordCount*integer

Type TestCollectionsPostRequest (object)

TestCollectionsPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.collectionId*string

Type CollectionFloatingBarplotPostRequest (object)

CollectionFloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string

Type CollectionFloatingBarplotSpec (object)

CollectionFloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string

Type CollectionFloatingBoxplotPostRequest (object)

CollectionFloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingBoxplotSpec (object)

CollectionFloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingContTablePostRequest (object)

CollectionFloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.xAxisVariable.collection*object

Inherits: object

config.xAxisVariable.collection.entityId*string
config.xAxisVariable.collection.collectionId*string
config.xAxisVariable.selectedMembers*array
config.xAxisVariable.selectedMembers[]object

Inherits: object

config.xAxisVariable.selectedMembers[].entityId*string
config.xAxisVariable.selectedMembers[].variableId*string
config.xAxisVariable.selectedValuesarray
config.xAxisVariable.selectedValues[]string

Type CollectionFloatingContTableSpec (object)

CollectionFloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

xAxisVariable.collection*object

Inherits: object

xAxisVariable.collection.entityId*string
xAxisVariable.collection.collectionId*string
xAxisVariable.selectedMembers*array
xAxisVariable.selectedMembers[]object

Inherits: object

xAxisVariable.selectedMembers[].entityId*string
xAxisVariable.selectedMembers[].variableId*string
xAxisVariable.selectedValuesarray
xAxisVariable.selectedValues[]string

Type CollectionFloatingHistogramPostRequest (object)

CollectionFloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingHistogramSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.binSpec*object

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingHistogramSpec (object)

CollectionFloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
binSpec*object

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type CollectionFloatingLineplotPostRequest (object)

CollectionFloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string
config.binSpecobject

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingLineplotSpec (object)

CollectionFloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string
binSpecobject

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type StandaloneCollectionMapMarkerPostRequest (object)

StandaloneCollectionMapMarkerPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for a map marker

Inherits: lib.StandaloneCollectionMapMarkerSpec

config.outputEntityId*string

Entity ID associated with collection variable of interest.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number
config.collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.collection.collection*object

Inherits: object

config.collection.collection.entityId*string
config.collection.collection.collectionId*string
config.collection.selectedMembers*array
config.collection.selectedMembers[]object

Inherits: object

config.collection.selectedMembers[].entityId*string
config.collection.selectedMembers[].variableId*string
config.aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type StandaloneCollectionMapMarkerSpec (object)

StandaloneCollectionMapMarkerSpec

Specification for a map marker

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity ID associated with collection variable of interest.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number
collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

collection.collection*object

Inherits: object

collection.collection.entityId*string
collection.collection.collectionId*string
collection.selectedMembers*array
collection.selectedMembers[]object

Inherits: object

collection.selectedMembers[].entityId*string
collection.selectedMembers[].variableId*string
aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type CollectionOverlayConfig (object)

CollectionOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string

Type CollectionMapMarkerElement (object)

CollectionMapMarkerElement

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number
values*array
values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

values[].variableId*string
values[].value*number
values[].confidenceInterval*object

Inherits: lib.NumberRange

values[].confidenceInterval.min*number
values[].confidenceInterval.max*number
values[].n*number

Type CollectionMemberAggregate (object)

CollectionMemberAggregate

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
value*number
confidenceInterval*object

Inherits: lib.NumberRange

confidenceInterval.min*number
confidenceInterval.max*number
n*number

Type StandaloneCollectionMapMarkerPostResponse (object)

StandaloneCollectionMapMarkerPostResponse

Inherits: object

Model

ParameterTypeDescription
markers*array
markers[]object

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

markers[].entityCount*number
markers[].avgLat*number
markers[].avgLon*number
markers[].minLat*number
markers[].minLon*number
markers[].maxLat*number
markers[].maxLon*number
markers[].values*array
markers[].values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

markers[].values[].variableId*string
markers[].values[].value*number
markers[].values[].confidenceInterval*object

Inherits: lib.NumberRange

markers[].values[].confidenceInterval.min*number
markers[].values[].confidenceInterval.max*number
markers[].values[].n*number

Type FloatingBarplotPostRequest (object)

FloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string

Type FloatingBarplotSpec (object)

FloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string

Type FloatingBarplot (object)

FloatingBarplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBarplotPostResponse (object)

FloatingBarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: object

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.variables*array
barplot.variables[]object

Inherits: object

barplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.variables[].variableSpec.entityId*string
barplot.variables[].variableSpec.variableId*string
barplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.variables[].displayNamestring
barplot.variables[].displayRangeMinany
barplot.variables[].displayRangeMaxany
barplot.variables[].vocabularyarray
barplot.variables[].vocabulary[]string
barplot.variables[].imputeZero*boolean
barplot.variables[].hasStudyDependentVocabularyboolean
barplot.variables[].isCollection*boolean
barplot.variables[].membersarray
barplot.variables[].members[]object

Inherits: lib.VariableSpec

barplot.variables[].members[].entityId*string
barplot.variables[].members[].variableId*string

Type FloatingBoxplotPostRequest (object)

FloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplotSpec (object)

FloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplot (object)

FloatingBoxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBoxplotPostResponse (object)

FloatingBoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: object

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.variables*array
boxplot.variables[]object

Inherits: object

boxplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.variables[].variableSpec.entityId*string
boxplot.variables[].variableSpec.variableId*string
boxplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.variables[].displayNamestring
boxplot.variables[].displayRangeMinany
boxplot.variables[].displayRangeMaxany
boxplot.variables[].vocabularyarray
boxplot.variables[].vocabulary[]string
boxplot.variables[].imputeZero*boolean
boxplot.variables[].hasStudyDependentVocabularyboolean
boxplot.variables[].isCollection*boolean
boxplot.variables[].membersarray
boxplot.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.variables[].members[].entityId*string
boxplot.variables[].members[].variableId*string

Type FloatingContTablePostRequest (object)

FloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string

Type FloatingContTableSpec (object)

FloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string

Type FloatingContTable (object)

FloatingContTable

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingContTablePostResponse (object)

FloatingContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: object

mosaic.data*array
mosaic.data[]object

Inherits: object

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.variables*array
mosaic.variables[]object

Inherits: object

mosaic.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.variables[].variableSpec.entityId*string
mosaic.variables[].variableSpec.variableId*string
mosaic.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.variables[].displayNamestring
mosaic.variables[].displayRangeMinany
mosaic.variables[].displayRangeMaxany
mosaic.variables[].vocabularyarray
mosaic.variables[].vocabulary[]string
mosaic.variables[].imputeZero*boolean
mosaic.variables[].hasStudyDependentVocabularyboolean
mosaic.variables[].isCollection*boolean
mosaic.variables[].membersarray
mosaic.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.variables[].members[].entityId*string
mosaic.variables[].members[].variableId*string
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string

Type FloatingHistogramPostRequest (object)

FloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingHistogramSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingHistogramSpec (object)

FloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingHistogram (object)

FloatingHistogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingHistogramPostResponse (object)

FloatingHistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: object

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.variables*array
histogram.variables[]object

Inherits: object

histogram.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.variables[].variableSpec.entityId*string
histogram.variables[].variableSpec.variableId*string
histogram.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.variables[].displayNamestring
histogram.variables[].displayRangeMinany
histogram.variables[].displayRangeMaxany
histogram.variables[].vocabularyarray
histogram.variables[].vocabulary[]string
histogram.variables[].imputeZero*boolean
histogram.variables[].hasStudyDependentVocabularyboolean
histogram.variables[].isCollection*boolean
histogram.variables[].membersarray
histogram.variables[].members[]object

Inherits: lib.VariableSpec

histogram.variables[].members[].entityId*string
histogram.variables[].members[].variableId*string

Type FloatingLineplotPostRequest (object)

FloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingLineplotSpec (object)

FloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingLineplot (object)

FloatingLineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingLineplotPostResponse (object)

FloatingLineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: object

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.variables*array
lineplot.variables[]object

Inherits: object

lineplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.variables[].variableSpec.entityId*string
lineplot.variables[].variableSpec.variableId*string
lineplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.variables[].displayNamestring
lineplot.variables[].displayRangeMinany
lineplot.variables[].displayRangeMaxany
lineplot.variables[].vocabularyarray
lineplot.variables[].vocabulary[]string
lineplot.variables[].imputeZero*boolean
lineplot.variables[].hasStudyDependentVocabularyboolean
lineplot.variables[].isCollection*boolean
lineplot.variables[].membersarray
lineplot.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.variables[].members[].entityId*string
lineplot.variables[].members[].variableId*string

Type FloatingScatterplotPostRequest (object)

FloatingScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingScatterplotSpec

config.outputEntityId*string
config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplotSpec (object)

FloatingScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplot (object)

FloatingScatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingScatterplotPostResponse (object)

FloatingScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: object

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.variables*array
scatterplot.variables[]object

Inherits: object

scatterplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.variables[].variableSpec.entityId*string
scatterplot.variables[].variableSpec.variableId*string
scatterplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.variables[].displayNamestring
scatterplot.variables[].displayRangeMinany
scatterplot.variables[].displayRangeMaxany
scatterplot.variables[].vocabularyarray
scatterplot.variables[].vocabulary[]string
scatterplot.variables[].imputeZero*boolean
scatterplot.variables[].hasStudyDependentVocabularyboolean
scatterplot.variables[].isCollection*boolean
scatterplot.variables[].membersarray
scatterplot.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.variables[].members[].entityId*string
scatterplot.variables[].members[].variableId*string

Type StandaloneMapBubblesLegendPostRequest (object)

StandaloneMapBubblesLegendPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapBubblesLegendSpec

config.outputEntityId*string
config.colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

config.colorLegendConfig.geoAggregateVariable*object

Inherits: object

config.colorLegendConfig.geoAggregateVariable.entityId*string
config.colorLegendConfig.geoAggregateVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.sizeConfig*object

Inherits: lib.SizeLegendConfig

config.sizeConfig.geoAggregateVariable*object

Inherits: object

config.sizeConfig.geoAggregateVariable.entityId*string
config.sizeConfig.geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendSpec (object)

StandaloneMapBubblesLegendSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

colorLegendConfig.geoAggregateVariable*object

Inherits: object

colorLegendConfig.geoAggregateVariable.entityId*string
colorLegendConfig.geoAggregateVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

sizeConfig*object

Inherits: lib.SizeLegendConfig

sizeConfig.geoAggregateVariable*object

Inherits: object

sizeConfig.geoAggregateVariable.entityId*string
sizeConfig.geoAggregateVariable.variableId*string

Type OverlayLegendConfig (object)

OverlayLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

quantitativeOverlayConfig.overlayVariable*object

Inherits: object

quantitativeOverlayConfig.overlayVariable.entityId*string
quantitativeOverlayConfig.overlayVariable.variableId*string
quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type SizeLegendConfig (object)

SizeLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendPostResponse (object)

StandaloneMapBubblesLegendPostResponse

Inherits: object

Model

ParameterTypeDescription
minColorValue*string
maxColorValue*string
minSizeValue*number
maxSizeValue*number

Type StandaloneMapBubblesPostRequest (object)

StandaloneMapBubblesPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for map bubbles.

Inherits: lib.StandaloneMapBubblesSpec

config.outputEntityId*string

Entity whose cardinality will be reported per marker.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapBubblesSpec (object)

StandaloneMapBubblesSpec

Specification for map bubbles.

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity whose cardinality will be reported per marker.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapBubblesPostResponse (object)

StandaloneMapBubblesPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.ColoredMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValue*string
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type ColoredMapElementInfo (object)

ColoredMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValue*string
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type StandaloneMapMarkersPostRequest (object)

StandaloneMapMarkersPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapMarkersSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapMarkersSpec (object)

StandaloneMapMarkersSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapMarkersPostResponse (object)

StandaloneMapMarkersPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.StandaloneMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValues*array
mapElements[].overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

mapElements[].overlayValues[].binStart*string
mapElements[].overlayValues[].binEnd*string
mapElements[].overlayValues[].binLabel*string
mapElements[].overlayValues[].value*number
mapElements[].overlayValues[].count*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type OverlayType (string)

OverlayType
Enum:
  • continuous
  • categorical

Inherits: string

Type OverlayConfig (object)

OverlayConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type ContinousOverlayConfig (object)

ContinousOverlayConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRange

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string

Type CategoricalOverlayConfig (object)

CategoricalOverlayConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]string

Type StandaloneMapElementInfo (object)

StandaloneMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string
overlayValues[].value*number
overlayValues[].count*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type DataPluginRequestBase (object)

DataPluginRequestBase

Inherits: object

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

Type EmptyDataPluginSpec (object)

EmptyDataPluginSpec

Inherits: object

Model

ParameterTypeDescription

Type StringBoolean (string)

StringBoolean
Enum:
  • TRUE
  • FALSE

Inherits: string

Type StrataVariableDetails (object)

StrataVariableDetails

Model

ParameterTypeDescription
entityId*string
variableId*string
value*string

Type BinSpec (object)

BinSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
  • numBins
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type BinWidthSpec (object)

BinWidthSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type NumberRange (object)

NumberRange

Inherits: object

Model

ParameterTypeDescription
min*number
max*number

Type DateRange (object)

DateRange

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type NumericViewport (object)

NumericViewport

Inherits: object

Model

ParameterTypeDescription
xMin*string
xMax*string

Type LongitudeViewport (object)

LongitudeViewport

Inherits: object

Model

ParameterTypeDescription
left*number
right*number

Type GeolocationViewport (object)

GeolocationViewport

Inherits: object

Model

ParameterTypeDescription
latitude*object

Inherits: object

latitude.xMin*string
latitude.xMax*string
longitude*object

Inherits: object

longitude.left*number
longitude.right*number

Type ErrorBar (object)

ErrorBar

Inherits: object

Model

ParameterTypeDescription
lowerBound*number
upperBound*number
error*string

Type SimpleSampleSize (object)

SimpleSampleSize

Inherits: object

Model

ParameterTypeDescription
N*number

Type ProportionSampleSize (object)

ProportionSampleSize

Inherits: object

Model

ParameterTypeDescription
numeratorN*number
denominatorN*number

Type SampleSize (union)

SampleSize

Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize

Model

ParameterTypeDescription
anyOf
Any of the following types.
{SimpleSampleSize}object

Inherits: object

{SimpleSampleSize}.N*number
{ProportionSampleSize}object

Inherits: object

{ProportionSampleSize}.numeratorN*number
{ProportionSampleSize}.denominatorN*number

Type ShowMissingness (string)

ShowMissingness
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type ShowMissingnessNoAxes (string)

ShowMissingnessNoAxes
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type BoxplotWith1ComputeSpec (object)

BoxplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: string

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: string

xAxisVariableobject

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type ScatterplotWith1ComputeSpec (object)

ScatterplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Aggregator (string)

Aggregator
Enum:
  • mean
  • median

Inherits: string

Type QuantitativeOverlayConfig (object)

QuantitativeOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type QuantitativeAggregationConfig (object)

QuantitativeAggregationConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type ContinuousAggregationConfig (object)

ContinuousAggregationConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

aggregator*string
Enum:
  • mean
  • median

Inherits: string

Type CategoricalAggregationConfig (object)

CategoricalAggregationConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

numeratorValues*array
numeratorValues[]string
denominatorValues*array
denominatorValues[]string

Type CollectionOverlayConfigWithValues (object)

CollectionOverlayConfigWithValues

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string
selectedValuesarray
selectedValues[]string

Type LegacyLabeledRange (object)

LegacyLabeledRange

Inherits: object

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string

Type LegacyLabeledRangeWithCountAndValue (object)

LegacyLabeledRangeWithCountAndValue

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string
value*number
count*number

Type Error (object)

Error

Discriminator: status

Inherits: object

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Type ErrorType (string)

ErrorType
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: string

Type BadRequestError (object)

Bad Request

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Examples

{
   "status": "bad-request",
   "message": "malformed JSON"
 }

Type UnauthorizedError (object)

Unauthorized

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Examples

{
diff --git a/schema/library.raml b/schema/library.raml
index a9b8ea3a..53279a33 100644
--- a/schema/library.raml
+++ b/schema/library.raml
@@ -866,6 +866,12 @@ types:
       correlationCoefThreshold:
         type: number
         required: false
+  CorrelationBipartiteNetworkPostResponse:
+    type: BipartiteNetworkPostResponse
+    additionalProperties: false
+    properties:
+      significanceThreshold: number
+      correlationCoefThreshold: number
   CorrelationAssayAssayBipartitenetworkPostRequest:
     type: DataPluginRequestBase
     properties:
diff --git a/src/main/resources/api.html b/src/main/resources/api.html
index ec8f20f3..ba8c9753 100644
--- a/src/main/resources/api.html
+++ b/src/main/resources/api.html
@@ -1222,7 +1222,7 @@
 	bindFilters();
 
 });
-		

EDA Workspace Data Service API vv1.0.0

link

Resources

post /filter-aware-metadata/continuous-variable

 

Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.

curl -X POST \
+		

EDA Workspace Data Service API vv1.0.0

link

Resources

post /filter-aware-metadata/continuous-variable

 

Returns equal interval, quantile and standard deviation based bin ranges and/or the median for a continuous variable over a specified range.

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
   undefined/filter-aware-metadata/continuous-variable

Request Body chevron_right expand_more

ContinuousVariableMetadataPostRequest ContinuousVariableMetadataPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ContinuousVariableMetadataSpec

config.variable*object

Inherits: object

config.variable.entityId*string
config.variable.variableId*string
config.metadata*array
config.metadata[]string
Enum:
  • binRanges
  • median

200 OK chevron_right expand_more

ContinuousVariableMetadataPostResponse ContinuousVariableMetadataPostResponse

application/json

Inherits: object

ParameterTypeDescription
binRangesobject

Inherits: object

binRanges.equalInterval*array
binRanges.equalInterval[]object

Inherits: lib.Range

binRanges.equalInterval[].min*string
binRanges.equalInterval[].max*string
binRanges.equalInterval[].label*string
binRanges.quantile*array
binRanges.quantile[]object

Inherits: lib.Range

binRanges.quantile[].min*string
binRanges.quantile[].max*string
binRanges.quantile[].label*string
binRanges.standardDeviation*array
binRanges.standardDeviation[]object

Inherits: lib.Range

binRanges.standardDeviation[].min*string
binRanges.standardDeviation[].max*string
binRanges.standardDeviation[].label*string
mediannumber

get /apps

 

200 OK chevron_right expand_more

AppsGetResponse AppsGetResponse

application/json

Additional properties: Yes

Inherits: object

ParameterTypeDescription
apps*array
apps[]object

Inherits: lib.AppOverview

apps[].name*string
apps[].displayName*string
apps[].description*string
apps[].projects*array
apps[].projects[]string
apps[].computeNamestring
apps[].visualizations*array
apps[].visualizations[]object

Inherits: lib.VisualizationOverview

apps[].visualizations[].name*string
apps[].visualizations[].displayName*string
apps[].visualizations[].description*string
apps[].visualizations[].projects*array
apps[].visualizations[].projects[]string
apps[].visualizations[].maxPanels*number
apps[].visualizations[].dataElementConstraintsarray
apps[].visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

apps[].visualizations[].dataElementConstraints[].//*object

Inherits: object

apps[].visualizations[].dataElementConstraints[].//.isRequired*boolean
apps[].visualizations[].dataElementConstraints[].//.isTemporal*boolean
apps[].visualizations[].dataElementConstraints[].//.isCollection*boolean
apps[].visualizations[].dataElementConstraints[].//.isCompositional*boolean
apps[].visualizations[].dataElementConstraints[].//.isProportion*boolean
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
apps[].visualizations[].dataElementConstraints[].//.minNumVars*number
apps[].visualizations[].dataElementConstraints[].//.maxNumVars*number
apps[].visualizations[].dataElementConstraints[].//.minNumValues*number
apps[].visualizations[].dataElementConstraints[].//.maxNumValues*number
apps[].visualizations[].dataElementConstraints[].//.allowedTypesarray
apps[].visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

apps[].visualizations[].dataElementConstraints[].//.allowedShapesarray
apps[].visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

apps[].visualizations[].dataElementConstraints[].//.description*string
apps[].visualizations[].dataElementDependencyOrderarray
apps[].visualizations[].dataElementDependencyOrder[]array
apps[].visualizations[].dataElementDependencyOrder[][]string

post /apps/standalone-map/visualizations/map-markers

 

Returns data required to make Standalone Map markers

curl -X POST \
@@ -1339,10 +1339,10 @@
   undefined/apps/differentialabundance/visualizations/volcanoplot

Request Body chevron_right expand_more

DifferentialAbundanceVolcanoplotPostRequest DifferentialAbundanceVolcanoplotPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

computeConfig.comparator.variable*object

Inherits: object

computeConfig.comparator.variable.entityId*string
computeConfig.comparator.variable.variableId*string
computeConfig.comparator.groupA*array
computeConfig.comparator.groupA[]object

Inherits: lib.Range

computeConfig.comparator.groupA[].min*string
computeConfig.comparator.groupA[].max*string
computeConfig.comparator.groupA[].label*string
computeConfig.comparator.groupB*array
computeConfig.comparator.groupB[]object

Inherits: lib.Range

computeConfig.comparator.groupB[].min*string
computeConfig.comparator.groupB[].max*string
computeConfig.comparator.groupB[].label*string
computeConfig.differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

computeConfig.pValueFloorstring
config*object

Inherits: lib.EmptyDataPluginSpec

200 OK chevron_right expand_more

DifferentialAbundanceStatsResponse DifferentialAbundanceStatsResponse

application/json

Additional properties: Yes

Inherits: object

ParameterTypeDescription
effectSizeLabel*string
statistics*object

Additional properties: Yes

Inherits: object

statistics.effectSize*array
statistics.effectSize[]string
statistics.pValue*array
statistics.pValue[]string
statistics.adjustedPValue*array
statistics.adjustedPValue[]string
statistics.pointId*array
statistics.pointId[]string
pvalueFloorstring
adjustedPValueFloorstring

post /apps/correlationassayassay/visualizations/bipartitenetwork

 

Returns data required to create a bipartite network from a correlation matrix.

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
-  undefined/apps/correlationassayassay/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

BipartiteNetworkPostResponse BipartiteNetworkPostResponse

application/json

Inherits: object

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

post /apps/correlationassaymetadata/visualizations/bipartitenetwork

 

Returns data required to create a bipartite network from a correlation matrix.

curl -X POST \
+  undefined/apps/correlationassayassay/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayAssayBipartitenetworkPostRequest CorrelationAssayAssayBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse

application/json

ParameterTypeDescription
bipartitenetwork*object

Inherits: lib.BipartiteNetwork

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: lib.LinkData

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string
significanceThreshold*number
correlationCoefThreshold*number

post /apps/correlationassaymetadata/visualizations/bipartitenetwork

 

Returns data required to create a bipartite network from a correlation matrix.

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
-  undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

BipartiteNetworkPostResponse BipartiteNetworkPostResponse

application/json

Inherits: object

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

post /apps/distributions/visualizations/histogram

 

Returns data required to create a histogram visualization.
Java impl- NA
R impl- working

curl -X POST \
+  undefined/apps/correlationassaymetadata/visualizations/bipartitenetwork

Request Body chevron_right expand_more

CorrelationAssayMetadataBipartitenetworkPostRequest CorrelationAssayMetadataBipartitenetworkPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

200 OK chevron_right expand_more

CorrelationBipartiteNetworkPostResponse CorrelationBipartiteNetworkPostResponse

application/json

ParameterTypeDescription
bipartitenetwork*object

Inherits: lib.BipartiteNetwork

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: lib.LinkData

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string
significanceThreshold*number
correlationCoefThreshold*number

post /apps/distributions/visualizations/histogram

 

Returns data required to create a histogram visualization.
Java impl- NA
R impl- working

curl -X POST \
   -H "Content-type: application/json"
   -d @body.json \
   undefined/apps/distributions/visualizations/histogram

Request Body chevron_right expand_more

HistogramPostRequest HistogramPostRequest

application/json

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HistogramSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

200 OK chevron_right expand_more

HistogramPostResponse HistogramPostResponse

application/json

Inherits: object

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: lib.HistogramData

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.config*object

Inherits: lib.PlotConfig

histogram.config.completeCasesAllVars*number
histogram.config.completeCasesAxesVars*number
histogram.config.variables*array
histogram.config.variables[]object

Inherits: object

histogram.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.config.variables[].variableSpec.entityId*string
histogram.config.variables[].variableSpec.variableId*string
histogram.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.config.variables[].displayNamestring
histogram.config.variables[].displayRangeMinany
histogram.config.variables[].displayRangeMaxany
histogram.config.variables[].vocabularyarray
histogram.config.variables[].vocabulary[]string
histogram.config.variables[].imputeZero*boolean
histogram.config.variables[].hasStudyDependentVocabularyboolean
histogram.config.variables[].isCollection*boolean
histogram.config.variables[].membersarray
histogram.config.variables[].members[]object

Inherits: lib.VariableSpec

histogram.config.variables[].members[].entityId*string
histogram.config.variables[].members[].variableId*string
histogram.config.binSlider*object

Inherits: lib.BinSlider

histogram.config.binSlider.min*number
histogram.config.binSlider.max*number
histogram.config.binSlider.step*number
histogram.config.binSpec*object

Inherits: lib.BinSpec

histogram.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
histogram.config.binSpec.valuenumber
histogram.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

histogram.config.binSpec.rangeunion
histogram.config.binSpec.rangeanyOf
Any of the following types.
histogram.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

histogram.config.binSpec.range{NumberRange}..min*number
histogram.config.binSpec.range{NumberRange}..max*number
histogram.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

histogram.config.binSpec.range{DateRange}..min*string
histogram.config.binSpec.range{DateRange}..max*string
histogram.config.summary*object

Additional properties: Yes

Inherits: object

histogram.config.summary.min*string
histogram.config.summary.q1*string
histogram.config.summary.median*string
histogram.config.summary.mean*string
histogram.config.summary.q3*string
histogram.config.summary.max*string
histogram.config.viewport*object

Inherits: lib.NumericViewport

histogram.config.viewport.xMin*string
histogram.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

post /apps/distributions/visualizations/boxplot

 

Returns data required to create a boxplot visualization
Java impl- NA
R impl- working

curl -X POST \
@@ -1387,7 +1387,7 @@
 }

get /metrics

 

Prometheus metrics for the service.

curl -X GET \
   undefined/metrics

200 OK chevron_right expand_more

text/plain

text/plain

Security Schemes

Security Scheme header-auth

header-auth

Authentication based on a WDK auth cookie.

Headers chevron_right expand_more

ParameterTypeDescription
Auth_Key*string

Authorization header.

curl -X <method> \
   -H "Auth_Key: <value>" \
-  /<path>

Types

Type VariableClass (string)

VariableClass
Enum:
  • native
  • derived
  • computed

Inherits: string

Type PlotReferenceValue (string)

PlotReferenceValue
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

Type VariableMapping (object)

VariableMapping

Inherits: object

Model

ParameterTypeDescription
variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variableSpec*object

Inherits: lib.VariableSpec

variableSpec.entityId*string
variableSpec.variableId*string
plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

displayNamestring
displayRangeMinany
displayRangeMaxany
vocabularyarray
vocabulary[]string
imputeZero*boolean
hasStudyDependentVocabularyboolean
isCollection*boolean
membersarray
members[]object

Inherits: lib.VariableSpec

members[].entityId*string
members[].variableId*string

Type API_Filter (object)

API_Filter

Additional properties: Yes

Discriminator: type

Inherits: object

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

Type API_FilterType (string)

API_FilterType
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: string

Type API_BooleanOperationType (string)

API_BooleanOperationType
Enum:
  • intersect
  • union

Inherits: string

Type API_MultiFilterSubFilter (object)

API_MultiFilterSubFilter

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
stringSet*array
stringSet[]string

Type API_MultiFilter (object)

API_MultiFilter

Additional properties: Yes

Discriminator: type

Discriminator value: multiFilter

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

operation*string
Enum:
  • intersect
  • union

Inherits: string

variableId*string
subFilters*array
subFilters[]object

Additional properties: Yes

Inherits: object

subFilters[].variableId*string
subFilters[].stringSet*array
subFilters[].stringSet[]string

Type API_StringSetFilter (object)

API_StringSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: stringSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
stringSet*array
stringSet[]string

Type API_NumberSetFilter (object)

API_NumberSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
numberSet*array
numberSet[]number

Type API_DateSetFilter (object)

API_DateSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
dateSet*array
dateSet[]string

Type API_NumberRangeFilter (object)

API_NumberRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*number
max*number

Type API_DateRangeFilter (object)

API_DateRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*string
max*string

Type API_LongitudeRangeFilter (object)

API_LongitudeRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: longitudeRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
left*number
right*number

Type DerivedVariableSpec (object)

DerivedVariableSpec

Model

ParameterTypeDescription
entityId*string
variableId*string
functionName*string
displayName*string
config*object

Type VariableSpec (object)

VariableSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
variableId*string

Type CollectionSpec (object)

CollectionSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
collectionId*string

Type DataElementConstraint (object)

DataElementConstraint

Inherits: object

Model

ParameterTypeDescription
isRequired*boolean
isTemporal*boolean
isCollection*boolean
isCompositional*boolean
isProportion*boolean
allowedNormalizationMethods*array
allowedNormalizationMethods[]string
minNumVars*number
maxNumVars*number
minNumValues*number
maxNumValues*number
allowedTypesarray
allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

allowedShapesarray
allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

description*string

Type DataElementConstraintPattern (object)

DataElementConstraintPattern

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
//*object

Inherits: object

//.isRequired*boolean
//.isTemporal*boolean
//.isCollection*boolean
//.isCompositional*boolean
//.isProportion*boolean
//.allowedNormalizationMethods*array
//.allowedNormalizationMethods[]string
//.minNumVars*number
//.maxNumVars*number
//.minNumValues*number
//.maxNumValues*number
//.allowedTypesarray
//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

//.allowedShapesarray
//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

//.description*string

Type EntityTabularPostResponse (object)

EntityTabularPostResponse

Inherits: object

Model

ParameterTypeDescription
tabular*array
tabular[]array
tabular[][]string

Type Range (object)

Range

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type LabeledRange (object)

LabeledRange

Inherits: lib.Range

Model

ParameterTypeDescription
min*string
max*string
label*string

Type API_VariableType (string)

API_VariableType
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: string

Type API_VariableDataShape (string)

API_VariableDataShape
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: string

Type API_PagingConfig (object)

API_PagingConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
numRowsinteger

Format: int64

offsetinteger

Format: int64

Type BinUnits (string)

BinUnits
Enum:
  • day
  • week
  • month
  • year

Inherits: string

Type ValueSpec (string)

ValueSpec
Enum:
  • count
  • proportion

Inherits: string

Type AlphaDivComputeConfig (object)

AlphaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

Type AlphaDivMethod (string)

AlphaDivMethod
Enum:
  • shannon
  • simpson
  • evenness

Inherits: string

Type BetaDivComputeConfig (object)

BetaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

Type BetaDivDissimilarityMethod (string)

BetaDivDissimilarityMethod
Enum:
  • bray
  • jaccard
  • jsd

Inherits: string

Type CorrelationComputeConfig (object)

CorrelationComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

Type CorrelationMethod (string)

CorrelationMethod
Enum:
  • spearman
  • pearson

Inherits: string

Type Correlation1Collection (object)

Correlation1Collection

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string

Type Correlation2Collections (object)

Correlation2Collections

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable1*object

Inherits: object

collectionVariable1.entityId*string
collectionVariable1.collectionId*string
collectionVariable2*object

Inherits: object

collectionVariable2.entityId*string
collectionVariable2.collectionId*string

Type DifferentialAbundanceComputeConfig (object)

DifferentialAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

comparator.variable*object

Inherits: object

comparator.variable.entityId*string
comparator.variable.variableId*string
comparator.groupA*array
comparator.groupA[]object

Inherits: lib.Range

comparator.groupA[].min*string
comparator.groupA[].max*string
comparator.groupA[].label*string
comparator.groupB*array
comparator.groupB[]object

Inherits: lib.Range

comparator.groupB[].min*string
comparator.groupB[].max*string
comparator.groupB[].label*string
differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

pValueFloorstring

Type DifferentialAbundanceMethod (string)

DifferentialAbundanceMethod
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: string

Type ComparatorSpec (object)

ComparatorSpec

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
groupA*array
groupA[]object

Inherits: lib.Range

groupA[].min*string
groupA[].max*string
groupA[].label*string
groupB*array
groupB[]object

Inherits: lib.Range

groupB[].min*string
groupB[].max*string
groupB[].label*string

Type DifferentialAbundanceStats (object)

DifferentialAbundanceStats

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSize*array
effectSize[]string
pValue*array
pValue[]string
adjustedPValue*array
adjustedPValue[]string
pointId*array
pointId[]string

Type DifferentialAbundanceStatsResponse (object)

DifferentialAbundanceStatsResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSizeLabel*string
statistics*object

Additional properties: Yes

Inherits: object

statistics.effectSize*array
statistics.effectSize[]string
statistics.pValue*array
statistics.pValue[]string
statistics.adjustedPValue*array
statistics.adjustedPValue[]string
statistics.pointId*array
statistics.pointId[]string
pvalueFloorstring
adjustedPValueFloorstring

Type ExampleComputeConfig (object)

ExampleComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
inputVariable*object

Inherits: object

inputVariable.entityId*string
inputVariable.variableId*string
valueSuffix*string

Type RankedAbundanceComputeConfig (object)

RankedAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

Type RankingMethod (string)

RankingMethod
Enum:
  • median
  • q3
  • variance
  • max

Inherits: string

Type AbundanceBoxplotPostRequest (object)

AbundanceBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AbundanceScatterplotPostRequest (object)

AbundanceScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivBoxplotPostRequest (object)

AlphaDivBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivScatterplotPostRequest (object)

AlphaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AppsGetResponse (object)

AppsGetResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
apps*array
apps[]object

Inherits: lib.AppOverview

apps[].name*string
apps[].displayName*string
apps[].description*string
apps[].projects*array
apps[].projects[]string
apps[].computeNamestring
apps[].visualizations*array
apps[].visualizations[]object

Inherits: lib.VisualizationOverview

apps[].visualizations[].name*string
apps[].visualizations[].displayName*string
apps[].visualizations[].description*string
apps[].visualizations[].projects*array
apps[].visualizations[].projects[]string
apps[].visualizations[].maxPanels*number
apps[].visualizations[].dataElementConstraintsarray
apps[].visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

apps[].visualizations[].dataElementConstraints[].//*object

Inherits: object

apps[].visualizations[].dataElementConstraints[].//.isRequired*boolean
apps[].visualizations[].dataElementConstraints[].//.isTemporal*boolean
apps[].visualizations[].dataElementConstraints[].//.isCollection*boolean
apps[].visualizations[].dataElementConstraints[].//.isCompositional*boolean
apps[].visualizations[].dataElementConstraints[].//.isProportion*boolean
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
apps[].visualizations[].dataElementConstraints[].//.minNumVars*number
apps[].visualizations[].dataElementConstraints[].//.maxNumVars*number
apps[].visualizations[].dataElementConstraints[].//.minNumValues*number
apps[].visualizations[].dataElementConstraints[].//.maxNumValues*number
apps[].visualizations[].dataElementConstraints[].//.allowedTypesarray
apps[].visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

apps[].visualizations[].dataElementConstraints[].//.allowedShapesarray
apps[].visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

apps[].visualizations[].dataElementConstraints[].//.description*string
apps[].visualizations[].dataElementDependencyOrderarray
apps[].visualizations[].dataElementDependencyOrder[]array
apps[].visualizations[].dataElementDependencyOrder[][]string

Type AppOverview (object)

AppOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
computeNamestring
visualizations*array
visualizations[]object

Inherits: lib.VisualizationOverview

visualizations[].name*string
visualizations[].displayName*string
visualizations[].description*string
visualizations[].projects*array
visualizations[].projects[]string
visualizations[].maxPanels*number
visualizations[].dataElementConstraintsarray
visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

visualizations[].dataElementConstraints[].//*object

Inherits: object

visualizations[].dataElementConstraints[].//.isRequired*boolean
visualizations[].dataElementConstraints[].//.isTemporal*boolean
visualizations[].dataElementConstraints[].//.isCollection*boolean
visualizations[].dataElementConstraints[].//.isCompositional*boolean
visualizations[].dataElementConstraints[].//.isProportion*boolean
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
visualizations[].dataElementConstraints[].//.minNumVars*number
visualizations[].dataElementConstraints[].//.maxNumVars*number
visualizations[].dataElementConstraints[].//.minNumValues*number
visualizations[].dataElementConstraints[].//.maxNumValues*number
visualizations[].dataElementConstraints[].//.allowedTypesarray
visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

visualizations[].dataElementConstraints[].//.allowedShapesarray
visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

visualizations[].dataElementConstraints[].//.description*string
visualizations[].dataElementDependencyOrderarray
visualizations[].dataElementDependencyOrder[]array
visualizations[].dataElementDependencyOrder[][]string

Type VisualizationOverview (object)

VisualizationOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
maxPanels*number
dataElementConstraintsarray
dataElementConstraints[]object

Additional properties: Yes

Inherits: object

dataElementConstraints[].//*object

Inherits: object

dataElementConstraints[].//.isRequired*boolean
dataElementConstraints[].//.isTemporal*boolean
dataElementConstraints[].//.isCollection*boolean
dataElementConstraints[].//.isCompositional*boolean
dataElementConstraints[].//.isProportion*boolean
dataElementConstraints[].//.allowedNormalizationMethods*array
dataElementConstraints[].//.allowedNormalizationMethods[]string
dataElementConstraints[].//.minNumVars*number
dataElementConstraints[].//.maxNumVars*number
dataElementConstraints[].//.minNumValues*number
dataElementConstraints[].//.maxNumValues*number
dataElementConstraints[].//.allowedTypesarray
dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataElementConstraints[].//.allowedShapesarray
dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

dataElementConstraints[].//.description*string
dataElementDependencyOrderarray
dataElementDependencyOrder[]array
dataElementDependencyOrder[][]string

Type BetaDivScatterplotPostRequest (object)

BetaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

config*object

Inherits: lib.BetaDivScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string

Type BetaDivScatterplotSpec (object)

BetaDivScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type CorrelationBipartitenetworkSpec (object)

CorrelationBipartitenetworkSpec

Inherits: object

Model

ParameterTypeDescription
significanceThresholdnumber
correlationCoefThresholdnumber

Type CorrelationAssayAssayBipartitenetworkPostRequest (object)

CorrelationAssayAssayBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)

CorrelationAssayMetadataBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type DifferentialAbundanceVolcanoplotPostRequest (object)

DifferentialAbundanceVolcanoplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

computeConfig.comparator.variable*object

Inherits: object

computeConfig.comparator.variable.entityId*string
computeConfig.comparator.variable.variableId*string
computeConfig.comparator.groupA*array
computeConfig.comparator.groupA[]object

Inherits: lib.Range

computeConfig.comparator.groupA[].min*string
computeConfig.comparator.groupA[].max*string
computeConfig.comparator.groupA[].label*string
computeConfig.comparator.groupB*array
computeConfig.comparator.groupB[]object

Inherits: lib.Range

computeConfig.comparator.groupB[].min*string
computeConfig.comparator.groupB[].max*string
computeConfig.comparator.groupB[].label*string
computeConfig.differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

computeConfig.pValueFloorstring
config*object

Inherits: lib.EmptyDataPluginSpec

Type ContinuousVariableMetadataPostRequest (object)

ContinuousVariableMetadataPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ContinuousVariableMetadataSpec

config.variable*object

Inherits: object

config.variable.entityId*string
config.variable.variableId*string
config.metadata*array
config.metadata[]string
Enum:
  • binRanges
  • median

Type ContinuousVariableMetadataSpec (object)

ContinuousVariableMetadataSpec

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
metadata*array
metadata[]string
Enum:
  • binRanges
  • median

Type AllBinRanges (object)

AllBinRanges

Inherits: object

Model

ParameterTypeDescription
equalInterval*array
equalInterval[]object

Inherits: lib.Range

equalInterval[].min*string
equalInterval[].max*string
equalInterval[].label*string
quantile*array
quantile[]object

Inherits: lib.Range

quantile[].min*string
quantile[].max*string
quantile[].label*string
standardDeviation*array
standardDeviation[]object

Inherits: lib.Range

standardDeviation[].min*string
standardDeviation[].max*string
standardDeviation[].label*string

Type ContinuousVariableMetadataPostResponse (object)

ContinuousVariableMetadataPostResponse

Inherits: object

Model

ParameterTypeDescription
binRangesobject

Inherits: object

binRanges.equalInterval*array
binRanges.equalInterval[]object

Inherits: lib.Range

binRanges.equalInterval[].min*string
binRanges.equalInterval[].max*string
binRanges.equalInterval[].label*string
binRanges.quantile*array
binRanges.quantile[]object

Inherits: lib.Range

binRanges.quantile[].min*string
binRanges.quantile[].max*string
binRanges.quantile[].label*string
binRanges.standardDeviation*array
binRanges.standardDeviation[]object

Inherits: lib.Range

binRanges.standardDeviation[].min*string
binRanges.standardDeviation[].max*string
binRanges.standardDeviation[].label*string
mediannumber

Type NodeData (object)

NodeData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
id*string

Type LinkData (object)

LinkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
source*object

Additional properties: Yes

Inherits: object

source.id*string
target*object

Additional properties: Yes

Inherits: object

target.id*string
strokeWidth*string
color*string

Type NetworkData (object)

NetworkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string

Type NetworkConfig (object)

NetworkConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type BipartiteNetworkConfig (object)

BipartiteNetworkConfig

Additional properties: Yes

Inherits: lib.NetworkConfig

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
column1Metadata*string
column2Metadata*string

Type BipartiteNetworkData (object)

BipartiteNetworkData

Additional properties: Yes

Inherits: lib.NetworkData

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string
column1NodeIDs*array
column1NodeIDs[]string
column2NodeIDs*array
column2NodeIDs[]string

Type BipartiteNetwork (object)

BipartiteNetwork

Inherits: object

Model

ParameterTypeDescription
data*object

Additional properties: Yes

Inherits: lib.NetworkData

data.nodes*array
data.nodes[]object

Additional properties: Yes

Inherits: object

data.nodes[].id*string
data.links*array
data.links[]object

Additional properties: Yes

Inherits: object

data.links[].source*object

Additional properties: Yes

Inherits: object

data.links[].source.id*string
data.links[].target*object

Additional properties: Yes

Inherits: object

data.links[].target.id*string
data.links[].strokeWidth*string
data.links[].color*string
data.column1NodeIDs*array
data.column1NodeIDs[]string
data.column2NodeIDs*array
data.column2NodeIDs[]string
config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

config.variablesarray
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.column1Metadata*string
config.column2Metadata*string

Type BipartiteNetworkPostResponse (object)

BipartiteNetworkPostResponse

Inherits: object

Model

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

Type BarplotPostRequest (object)

BarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BarplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type BarplotSpec (object)

BarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Barplot (object)

Barplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BarplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BarplotPostResponse (object)

BarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: lib.BarplotData

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.config*object

Inherits: lib.PlotConfig

barplot.config.completeCasesAllVars*number
barplot.config.completeCasesAxesVars*number
barplot.config.variables*array
barplot.config.variables[]object

Inherits: object

barplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.config.variables[].variableSpec.entityId*string
barplot.config.variables[].variableSpec.variableId*string
barplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.config.variables[].displayNamestring
barplot.config.variables[].displayRangeMinany
barplot.config.variables[].displayRangeMaxany
barplot.config.variables[].vocabularyarray
barplot.config.variables[].vocabulary[]string
barplot.config.variables[].imputeZero*boolean
barplot.config.variables[].hasStudyDependentVocabularyboolean
barplot.config.variables[].isCollection*boolean
barplot.config.variables[].membersarray
barplot.config.variables[].members[]object

Inherits: lib.VariableSpec

barplot.config.variables[].members[].entityId*string
barplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BoxplotPostRequest (object)

BoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BoxplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type BoxplotSpec (object)

BoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Boxplot (object)

Boxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BoxplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BoxplotPostResponse (object)

BoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: lib.BoxplotData

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.config*object

Inherits: lib.PlotConfig

boxplot.config.completeCasesAllVars*number
boxplot.config.completeCasesAxesVars*number
boxplot.config.variables*array
boxplot.config.variables[]object

Inherits: object

boxplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.config.variables[].variableSpec.entityId*string
boxplot.config.variables[].variableSpec.variableId*string
boxplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.config.variables[].displayNamestring
boxplot.config.variables[].displayRangeMinany
boxplot.config.variables[].displayRangeMaxany
boxplot.config.variables[].vocabularyarray
boxplot.config.variables[].vocabulary[]string
boxplot.config.variables[].imputeZero*boolean
boxplot.config.variables[].hasStudyDependentVocabularyboolean
boxplot.config.variables[].isCollection*boolean
boxplot.config.variables[].membersarray
boxplot.config.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.config.variables[].members[].entityId*string
boxplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number
statsTablearray
statsTable[]object

Inherits: lib.BoxplotStatsTable

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].xVariableDetailsobject

Inherits: object

statsTable[].xVariableDetails.entityId*string
statsTable[].xVariableDetails.variableId*string
statsTable[].xVariableDetails.value*string
statsTable[].statistic*string
statsTable[].pvalue*number
statsTable[].parameter*array
statsTable[].parameter[]number
statsTable[].method*string
statsTable[].statsError*string

Type ContTableStatsTable (object)

ContTableStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
pvalue*array
pvalue[]number
degreesFreedom*array
degreesFreedom[]number
chisq*array
chisq[]number

Type ContTablePostResponse (object)

ContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].pvalue*array
statsTable[].pvalue[]number
statsTable[].degreesFreedom*array
statsTable[].degreesFreedom[]number
statsTable[].chisq*array
statsTable[].chisq[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type DensityplotPostRequest (object)

DensityplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.DensityplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type DensityplotSpec (object)

DensityplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Densityplot (object)

Densityplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.DensityplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].densityY*array
data[].densityY[]number
data[].densityX*array
data[].densityX[]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type DensityplotPostResponse (object)

DensityplotPostResponse

Inherits: object

Model

ParameterTypeDescription
densityplot*object

Inherits: object

densityplot.data*array
densityplot.data[]object

Inherits: lib.DensityplotData

densityplot.data[].overlayVariableDetailsobject

Inherits: object

densityplot.data[].overlayVariableDetails.entityId*string
densityplot.data[].overlayVariableDetails.variableId*string
densityplot.data[].overlayVariableDetails.value*string
densityplot.data[].facetVariableDetailsarray

Max. items: 2

densityplot.data[].facetVariableDetails[]object

Inherits: object

densityplot.data[].facetVariableDetails[].entityId*string
densityplot.data[].facetVariableDetails[].variableId*string
densityplot.data[].facetVariableDetails[].value*string
densityplot.data[].densityY*array
densityplot.data[].densityY[]number
densityplot.data[].densityX*array
densityplot.data[].densityX[]number
densityplot.config*object

Inherits: lib.PlotConfig

densityplot.config.completeCasesAllVars*number
densityplot.config.completeCasesAxesVars*number
densityplot.config.variables*array
densityplot.config.variables[]object

Inherits: object

densityplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

densityplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

densityplot.config.variables[].variableSpec.entityId*string
densityplot.config.variables[].variableSpec.variableId*string
densityplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

densityplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

densityplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

densityplot.config.variables[].displayNamestring
densityplot.config.variables[].displayRangeMinany
densityplot.config.variables[].displayRangeMaxany
densityplot.config.variables[].vocabularyarray
densityplot.config.variables[].vocabulary[]string
densityplot.config.variables[].imputeZero*boolean
densityplot.config.variables[].hasStudyDependentVocabularyboolean
densityplot.config.variables[].isCollection*boolean
densityplot.config.variables[].membersarray
densityplot.config.variables[].members[]object

Inherits: lib.VariableSpec

densityplot.config.variables[].members[].entityId*string
densityplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HeatmapPostRequest (object)

HeatmapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HeatmapSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • collection
  • series
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.zAxisVariableobject

Inherits: object

config.zAxisVariable.entityId*string
config.zAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type HeatmapSpec (object)

HeatmapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • collection
  • series
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
zAxisVariableobject

Inherits: object

zAxisVariable.entityId*string
zAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Heatmap (object)

Heatmap

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HeatmapData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]array
data[].value[][]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type HeatmapPostResponse (object)

HeatmapPostResponse

Inherits: object

Model

ParameterTypeDescription
heatmap*object

Inherits: object

heatmap.data*array
heatmap.data[]object

Inherits: lib.HeatmapData

heatmap.data[].facetVariableDetailsarray

Max. items: 2

heatmap.data[].facetVariableDetails[]object

Inherits: object

heatmap.data[].facetVariableDetails[].entityId*string
heatmap.data[].facetVariableDetails[].variableId*string
heatmap.data[].facetVariableDetails[].value*string
heatmap.data[].value*array
heatmap.data[].value[]array
heatmap.data[].value[][]number
heatmap.data[].label*array
heatmap.data[].label[]string
heatmap.config*object

Inherits: lib.PlotConfig

heatmap.config.completeCasesAllVars*number
heatmap.config.completeCasesAxesVars*number
heatmap.config.variables*array
heatmap.config.variables[]object

Inherits: object

heatmap.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

heatmap.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

heatmap.config.variables[].variableSpec.entityId*string
heatmap.config.variables[].variableSpec.variableId*string
heatmap.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

heatmap.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

heatmap.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

heatmap.config.variables[].displayNamestring
heatmap.config.variables[].displayRangeMinany
heatmap.config.variables[].displayRangeMaxany
heatmap.config.variables[].vocabularyarray
heatmap.config.variables[].vocabulary[]string
heatmap.config.variables[].imputeZero*boolean
heatmap.config.variables[].hasStudyDependentVocabularyboolean
heatmap.config.variables[].isCollection*boolean
heatmap.config.variables[].membersarray
heatmap.config.variables[].members[]object

Inherits: lib.VariableSpec

heatmap.config.variables[].members[].entityId*string
heatmap.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HistogramPostRequest (object)

HistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HistogramSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramSpec (object)

HistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type HistogramSummary (object)

HistogramSummary

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
min*string
q1*string
median*string
mean*string
q3*string
max*string

Type HistogramConfig (object)

HistogramConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSlider*object

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
summary*object

Additional properties: Yes

Inherits: object

summary.min*string
summary.q1*string
summary.median*string
summary.mean*string
summary.q3*string
summary.max*string
viewport*object

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Histogram (object)

Histogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HistogramData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSlider*object

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.summary*object

Additional properties: Yes

Inherits: object

config.summary.min*string
config.summary.q1*string
config.summary.median*string
config.summary.mean*string
config.summary.q3*string
config.summary.max*string
config.viewport*object

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramPostResponse (object)

HistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: lib.HistogramData

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.config*object

Inherits: lib.PlotConfig

histogram.config.completeCasesAllVars*number
histogram.config.completeCasesAxesVars*number
histogram.config.variables*array
histogram.config.variables[]object

Inherits: object

histogram.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.config.variables[].variableSpec.entityId*string
histogram.config.variables[].variableSpec.variableId*string
histogram.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.config.variables[].displayNamestring
histogram.config.variables[].displayRangeMinany
histogram.config.variables[].displayRangeMaxany
histogram.config.variables[].vocabularyarray
histogram.config.variables[].vocabulary[]string
histogram.config.variables[].imputeZero*boolean
histogram.config.variables[].hasStudyDependentVocabularyboolean
histogram.config.variables[].isCollection*boolean
histogram.config.variables[].membersarray
histogram.config.variables[].members[]object

Inherits: lib.VariableSpec

histogram.config.variables[].members[].entityId*string
histogram.config.variables[].members[].variableId*string
histogram.config.binSlider*object

Inherits: lib.BinSlider

histogram.config.binSlider.min*number
histogram.config.binSlider.max*number
histogram.config.binSlider.step*number
histogram.config.binSpec*object

Inherits: lib.BinSpec

histogram.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
histogram.config.binSpec.valuenumber
histogram.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

histogram.config.binSpec.rangeunion
histogram.config.binSpec.rangeanyOf
Any of the following types.
histogram.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

histogram.config.binSpec.range{NumberRange}..min*number
histogram.config.binSpec.range{NumberRange}..max*number
histogram.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

histogram.config.binSpec.range{DateRange}..min*string
histogram.config.binSpec.range{DateRange}..max*string
histogram.config.summary*object

Additional properties: Yes

Inherits: object

histogram.config.summary.min*string
histogram.config.summary.q1*string
histogram.config.summary.median*string
histogram.config.summary.mean*string
histogram.config.summary.q3*string
histogram.config.summary.max*string
histogram.config.viewport*object

Inherits: lib.NumericViewport

histogram.config.viewport.xMin*string
histogram.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type LineplotPostRequest (object)

LineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.LineplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotSpec (object)

LineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type LineplotConfig (object)

LineplotConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSliderobject

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Lineplot (object)

Lineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.LineplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSliderobject

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotPostResponse (object)

LineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: lib.LineplotData

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.config*object

Inherits: lib.PlotConfig

lineplot.config.completeCasesAllVars*number
lineplot.config.completeCasesAxesVars*number
lineplot.config.variables*array
lineplot.config.variables[]object

Inherits: object

lineplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.config.variables[].variableSpec.entityId*string
lineplot.config.variables[].variableSpec.variableId*string
lineplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.config.variables[].displayNamestring
lineplot.config.variables[].displayRangeMinany
lineplot.config.variables[].displayRangeMaxany
lineplot.config.variables[].vocabularyarray
lineplot.config.variables[].vocabulary[]string
lineplot.config.variables[].imputeZero*boolean
lineplot.config.variables[].hasStudyDependentVocabularyboolean
lineplot.config.variables[].isCollection*boolean
lineplot.config.variables[].membersarray
lineplot.config.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.config.variables[].members[].entityId*string
lineplot.config.variables[].members[].variableId*string
lineplot.config.binSliderobject

Inherits: lib.BinSlider

lineplot.config.binSlider.min*number
lineplot.config.binSlider.max*number
lineplot.config.binSlider.step*number
lineplot.config.binSpecobject

Inherits: lib.BinSpec

lineplot.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
lineplot.config.binSpec.valuenumber
lineplot.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

lineplot.config.binSpec.rangeunion
lineplot.config.binSpec.rangeanyOf
Any of the following types.
lineplot.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

lineplot.config.binSpec.range{NumberRange}..min*number
lineplot.config.binSpec.range{NumberRange}..max*number
lineplot.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

lineplot.config.binSpec.range{DateRange}..min*string
lineplot.config.binSpec.range{DateRange}..max*string
lineplot.config.viewportobject

Inherits: lib.NumericViewport

lineplot.config.viewport.xMin*string
lineplot.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapMarkersOverlayPostRequest (object)

MapMarkersOverlayPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapMarkersOverlaySpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.longitudeVariableobject

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariableobject

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewportobject

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlaySpec (object)

MapMarkersOverlaySpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

longitudeVariableobject

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariableobject

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewportobject

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlayConfig (object)

MapMarkersOverlayConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlay (object)

MapMarkersOverlay

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.MapMarkersOverlayData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlayPostResponse (object)

MapMarkersOverlayPostResponse

Inherits: object

Model

ParameterTypeDescription
mapMarkers*object

Inherits: object

mapMarkers.data*array
mapMarkers.data[]object

Inherits: lib.MapMarkersOverlayData

mapMarkers.data[].facetVariableDetailsarray

Max. items: 2

mapMarkers.data[].facetVariableDetails[]object

Inherits: object

mapMarkers.data[].facetVariableDetails[].entityId*string
mapMarkers.data[].facetVariableDetails[].variableId*string
mapMarkers.data[].facetVariableDetails[].value*string
mapMarkers.data[].value*array
mapMarkers.data[].value[]number
mapMarkers.data[].label*array
mapMarkers.data[].label[]string
mapMarkers.config*object

Inherits: lib.PlotConfig

mapMarkers.config.completeCasesAllVars*number
mapMarkers.config.completeCasesAxesVars*number
mapMarkers.config.variables*array
mapMarkers.config.variables[]object

Inherits: object

mapMarkers.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mapMarkers.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].variableSpec.entityId*string
mapMarkers.config.variables[].variableSpec.variableId*string
mapMarkers.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mapMarkers.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mapMarkers.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mapMarkers.config.variables[].displayNamestring
mapMarkers.config.variables[].displayRangeMinany
mapMarkers.config.variables[].displayRangeMaxany
mapMarkers.config.variables[].vocabularyarray
mapMarkers.config.variables[].vocabulary[]string
mapMarkers.config.variables[].imputeZero*boolean
mapMarkers.config.variables[].hasStudyDependentVocabularyboolean
mapMarkers.config.variables[].isCollection*boolean
mapMarkers.config.variables[].membersarray
mapMarkers.config.variables[].members[]object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].members[].entityId*string
mapMarkers.config.variables[].members[].variableId*string
mapMarkers.config.viewport*object

Inherits: lib.GeolocationViewport

mapMarkers.config.viewport.latitude*object

Inherits: lib.NumericViewport

mapMarkers.config.viewport.latitude.xMin*string
mapMarkers.config.viewport.latitude.xMax*string
mapMarkers.config.viewport.longitude*object

Inherits: lib.LongitudeViewport

mapMarkers.config.viewport.longitude.left*number
mapMarkers.config.viewport.longitude.right*number
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapPostRequest (object)

MapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapSpec (object)

MapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapConfig (object)

MapConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesGeoVar*number

Type MapPostResponse (object)

MapPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.MapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number
config*object

Inherits: object

config.completeCasesGeoVar*number

Type MapElementInfo (object)

MapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type ScatterplotPostRequest (object)

ScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type ScatterplotSpec (object)

ScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Scatterplot (object)

Scatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.ScatterplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotPostResponse (object)

ScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: lib.ScatterplotData

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.config*object

Inherits: lib.PlotConfig

scatterplot.config.completeCasesAllVars*number
scatterplot.config.completeCasesAxesVars*number
scatterplot.config.variables*array
scatterplot.config.variables[]object

Inherits: object

scatterplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.config.variables[].variableSpec.entityId*string
scatterplot.config.variables[].variableSpec.variableId*string
scatterplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.config.variables[].displayNamestring
scatterplot.config.variables[].displayRangeMinany
scatterplot.config.variables[].displayRangeMaxany
scatterplot.config.variables[].vocabularyarray
scatterplot.config.variables[].vocabulary[]string
scatterplot.config.variables[].imputeZero*boolean
scatterplot.config.variables[].hasStudyDependentVocabularyboolean
scatterplot.config.variables[].isCollection*boolean
scatterplot.config.variables[].membersarray
scatterplot.config.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.config.variables[].members[].entityId*string
scatterplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type TablePostRequest (object)

TablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.TableSpec

config.outputEntityId*string
config.outputVariable*array
config.outputVariable[]object

Inherits: object

config.outputVariable[].entityId*string
config.outputVariable[].variableId*string
config.pagingConfig*object

Additional properties: Yes

Inherits: object

config.pagingConfig.numRowsinteger

Format: int64

config.pagingConfig.offsetinteger

Format: int64

Type TableSpec (object)

TableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
outputVariable*array
outputVariable[]object

Inherits: object

outputVariable[].entityId*string
outputVariable[].variableId*string
pagingConfig*object

Additional properties: Yes

Inherits: object

pagingConfig.numRowsinteger

Format: int64

pagingConfig.offsetinteger

Format: int64

Type TablePostResponse (object)

TablePostResponse

Inherits: object

Model

ParameterTypeDescription
columns*array
columns[]object

Inherits: object

columns[].entityId*string
columns[].variableId*string
rows*array
rows[]array
rows[][]string

Type TwoByTwoSpec (object)

TwoByTwoSpec

Inherits: lib.MosaicSpec

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
xAxisReferenceValue*string
yAxisReferenceValue*string

Type TwoByTwoPostRequest (object)

TwoByTwoPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.xAxisReferenceValue*string
config.yAxisReferenceValue*string

Type Statistic (object)

Statistic

Inherits: object

Model

ParameterTypeDescription
value*number
confidenceIntervalstring
confidenceLevelnumber
pvalue*string

Type TwoByTwoStatsTable (object)

TwoByTwoStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
chisq*object

Inherits: object

chisq.value*number
chisq.confidenceIntervalstring
chisq.confidenceLevelnumber
chisq.pvalue*string
fisher*object

Inherits: object

fisher.value*number
fisher.confidenceIntervalstring
fisher.confidenceLevelnumber
fisher.pvalue*string
prevalenceobject

Inherits: object

prevalence.value*number
prevalence.confidenceIntervalstring
prevalence.confidenceLevelnumber
prevalence.pvalue*string
oddsratioobject

Inherits: object

oddsratio.value*number
oddsratio.confidenceIntervalstring
oddsratio.confidenceLevelnumber
oddsratio.pvalue*string
relativeriskobject

Inherits: object

relativerisk.value*number
relativerisk.confidenceIntervalstring
relativerisk.confidenceLevelnumber
relativerisk.pvalue*string
sensitivityobject

Inherits: object

sensitivity.value*number
sensitivity.confidenceIntervalstring
sensitivity.confidenceLevelnumber
sensitivity.pvalue*string
specificityobject

Inherits: object

specificity.value*number
specificity.confidenceIntervalstring
specificity.confidenceLevelnumber
specificity.pvalue*string
posPredictiveValueobject

Inherits: object

posPredictiveValue.value*number
posPredictiveValue.confidenceIntervalstring
posPredictiveValue.confidenceLevelnumber
posPredictiveValue.pvalue*string
negPredictiveValueobject

Inherits: object

negPredictiveValue.value*number
negPredictiveValue.confidenceIntervalstring
negPredictiveValue.confidenceLevelnumber
negPredictiveValue.pvalue*string

Type TwoByTwoPostResponse (object)

TwoByTwoPostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BarplotData (object)

BarplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type MapMarkersOverlayData (object)

MapMarkersOverlayData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type BoxplotData (object)

BoxplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
lowerfence*array
lowerfence[]number
upperfence*array
upperfence[]number
q1*array
q1[]number
q3*array
q3[]number
median*array
median[]number
outliersarray
outliers[]array
outliers[][]number
rawDataarray
rawData[]array
rawData[][]number
meanarray
mean[]number
label*array
label[]string

Type BoxplotStatsTable (object)

BoxplotStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xVariableDetailsobject

Inherits: object

xVariableDetails.entityId*string
xVariableDetails.variableId*string
xVariableDetails.value*string
statistic*string
pvalue*number
parameter*array
parameter[]number
method*string
statsError*string

Type HistogramData (object)

HistogramData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
binStart*array
binStart[]string
binEnd*array
binEnd[]string
binLabel*array
binLabel[]string

Type BinSlider (object)

BinSlider

Inherits: object

Model

ParameterTypeDescription
min*number
max*number
step*number

Type HeatmapData (object)

HeatmapData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]array
value[][]number
label*array
label[]string

Type MosaicPostRequest (object)

MosaicPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type MosaicSpec (object)

MosaicSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type MosaicData (object)

MosaicData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xLabel*array
xLabel[]string
yLabel*array
yLabel[]array
yLabel[][]string
value*array
value[]array
value[][]number

Type Mosaic (object)

Mosaic

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotData (object)

ScatterplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
smoothedMeanXarray
smoothedMeanX[]string
smoothedMeanYarray
smoothedMeanY[]number
smoothedMeanSEarray
smoothedMeanSE[]number
smoothedMeanErrorstring
bestFitLineXarray
bestFitLineX[]string
bestFitLineYarray
bestFitLineY[]number
r2number

Type DensityplotData (object)

DensityplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
densityY*array
densityY[]number
densityX*array
densityX[]number

Type LineplotData (object)

LineplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
binStartarray
binStart[]string
binEndarray
binEnd[]string
binSampleSizearray
binSampleSize[]union

Inherits: lib.SampleSize

binSampleSize[]anyOf
Any of the following types.
binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

binSampleSize[]{SimpleSampleSize}..N*number
binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

binSampleSize[]{ProportionSampleSize}..numeratorN*number
binSampleSize[]{ProportionSampleSize}..denominatorN*number
errorBarsarray
errorBars[]object

Inherits: lib.ErrorBar

errorBars[].lowerBound*number
errorBars[].upperBound*number
errorBars[].error*string

Type PlotConfig (object)

PlotConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type SampleSizeTable (object)

SampleSizeTable

Inherits: object

Model

ParameterTypeDescription
xVariableDetailsarray
xVariableDetails[]object

Inherits: object

xVariableDetails[].entityId*string
xVariableDetails[].variableId*string
xVariableDetails[].value*string
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
size*array
size[]number

Type VariableCompleteCases (object)

VariableCompleteCases

Inherits: object

Model

ParameterTypeDescription
variableDetails*object

Inherits: object

variableDetails.entityId*string
variableDetails.variableId*string
completeCases*number

Type CategoricalDistributionPostRequest (object)

CategoricalDistributionPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.variableId*string

Type CategoricalDistributionBin (object)

CategoricalDistributionBin

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
label*string
value*number

Type CategoricalDistributionPostResponse (object)

CategoricalDistributionPostResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
countDistribution*array
countDistribution[]object

Additional properties: Yes

Inherits: object

countDistribution[].label*string
countDistribution[].value*number
proportionDistribution*array
proportionDistribution[]object

Additional properties: Yes

Inherits: object

proportionDistribution[].label*string
proportionDistribution[].value*number

Type ExampleComputeVizPostRequest (object)

ExampleComputeVizPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ExampleComputeVizSpec

config.prefixVar*object

Inherits: object

config.prefixVar.entityId*string
config.prefixVar.variableId*string
computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.inputVariable*object

Inherits: object

computeConfig.inputVariable.entityId*string
computeConfig.inputVariable.variableId*string
computeConfig.valueSuffix*string

Type ExampleComputeVizSpec (object)

ExampleComputeVizSpec

Inherits: object

Model

ParameterTypeDescription
prefixVar*object

Inherits: object

prefixVar.entityId*string
prefixVar.variableId*string

Type ExampleComputeVizPostResponse (object)

ExampleComputeVizPostResponse

Inherits: object

Model

ParameterTypeDescription
countPluginResult*integer
numEmptyValues*integer
longestConcatenatedValue*string
avgConcatenatedLength*number

Type MultiStreamPostRequest (object)

MultiStreamPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MultiStreamSpec

config.entityId*string

Type MultiStreamSpec (object)

MultiStreamSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostRequest (object)

RecordCountPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.RecordCountSpec

config.entityId*string

Type RecordCountSpec (object)

RecordCountSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostResponse (object)

RecordCountPostResponse

Inherits: object

Model

ParameterTypeDescription
recordCount*integer

Type TestCollectionsPostRequest (object)

TestCollectionsPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.collectionId*string

Type CollectionFloatingBarplotPostRequest (object)

CollectionFloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string

Type CollectionFloatingBarplotSpec (object)

CollectionFloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string

Type CollectionFloatingBoxplotPostRequest (object)

CollectionFloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingBoxplotSpec (object)

CollectionFloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingContTablePostRequest (object)

CollectionFloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.xAxisVariable.collection*object

Inherits: object

config.xAxisVariable.collection.entityId*string
config.xAxisVariable.collection.collectionId*string
config.xAxisVariable.selectedMembers*array
config.xAxisVariable.selectedMembers[]object

Inherits: object

config.xAxisVariable.selectedMembers[].entityId*string
config.xAxisVariable.selectedMembers[].variableId*string
config.xAxisVariable.selectedValuesarray
config.xAxisVariable.selectedValues[]string

Type CollectionFloatingContTableSpec (object)

CollectionFloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

xAxisVariable.collection*object

Inherits: object

xAxisVariable.collection.entityId*string
xAxisVariable.collection.collectionId*string
xAxisVariable.selectedMembers*array
xAxisVariable.selectedMembers[]object

Inherits: object

xAxisVariable.selectedMembers[].entityId*string
xAxisVariable.selectedMembers[].variableId*string
xAxisVariable.selectedValuesarray
xAxisVariable.selectedValues[]string

Type CollectionFloatingHistogramPostRequest (object)

CollectionFloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingHistogramSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.binSpec*object

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingHistogramSpec (object)

CollectionFloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
binSpec*object

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type CollectionFloatingLineplotPostRequest (object)

CollectionFloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string
config.binSpecobject

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingLineplotSpec (object)

CollectionFloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string
binSpecobject

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type StandaloneCollectionMapMarkerPostRequest (object)

StandaloneCollectionMapMarkerPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for a map marker

Inherits: lib.StandaloneCollectionMapMarkerSpec

config.outputEntityId*string

Entity ID associated with collection variable of interest.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number
config.collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.collection.collection*object

Inherits: object

config.collection.collection.entityId*string
config.collection.collection.collectionId*string
config.collection.selectedMembers*array
config.collection.selectedMembers[]object

Inherits: object

config.collection.selectedMembers[].entityId*string
config.collection.selectedMembers[].variableId*string
config.aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type StandaloneCollectionMapMarkerSpec (object)

StandaloneCollectionMapMarkerSpec

Specification for a map marker

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity ID associated with collection variable of interest.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number
collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

collection.collection*object

Inherits: object

collection.collection.entityId*string
collection.collection.collectionId*string
collection.selectedMembers*array
collection.selectedMembers[]object

Inherits: object

collection.selectedMembers[].entityId*string
collection.selectedMembers[].variableId*string
aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type CollectionOverlayConfig (object)

CollectionOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string

Type CollectionMapMarkerElement (object)

CollectionMapMarkerElement

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number
values*array
values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

values[].variableId*string
values[].value*number
values[].confidenceInterval*object

Inherits: lib.NumberRange

values[].confidenceInterval.min*number
values[].confidenceInterval.max*number
values[].n*number

Type CollectionMemberAggregate (object)

CollectionMemberAggregate

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
value*number
confidenceInterval*object

Inherits: lib.NumberRange

confidenceInterval.min*number
confidenceInterval.max*number
n*number

Type StandaloneCollectionMapMarkerPostResponse (object)

StandaloneCollectionMapMarkerPostResponse

Inherits: object

Model

ParameterTypeDescription
markers*array
markers[]object

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

markers[].entityCount*number
markers[].avgLat*number
markers[].avgLon*number
markers[].minLat*number
markers[].minLon*number
markers[].maxLat*number
markers[].maxLon*number
markers[].values*array
markers[].values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

markers[].values[].variableId*string
markers[].values[].value*number
markers[].values[].confidenceInterval*object

Inherits: lib.NumberRange

markers[].values[].confidenceInterval.min*number
markers[].values[].confidenceInterval.max*number
markers[].values[].n*number

Type FloatingBarplotPostRequest (object)

FloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string

Type FloatingBarplotSpec (object)

FloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string

Type FloatingBarplot (object)

FloatingBarplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBarplotPostResponse (object)

FloatingBarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: object

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.variables*array
barplot.variables[]object

Inherits: object

barplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.variables[].variableSpec.entityId*string
barplot.variables[].variableSpec.variableId*string
barplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.variables[].displayNamestring
barplot.variables[].displayRangeMinany
barplot.variables[].displayRangeMaxany
barplot.variables[].vocabularyarray
barplot.variables[].vocabulary[]string
barplot.variables[].imputeZero*boolean
barplot.variables[].hasStudyDependentVocabularyboolean
barplot.variables[].isCollection*boolean
barplot.variables[].membersarray
barplot.variables[].members[]object

Inherits: lib.VariableSpec

barplot.variables[].members[].entityId*string
barplot.variables[].members[].variableId*string

Type FloatingBoxplotPostRequest (object)

FloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplotSpec (object)

FloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplot (object)

FloatingBoxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBoxplotPostResponse (object)

FloatingBoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: object

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.variables*array
boxplot.variables[]object

Inherits: object

boxplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.variables[].variableSpec.entityId*string
boxplot.variables[].variableSpec.variableId*string
boxplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.variables[].displayNamestring
boxplot.variables[].displayRangeMinany
boxplot.variables[].displayRangeMaxany
boxplot.variables[].vocabularyarray
boxplot.variables[].vocabulary[]string
boxplot.variables[].imputeZero*boolean
boxplot.variables[].hasStudyDependentVocabularyboolean
boxplot.variables[].isCollection*boolean
boxplot.variables[].membersarray
boxplot.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.variables[].members[].entityId*string
boxplot.variables[].members[].variableId*string

Type FloatingContTablePostRequest (object)

FloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string

Type FloatingContTableSpec (object)

FloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string

Type FloatingContTable (object)

FloatingContTable

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingContTablePostResponse (object)

FloatingContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: object

mosaic.data*array
mosaic.data[]object

Inherits: object

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.variables*array
mosaic.variables[]object

Inherits: object

mosaic.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.variables[].variableSpec.entityId*string
mosaic.variables[].variableSpec.variableId*string
mosaic.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.variables[].displayNamestring
mosaic.variables[].displayRangeMinany
mosaic.variables[].displayRangeMaxany
mosaic.variables[].vocabularyarray
mosaic.variables[].vocabulary[]string
mosaic.variables[].imputeZero*boolean
mosaic.variables[].hasStudyDependentVocabularyboolean
mosaic.variables[].isCollection*boolean
mosaic.variables[].membersarray
mosaic.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.variables[].members[].entityId*string
mosaic.variables[].members[].variableId*string
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string

Type FloatingHistogramPostRequest (object)

FloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingHistogramSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingHistogramSpec (object)

FloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingHistogram (object)

FloatingHistogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingHistogramPostResponse (object)

FloatingHistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: object

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.variables*array
histogram.variables[]object

Inherits: object

histogram.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.variables[].variableSpec.entityId*string
histogram.variables[].variableSpec.variableId*string
histogram.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.variables[].displayNamestring
histogram.variables[].displayRangeMinany
histogram.variables[].displayRangeMaxany
histogram.variables[].vocabularyarray
histogram.variables[].vocabulary[]string
histogram.variables[].imputeZero*boolean
histogram.variables[].hasStudyDependentVocabularyboolean
histogram.variables[].isCollection*boolean
histogram.variables[].membersarray
histogram.variables[].members[]object

Inherits: lib.VariableSpec

histogram.variables[].members[].entityId*string
histogram.variables[].members[].variableId*string

Type FloatingLineplotPostRequest (object)

FloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingLineplotSpec (object)

FloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingLineplot (object)

FloatingLineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingLineplotPostResponse (object)

FloatingLineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: object

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.variables*array
lineplot.variables[]object

Inherits: object

lineplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.variables[].variableSpec.entityId*string
lineplot.variables[].variableSpec.variableId*string
lineplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.variables[].displayNamestring
lineplot.variables[].displayRangeMinany
lineplot.variables[].displayRangeMaxany
lineplot.variables[].vocabularyarray
lineplot.variables[].vocabulary[]string
lineplot.variables[].imputeZero*boolean
lineplot.variables[].hasStudyDependentVocabularyboolean
lineplot.variables[].isCollection*boolean
lineplot.variables[].membersarray
lineplot.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.variables[].members[].entityId*string
lineplot.variables[].members[].variableId*string

Type FloatingScatterplotPostRequest (object)

FloatingScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingScatterplotSpec

config.outputEntityId*string
config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplotSpec (object)

FloatingScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplot (object)

FloatingScatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingScatterplotPostResponse (object)

FloatingScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: object

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.variables*array
scatterplot.variables[]object

Inherits: object

scatterplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.variables[].variableSpec.entityId*string
scatterplot.variables[].variableSpec.variableId*string
scatterplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.variables[].displayNamestring
scatterplot.variables[].displayRangeMinany
scatterplot.variables[].displayRangeMaxany
scatterplot.variables[].vocabularyarray
scatterplot.variables[].vocabulary[]string
scatterplot.variables[].imputeZero*boolean
scatterplot.variables[].hasStudyDependentVocabularyboolean
scatterplot.variables[].isCollection*boolean
scatterplot.variables[].membersarray
scatterplot.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.variables[].members[].entityId*string
scatterplot.variables[].members[].variableId*string

Type StandaloneMapBubblesLegendPostRequest (object)

StandaloneMapBubblesLegendPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapBubblesLegendSpec

config.outputEntityId*string
config.colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

config.colorLegendConfig.geoAggregateVariable*object

Inherits: object

config.colorLegendConfig.geoAggregateVariable.entityId*string
config.colorLegendConfig.geoAggregateVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.sizeConfig*object

Inherits: lib.SizeLegendConfig

config.sizeConfig.geoAggregateVariable*object

Inherits: object

config.sizeConfig.geoAggregateVariable.entityId*string
config.sizeConfig.geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendSpec (object)

StandaloneMapBubblesLegendSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

colorLegendConfig.geoAggregateVariable*object

Inherits: object

colorLegendConfig.geoAggregateVariable.entityId*string
colorLegendConfig.geoAggregateVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

sizeConfig*object

Inherits: lib.SizeLegendConfig

sizeConfig.geoAggregateVariable*object

Inherits: object

sizeConfig.geoAggregateVariable.entityId*string
sizeConfig.geoAggregateVariable.variableId*string

Type OverlayLegendConfig (object)

OverlayLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

quantitativeOverlayConfig.overlayVariable*object

Inherits: object

quantitativeOverlayConfig.overlayVariable.entityId*string
quantitativeOverlayConfig.overlayVariable.variableId*string
quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type SizeLegendConfig (object)

SizeLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendPostResponse (object)

StandaloneMapBubblesLegendPostResponse

Inherits: object

Model

ParameterTypeDescription
minColorValue*string
maxColorValue*string
minSizeValue*number
maxSizeValue*number

Type StandaloneMapBubblesPostRequest (object)

StandaloneMapBubblesPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for map bubbles.

Inherits: lib.StandaloneMapBubblesSpec

config.outputEntityId*string

Entity whose cardinality will be reported per marker.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapBubblesSpec (object)

StandaloneMapBubblesSpec

Specification for map bubbles.

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity whose cardinality will be reported per marker.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapBubblesPostResponse (object)

StandaloneMapBubblesPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.ColoredMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValue*string
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type ColoredMapElementInfo (object)

ColoredMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValue*string
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type StandaloneMapMarkersPostRequest (object)

StandaloneMapMarkersPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapMarkersSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapMarkersSpec (object)

StandaloneMapMarkersSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapMarkersPostResponse (object)

StandaloneMapMarkersPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.StandaloneMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValues*array
mapElements[].overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

mapElements[].overlayValues[].binStart*string
mapElements[].overlayValues[].binEnd*string
mapElements[].overlayValues[].binLabel*string
mapElements[].overlayValues[].value*number
mapElements[].overlayValues[].count*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type OverlayType (string)

OverlayType
Enum:
  • continuous
  • categorical

Inherits: string

Type OverlayConfig (object)

OverlayConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type ContinousOverlayConfig (object)

ContinousOverlayConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRange

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string

Type CategoricalOverlayConfig (object)

CategoricalOverlayConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]string

Type StandaloneMapElementInfo (object)

StandaloneMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string
overlayValues[].value*number
overlayValues[].count*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type DataPluginRequestBase (object)

DataPluginRequestBase

Inherits: object

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

Type EmptyDataPluginSpec (object)

EmptyDataPluginSpec

Inherits: object

Model

ParameterTypeDescription

Type StringBoolean (string)

StringBoolean
Enum:
  • TRUE
  • FALSE

Inherits: string

Type StrataVariableDetails (object)

StrataVariableDetails

Model

ParameterTypeDescription
entityId*string
variableId*string
value*string

Type BinSpec (object)

BinSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
  • numBins
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type BinWidthSpec (object)

BinWidthSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type NumberRange (object)

NumberRange

Inherits: object

Model

ParameterTypeDescription
min*number
max*number

Type DateRange (object)

DateRange

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type NumericViewport (object)

NumericViewport

Inherits: object

Model

ParameterTypeDescription
xMin*string
xMax*string

Type LongitudeViewport (object)

LongitudeViewport

Inherits: object

Model

ParameterTypeDescription
left*number
right*number

Type GeolocationViewport (object)

GeolocationViewport

Inherits: object

Model

ParameterTypeDescription
latitude*object

Inherits: object

latitude.xMin*string
latitude.xMax*string
longitude*object

Inherits: object

longitude.left*number
longitude.right*number

Type ErrorBar (object)

ErrorBar

Inherits: object

Model

ParameterTypeDescription
lowerBound*number
upperBound*number
error*string

Type SimpleSampleSize (object)

SimpleSampleSize

Inherits: object

Model

ParameterTypeDescription
N*number

Type ProportionSampleSize (object)

ProportionSampleSize

Inherits: object

Model

ParameterTypeDescription
numeratorN*number
denominatorN*number

Type SampleSize (union)

SampleSize

Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize

Model

ParameterTypeDescription
anyOf
Any of the following types.
{SimpleSampleSize}object

Inherits: object

{SimpleSampleSize}.N*number
{ProportionSampleSize}object

Inherits: object

{ProportionSampleSize}.numeratorN*number
{ProportionSampleSize}.denominatorN*number

Type ShowMissingness (string)

ShowMissingness
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type ShowMissingnessNoAxes (string)

ShowMissingnessNoAxes
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type BoxplotWith1ComputeSpec (object)

BoxplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: string

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: string

xAxisVariableobject

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type ScatterplotWith1ComputeSpec (object)

ScatterplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Aggregator (string)

Aggregator
Enum:
  • mean
  • median

Inherits: string

Type QuantitativeOverlayConfig (object)

QuantitativeOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type QuantitativeAggregationConfig (object)

QuantitativeAggregationConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type ContinuousAggregationConfig (object)

ContinuousAggregationConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

aggregator*string
Enum:
  • mean
  • median

Inherits: string

Type CategoricalAggregationConfig (object)

CategoricalAggregationConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

numeratorValues*array
numeratorValues[]string
denominatorValues*array
denominatorValues[]string

Type CollectionOverlayConfigWithValues (object)

CollectionOverlayConfigWithValues

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string
selectedValuesarray
selectedValues[]string

Type LegacyLabeledRange (object)

LegacyLabeledRange

Inherits: object

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string

Type LegacyLabeledRangeWithCountAndValue (object)

LegacyLabeledRangeWithCountAndValue

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string
value*number
count*number

Type Error (object)

Error

Discriminator: status

Inherits: object

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Type ErrorType (string)

ErrorType
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: string

Type BadRequestError (object)

Bad Request

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Examples

{
+  /<path>

Types

Type VariableClass (string)

VariableClass
Enum:
  • native
  • derived
  • computed

Inherits: string

Type PlotReferenceValue (string)

PlotReferenceValue
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

Type VariableMapping (object)

VariableMapping

Inherits: object

Model

ParameterTypeDescription
variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variableSpec*object

Inherits: lib.VariableSpec

variableSpec.entityId*string
variableSpec.variableId*string
plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

displayNamestring
displayRangeMinany
displayRangeMaxany
vocabularyarray
vocabulary[]string
imputeZero*boolean
hasStudyDependentVocabularyboolean
isCollection*boolean
membersarray
members[]object

Inherits: lib.VariableSpec

members[].entityId*string
members[].variableId*string

Type API_Filter (object)

API_Filter

Additional properties: Yes

Discriminator: type

Inherits: object

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

Type API_FilterType (string)

API_FilterType
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: string

Type API_BooleanOperationType (string)

API_BooleanOperationType
Enum:
  • intersect
  • union

Inherits: string

Type API_MultiFilterSubFilter (object)

API_MultiFilterSubFilter

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
stringSet*array
stringSet[]string

Type API_MultiFilter (object)

API_MultiFilter

Additional properties: Yes

Discriminator: type

Discriminator value: multiFilter

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

operation*string
Enum:
  • intersect
  • union

Inherits: string

variableId*string
subFilters*array
subFilters[]object

Additional properties: Yes

Inherits: object

subFilters[].variableId*string
subFilters[].stringSet*array
subFilters[].stringSet[]string

Type API_StringSetFilter (object)

API_StringSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: stringSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
stringSet*array
stringSet[]string

Type API_NumberSetFilter (object)

API_NumberSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
numberSet*array
numberSet[]number

Type API_DateSetFilter (object)

API_DateSetFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateSet

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
dateSet*array
dateSet[]string

Type API_NumberRangeFilter (object)

API_NumberRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: numberRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*number
max*number

Type API_DateRangeFilter (object)

API_DateRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: dateRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
min*string
max*string

Type API_LongitudeRangeFilter (object)

API_LongitudeRangeFilter

Additional properties: Yes

Discriminator: type

Discriminator value: longitudeRange

Inherits: lib.API_Filter

Model

ParameterTypeDescription
entityId*string
type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

variableId*string
left*number
right*number

Type DerivedVariableSpec (object)

DerivedVariableSpec

Model

ParameterTypeDescription
entityId*string
variableId*string
functionName*string
displayName*string
config*object

Type VariableSpec (object)

VariableSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
variableId*string

Type CollectionSpec (object)

CollectionSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string
collectionId*string

Type DataElementConstraint (object)

DataElementConstraint

Inherits: object

Model

ParameterTypeDescription
isRequired*boolean
isTemporal*boolean
isCollection*boolean
isCompositional*boolean
isProportion*boolean
allowedNormalizationMethods*array
allowedNormalizationMethods[]string
minNumVars*number
maxNumVars*number
minNumValues*number
maxNumValues*number
allowedTypesarray
allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

allowedShapesarray
allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

description*string

Type DataElementConstraintPattern (object)

DataElementConstraintPattern

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
//*object

Inherits: object

//.isRequired*boolean
//.isTemporal*boolean
//.isCollection*boolean
//.isCompositional*boolean
//.isProportion*boolean
//.allowedNormalizationMethods*array
//.allowedNormalizationMethods[]string
//.minNumVars*number
//.maxNumVars*number
//.minNumValues*number
//.maxNumValues*number
//.allowedTypesarray
//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

//.allowedShapesarray
//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

//.description*string

Type EntityTabularPostResponse (object)

EntityTabularPostResponse

Inherits: object

Model

ParameterTypeDescription
tabular*array
tabular[]array
tabular[][]string

Type Range (object)

Range

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type LabeledRange (object)

LabeledRange

Inherits: lib.Range

Model

ParameterTypeDescription
min*string
max*string
label*string

Type API_VariableType (string)

API_VariableType
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: string

Type API_VariableDataShape (string)

API_VariableDataShape
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: string

Type API_PagingConfig (object)

API_PagingConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
numRowsinteger

Format: int64

offsetinteger

Format: int64

Type BinUnits (string)

BinUnits
Enum:
  • day
  • week
  • month
  • year

Inherits: string

Type ValueSpec (string)

ValueSpec
Enum:
  • count
  • proportion

Inherits: string

Type AlphaDivComputeConfig (object)

AlphaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

Type AlphaDivMethod (string)

AlphaDivMethod
Enum:
  • shannon
  • simpson
  • evenness

Inherits: string

Type BetaDivComputeConfig (object)

BetaDivComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

Type BetaDivDissimilarityMethod (string)

BetaDivDissimilarityMethod
Enum:
  • bray
  • jaccard
  • jsd

Inherits: string

Type CorrelationComputeConfig (object)

CorrelationComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

Type CorrelationMethod (string)

CorrelationMethod
Enum:
  • spearman
  • pearson

Inherits: string

Type Correlation1Collection (object)

Correlation1Collection

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string

Type Correlation2Collections (object)

Correlation2Collections

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

Model

ParameterTypeDescription
correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

collectionVariable1*object

Inherits: object

collectionVariable1.entityId*string
collectionVariable1.collectionId*string
collectionVariable2*object

Inherits: object

collectionVariable2.entityId*string
collectionVariable2.collectionId*string

Type DifferentialAbundanceComputeConfig (object)

DifferentialAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

comparator.variable*object

Inherits: object

comparator.variable.entityId*string
comparator.variable.variableId*string
comparator.groupA*array
comparator.groupA[]object

Inherits: lib.Range

comparator.groupA[].min*string
comparator.groupA[].max*string
comparator.groupA[].label*string
comparator.groupB*array
comparator.groupB[]object

Inherits: lib.Range

comparator.groupB[].min*string
comparator.groupB[].max*string
comparator.groupB[].label*string
differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

pValueFloorstring

Type DifferentialAbundanceMethod (string)

DifferentialAbundanceMethod
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: string

Type ComparatorSpec (object)

ComparatorSpec

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
groupA*array
groupA[]object

Inherits: lib.Range

groupA[].min*string
groupA[].max*string
groupA[].label*string
groupB*array
groupB[]object

Inherits: lib.Range

groupB[].min*string
groupB[].max*string
groupB[].label*string

Type DifferentialAbundanceStats (object)

DifferentialAbundanceStats

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSize*array
effectSize[]string
pValue*array
pValue[]string
adjustedPValue*array
adjustedPValue[]string
pointId*array
pointId[]string

Type DifferentialAbundanceStatsResponse (object)

DifferentialAbundanceStatsResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
effectSizeLabel*string
statistics*object

Additional properties: Yes

Inherits: object

statistics.effectSize*array
statistics.effectSize[]string
statistics.pValue*array
statistics.pValue[]string
statistics.adjustedPValue*array
statistics.adjustedPValue[]string
statistics.pointId*array
statistics.pointId[]string
pvalueFloorstring
adjustedPValueFloorstring

Type ExampleComputeConfig (object)

ExampleComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
inputVariable*object

Inherits: object

inputVariable.entityId*string
inputVariable.variableId*string
valueSuffix*string

Type RankedAbundanceComputeConfig (object)

RankedAbundanceComputeConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collectionVariable*object

Inherits: object

collectionVariable.entityId*string
collectionVariable.collectionId*string
rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

Type RankingMethod (string)

RankingMethod
Enum:
  • median
  • q3
  • variance
  • max

Inherits: string

Type AbundanceBoxplotPostRequest (object)

AbundanceBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AbundanceScatterplotPostRequest (object)

AbundanceScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.rankingMethod*string
Enum:
  • median
  • q3
  • variance
  • max

Inherits: lib.RankingMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivBoxplotPostRequest (object)

AlphaDivBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.BoxplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariableobject

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AlphaDivScatterplotPostRequest (object)

AlphaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.alphaDivMethod*string
Enum:
  • shannon
  • simpson
  • evenness

Inherits: lib.AlphaDivMethod

config*object

Inherits: lib.ScatterplotWith1ComputeSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type AppsGetResponse (object)

AppsGetResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
apps*array
apps[]object

Inherits: lib.AppOverview

apps[].name*string
apps[].displayName*string
apps[].description*string
apps[].projects*array
apps[].projects[]string
apps[].computeNamestring
apps[].visualizations*array
apps[].visualizations[]object

Inherits: lib.VisualizationOverview

apps[].visualizations[].name*string
apps[].visualizations[].displayName*string
apps[].visualizations[].description*string
apps[].visualizations[].projects*array
apps[].visualizations[].projects[]string
apps[].visualizations[].maxPanels*number
apps[].visualizations[].dataElementConstraintsarray
apps[].visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

apps[].visualizations[].dataElementConstraints[].//*object

Inherits: object

apps[].visualizations[].dataElementConstraints[].//.isRequired*boolean
apps[].visualizations[].dataElementConstraints[].//.isTemporal*boolean
apps[].visualizations[].dataElementConstraints[].//.isCollection*boolean
apps[].visualizations[].dataElementConstraints[].//.isCompositional*boolean
apps[].visualizations[].dataElementConstraints[].//.isProportion*boolean
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
apps[].visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
apps[].visualizations[].dataElementConstraints[].//.minNumVars*number
apps[].visualizations[].dataElementConstraints[].//.maxNumVars*number
apps[].visualizations[].dataElementConstraints[].//.minNumValues*number
apps[].visualizations[].dataElementConstraints[].//.maxNumValues*number
apps[].visualizations[].dataElementConstraints[].//.allowedTypesarray
apps[].visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

apps[].visualizations[].dataElementConstraints[].//.allowedShapesarray
apps[].visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

apps[].visualizations[].dataElementConstraints[].//.description*string
apps[].visualizations[].dataElementDependencyOrderarray
apps[].visualizations[].dataElementDependencyOrder[]array
apps[].visualizations[].dataElementDependencyOrder[][]string

Type AppOverview (object)

AppOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
computeNamestring
visualizations*array
visualizations[]object

Inherits: lib.VisualizationOverview

visualizations[].name*string
visualizations[].displayName*string
visualizations[].description*string
visualizations[].projects*array
visualizations[].projects[]string
visualizations[].maxPanels*number
visualizations[].dataElementConstraintsarray
visualizations[].dataElementConstraints[]object

Additional properties: Yes

Inherits: object

visualizations[].dataElementConstraints[].//*object

Inherits: object

visualizations[].dataElementConstraints[].//.isRequired*boolean
visualizations[].dataElementConstraints[].//.isTemporal*boolean
visualizations[].dataElementConstraints[].//.isCollection*boolean
visualizations[].dataElementConstraints[].//.isCompositional*boolean
visualizations[].dataElementConstraints[].//.isProportion*boolean
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods*array
visualizations[].dataElementConstraints[].//.allowedNormalizationMethods[]string
visualizations[].dataElementConstraints[].//.minNumVars*number
visualizations[].dataElementConstraints[].//.maxNumVars*number
visualizations[].dataElementConstraints[].//.minNumValues*number
visualizations[].dataElementConstraints[].//.maxNumValues*number
visualizations[].dataElementConstraints[].//.allowedTypesarray
visualizations[].dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

visualizations[].dataElementConstraints[].//.allowedShapesarray
visualizations[].dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

visualizations[].dataElementConstraints[].//.description*string
visualizations[].dataElementDependencyOrderarray
visualizations[].dataElementDependencyOrder[]array
visualizations[].dataElementDependencyOrder[][]string

Type VisualizationOverview (object)

VisualizationOverview

Inherits: object

Model

ParameterTypeDescription
name*string
displayName*string
description*string
projects*array
projects[]string
maxPanels*number
dataElementConstraintsarray
dataElementConstraints[]object

Additional properties: Yes

Inherits: object

dataElementConstraints[].//*object

Inherits: object

dataElementConstraints[].//.isRequired*boolean
dataElementConstraints[].//.isTemporal*boolean
dataElementConstraints[].//.isCollection*boolean
dataElementConstraints[].//.isCompositional*boolean
dataElementConstraints[].//.isProportion*boolean
dataElementConstraints[].//.allowedNormalizationMethods*array
dataElementConstraints[].//.allowedNormalizationMethods[]string
dataElementConstraints[].//.minNumVars*number
dataElementConstraints[].//.maxNumVars*number
dataElementConstraints[].//.minNumValues*number
dataElementConstraints[].//.maxNumValues*number
dataElementConstraints[].//.allowedTypesarray
dataElementConstraints[].//.allowedTypes[]string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

dataElementConstraints[].//.allowedShapesarray
dataElementConstraints[].//.allowedShapes[]string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

dataElementConstraints[].//.description*string
dataElementDependencyOrderarray
dataElementDependencyOrder[]array
dataElementDependencyOrder[][]string

Type BetaDivScatterplotPostRequest (object)

BetaDivScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.betaDivDissimilarityMethod*string
Enum:
  • bray
  • jaccard
  • jsd

Inherits: lib.BetaDivDissimilarityMethod

config*object

Inherits: lib.BetaDivScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string

Type BetaDivScatterplotSpec (object)

BetaDivScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type CorrelationBipartitenetworkSpec (object)

CorrelationBipartitenetworkSpec

Inherits: object

Model

ParameterTypeDescription
significanceThresholdnumber
correlationCoefThresholdnumber

Type CorrelationBipartiteNetworkPostResponse (object)

CorrelationBipartiteNetworkPostResponse

Model

ParameterTypeDescription
bipartitenetwork*object

Inherits: lib.BipartiteNetwork

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: lib.LinkData

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: lib.NodeData

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.BipartiteNetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string
significanceThreshold*number
correlationCoefThreshold*number

Type CorrelationAssayAssayBipartitenetworkPostRequest (object)

CorrelationAssayAssayBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable1*object

Inherits: object

computeConfig.collectionVariable1.entityId*string
computeConfig.collectionVariable1.collectionId*string
computeConfig.collectionVariable2*object

Inherits: object

computeConfig.collectionVariable2.entityId*string
computeConfig.collectionVariable2.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type CorrelationAssayMetadataBipartitenetworkPostRequest (object)

CorrelationAssayMetadataBipartitenetworkPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: lib.CorrelationComputeConfig

computeConfig.correlationMethod*string
Enum:
  • spearman
  • pearson

Inherits: lib.CorrelationMethod

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
config*object

Inherits: object

config.significanceThresholdnumber
config.correlationCoefThresholdnumber

Type DifferentialAbundanceVolcanoplotPostRequest (object)

DifferentialAbundanceVolcanoplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.collectionVariable*object

Inherits: object

computeConfig.collectionVariable.entityId*string
computeConfig.collectionVariable.collectionId*string
computeConfig.comparator*object

Additional properties: Yes

Inherits: lib.ComparatorSpec

computeConfig.comparator.variable*object

Inherits: object

computeConfig.comparator.variable.entityId*string
computeConfig.comparator.variable.variableId*string
computeConfig.comparator.groupA*array
computeConfig.comparator.groupA[]object

Inherits: lib.Range

computeConfig.comparator.groupA[].min*string
computeConfig.comparator.groupA[].max*string
computeConfig.comparator.groupA[].label*string
computeConfig.comparator.groupB*array
computeConfig.comparator.groupB[]object

Inherits: lib.Range

computeConfig.comparator.groupB[].min*string
computeConfig.comparator.groupB[].max*string
computeConfig.comparator.groupB[].label*string
computeConfig.differentialAbundanceMethod*string
Enum:
  • DESeq
  • ANCOMBC
  • Maaslin

Inherits: lib.DifferentialAbundanceMethod

computeConfig.pValueFloorstring
config*object

Inherits: lib.EmptyDataPluginSpec

Type ContinuousVariableMetadataPostRequest (object)

ContinuousVariableMetadataPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ContinuousVariableMetadataSpec

config.variable*object

Inherits: object

config.variable.entityId*string
config.variable.variableId*string
config.metadata*array
config.metadata[]string
Enum:
  • binRanges
  • median

Type ContinuousVariableMetadataSpec (object)

ContinuousVariableMetadataSpec

Inherits: object

Model

ParameterTypeDescription
variable*object

Inherits: object

variable.entityId*string
variable.variableId*string
metadata*array
metadata[]string
Enum:
  • binRanges
  • median

Type AllBinRanges (object)

AllBinRanges

Inherits: object

Model

ParameterTypeDescription
equalInterval*array
equalInterval[]object

Inherits: lib.Range

equalInterval[].min*string
equalInterval[].max*string
equalInterval[].label*string
quantile*array
quantile[]object

Inherits: lib.Range

quantile[].min*string
quantile[].max*string
quantile[].label*string
standardDeviation*array
standardDeviation[]object

Inherits: lib.Range

standardDeviation[].min*string
standardDeviation[].max*string
standardDeviation[].label*string

Type ContinuousVariableMetadataPostResponse (object)

ContinuousVariableMetadataPostResponse

Inherits: object

Model

ParameterTypeDescription
binRangesobject

Inherits: object

binRanges.equalInterval*array
binRanges.equalInterval[]object

Inherits: lib.Range

binRanges.equalInterval[].min*string
binRanges.equalInterval[].max*string
binRanges.equalInterval[].label*string
binRanges.quantile*array
binRanges.quantile[]object

Inherits: lib.Range

binRanges.quantile[].min*string
binRanges.quantile[].max*string
binRanges.quantile[].label*string
binRanges.standardDeviation*array
binRanges.standardDeviation[]object

Inherits: lib.Range

binRanges.standardDeviation[].min*string
binRanges.standardDeviation[].max*string
binRanges.standardDeviation[].label*string
mediannumber

Type NodeData (object)

NodeData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
id*string

Type LinkData (object)

LinkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
source*object

Additional properties: Yes

Inherits: object

source.id*string
target*object

Additional properties: Yes

Inherits: object

target.id*string
strokeWidth*string
color*string

Type NetworkData (object)

NetworkData

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string

Type NetworkConfig (object)

NetworkConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type BipartiteNetworkConfig (object)

BipartiteNetworkConfig

Additional properties: Yes

Inherits: lib.NetworkConfig

Model

ParameterTypeDescription
variablesarray
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
column1Metadata*string
column2Metadata*string

Type BipartiteNetworkData (object)

BipartiteNetworkData

Additional properties: Yes

Inherits: lib.NetworkData

Model

ParameterTypeDescription
nodes*array
nodes[]object

Additional properties: Yes

Inherits: object

nodes[].id*string
links*array
links[]object

Additional properties: Yes

Inherits: object

links[].source*object

Additional properties: Yes

Inherits: object

links[].source.id*string
links[].target*object

Additional properties: Yes

Inherits: object

links[].target.id*string
links[].strokeWidth*string
links[].color*string
column1NodeIDs*array
column1NodeIDs[]string
column2NodeIDs*array
column2NodeIDs[]string

Type BipartiteNetwork (object)

BipartiteNetwork

Inherits: object

Model

ParameterTypeDescription
data*object

Additional properties: Yes

Inherits: lib.NetworkData

data.nodes*array
data.nodes[]object

Additional properties: Yes

Inherits: object

data.nodes[].id*string
data.links*array
data.links[]object

Additional properties: Yes

Inherits: object

data.links[].source*object

Additional properties: Yes

Inherits: object

data.links[].source.id*string
data.links[].target*object

Additional properties: Yes

Inherits: object

data.links[].target.id*string
data.links[].strokeWidth*string
data.links[].color*string
data.column1NodeIDs*array
data.column1NodeIDs[]string
data.column2NodeIDs*array
data.column2NodeIDs[]string
config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

config.variablesarray
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.column1Metadata*string
config.column2Metadata*string

Type BipartiteNetworkPostResponse (object)

BipartiteNetworkPostResponse

Inherits: object

Model

ParameterTypeDescription
bipartitenetwork*object

Inherits: object

bipartitenetwork.data*object

Additional properties: Yes

Inherits: lib.NetworkData

bipartitenetwork.data.nodes*array
bipartitenetwork.data.nodes[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.nodes[].id*string
bipartitenetwork.data.links*array
bipartitenetwork.data.links[]object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].source.id*string
bipartitenetwork.data.links[].target*object

Additional properties: Yes

Inherits: object

bipartitenetwork.data.links[].target.id*string
bipartitenetwork.data.links[].strokeWidth*string
bipartitenetwork.data.links[].color*string
bipartitenetwork.data.column1NodeIDs*array
bipartitenetwork.data.column1NodeIDs[]string
bipartitenetwork.data.column2NodeIDs*array
bipartitenetwork.data.column2NodeIDs[]string
bipartitenetwork.config*object

Additional properties: Yes

Inherits: lib.NetworkConfig

bipartitenetwork.config.variablesarray
bipartitenetwork.config.variables[]object

Inherits: object

bipartitenetwork.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

bipartitenetwork.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].variableSpec.entityId*string
bipartitenetwork.config.variables[].variableSpec.variableId*string
bipartitenetwork.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

bipartitenetwork.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

bipartitenetwork.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

bipartitenetwork.config.variables[].displayNamestring
bipartitenetwork.config.variables[].displayRangeMinany
bipartitenetwork.config.variables[].displayRangeMaxany
bipartitenetwork.config.variables[].vocabularyarray
bipartitenetwork.config.variables[].vocabulary[]string
bipartitenetwork.config.variables[].imputeZero*boolean
bipartitenetwork.config.variables[].hasStudyDependentVocabularyboolean
bipartitenetwork.config.variables[].isCollection*boolean
bipartitenetwork.config.variables[].membersarray
bipartitenetwork.config.variables[].members[]object

Inherits: lib.VariableSpec

bipartitenetwork.config.variables[].members[].entityId*string
bipartitenetwork.config.variables[].members[].variableId*string
bipartitenetwork.config.column1Metadata*string
bipartitenetwork.config.column2Metadata*string

Type BarplotPostRequest (object)

BarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BarplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type BarplotSpec (object)

BarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Barplot (object)

Barplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BarplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BarplotPostResponse (object)

BarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: lib.BarplotData

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.config*object

Inherits: lib.PlotConfig

barplot.config.completeCasesAllVars*number
barplot.config.completeCasesAxesVars*number
barplot.config.variables*array
barplot.config.variables[]object

Inherits: object

barplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.config.variables[].variableSpec.entityId*string
barplot.config.variables[].variableSpec.variableId*string
barplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.config.variables[].displayNamestring
barplot.config.variables[].displayRangeMinany
barplot.config.variables[].displayRangeMaxany
barplot.config.variables[].vocabularyarray
barplot.config.variables[].vocabulary[]string
barplot.config.variables[].imputeZero*boolean
barplot.config.variables[].hasStudyDependentVocabularyboolean
barplot.config.variables[].isCollection*boolean
barplot.config.variables[].membersarray
barplot.config.variables[].members[]object

Inherits: lib.VariableSpec

barplot.config.variables[].members[].entityId*string
barplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BoxplotPostRequest (object)

BoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.BoxplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.points*string
Enum:
  • outliers
  • all
config.mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type BoxplotSpec (object)

BoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Boxplot (object)

Boxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.BoxplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type BoxplotPostResponse (object)

BoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: lib.BoxplotData

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.config*object

Inherits: lib.PlotConfig

boxplot.config.completeCasesAllVars*number
boxplot.config.completeCasesAxesVars*number
boxplot.config.variables*array
boxplot.config.variables[]object

Inherits: object

boxplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.config.variables[].variableSpec.entityId*string
boxplot.config.variables[].variableSpec.variableId*string
boxplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.config.variables[].displayNamestring
boxplot.config.variables[].displayRangeMinany
boxplot.config.variables[].displayRangeMaxany
boxplot.config.variables[].vocabularyarray
boxplot.config.variables[].vocabulary[]string
boxplot.config.variables[].imputeZero*boolean
boxplot.config.variables[].hasStudyDependentVocabularyboolean
boxplot.config.variables[].isCollection*boolean
boxplot.config.variables[].membersarray
boxplot.config.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.config.variables[].members[].entityId*string
boxplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number
statsTablearray
statsTable[]object

Inherits: lib.BoxplotStatsTable

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].xVariableDetailsobject

Inherits: object

statsTable[].xVariableDetails.entityId*string
statsTable[].xVariableDetails.variableId*string
statsTable[].xVariableDetails.value*string
statsTable[].statistic*string
statsTable[].pvalue*number
statsTable[].parameter*array
statsTable[].parameter[]number
statsTable[].method*string
statsTable[].statsError*string

Type ContTableStatsTable (object)

ContTableStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
pvalue*array
pvalue[]number
degreesFreedom*array
degreesFreedom[]number
chisq*array
chisq[]number

Type ContTablePostResponse (object)

ContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].pvalue*array
statsTable[].pvalue[]number
statsTable[].degreesFreedom*array
statsTable[].degreesFreedom[]number
statsTable[].chisq*array
statsTable[].chisq[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type DensityplotPostRequest (object)

DensityplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.DensityplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type DensityplotSpec (object)

DensityplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Densityplot (object)

Densityplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.DensityplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].densityY*array
data[].densityY[]number
data[].densityX*array
data[].densityX[]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type DensityplotPostResponse (object)

DensityplotPostResponse

Inherits: object

Model

ParameterTypeDescription
densityplot*object

Inherits: object

densityplot.data*array
densityplot.data[]object

Inherits: lib.DensityplotData

densityplot.data[].overlayVariableDetailsobject

Inherits: object

densityplot.data[].overlayVariableDetails.entityId*string
densityplot.data[].overlayVariableDetails.variableId*string
densityplot.data[].overlayVariableDetails.value*string
densityplot.data[].facetVariableDetailsarray

Max. items: 2

densityplot.data[].facetVariableDetails[]object

Inherits: object

densityplot.data[].facetVariableDetails[].entityId*string
densityplot.data[].facetVariableDetails[].variableId*string
densityplot.data[].facetVariableDetails[].value*string
densityplot.data[].densityY*array
densityplot.data[].densityY[]number
densityplot.data[].densityX*array
densityplot.data[].densityX[]number
densityplot.config*object

Inherits: lib.PlotConfig

densityplot.config.completeCasesAllVars*number
densityplot.config.completeCasesAxesVars*number
densityplot.config.variables*array
densityplot.config.variables[]object

Inherits: object

densityplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

densityplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

densityplot.config.variables[].variableSpec.entityId*string
densityplot.config.variables[].variableSpec.variableId*string
densityplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

densityplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

densityplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

densityplot.config.variables[].displayNamestring
densityplot.config.variables[].displayRangeMinany
densityplot.config.variables[].displayRangeMaxany
densityplot.config.variables[].vocabularyarray
densityplot.config.variables[].vocabulary[]string
densityplot.config.variables[].imputeZero*boolean
densityplot.config.variables[].hasStudyDependentVocabularyboolean
densityplot.config.variables[].isCollection*boolean
densityplot.config.variables[].membersarray
densityplot.config.variables[].members[]object

Inherits: lib.VariableSpec

densityplot.config.variables[].members[].entityId*string
densityplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HeatmapPostRequest (object)

HeatmapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HeatmapSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • collection
  • series
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.zAxisVariableobject

Inherits: object

config.zAxisVariable.entityId*string
config.zAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type HeatmapSpec (object)

HeatmapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • collection
  • series
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
zAxisVariableobject

Inherits: object

zAxisVariable.entityId*string
zAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Heatmap (object)

Heatmap

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HeatmapData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]array
data[].value[][]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type HeatmapPostResponse (object)

HeatmapPostResponse

Inherits: object

Model

ParameterTypeDescription
heatmap*object

Inherits: object

heatmap.data*array
heatmap.data[]object

Inherits: lib.HeatmapData

heatmap.data[].facetVariableDetailsarray

Max. items: 2

heatmap.data[].facetVariableDetails[]object

Inherits: object

heatmap.data[].facetVariableDetails[].entityId*string
heatmap.data[].facetVariableDetails[].variableId*string
heatmap.data[].facetVariableDetails[].value*string
heatmap.data[].value*array
heatmap.data[].value[]array
heatmap.data[].value[][]number
heatmap.data[].label*array
heatmap.data[].label[]string
heatmap.config*object

Inherits: lib.PlotConfig

heatmap.config.completeCasesAllVars*number
heatmap.config.completeCasesAxesVars*number
heatmap.config.variables*array
heatmap.config.variables[]object

Inherits: object

heatmap.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

heatmap.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

heatmap.config.variables[].variableSpec.entityId*string
heatmap.config.variables[].variableSpec.variableId*string
heatmap.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

heatmap.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

heatmap.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

heatmap.config.variables[].displayNamestring
heatmap.config.variables[].displayRangeMinany
heatmap.config.variables[].displayRangeMaxany
heatmap.config.variables[].vocabularyarray
heatmap.config.variables[].vocabulary[]string
heatmap.config.variables[].imputeZero*boolean
heatmap.config.variables[].hasStudyDependentVocabularyboolean
heatmap.config.variables[].isCollection*boolean
heatmap.config.variables[].membersarray
heatmap.config.variables[].members[]object

Inherits: lib.VariableSpec

heatmap.config.variables[].members[].entityId*string
heatmap.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type HistogramPostRequest (object)

HistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.HistogramSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramSpec (object)

HistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type HistogramSummary (object)

HistogramSummary

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
min*string
q1*string
median*string
mean*string
q3*string
max*string

Type HistogramConfig (object)

HistogramConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSlider*object

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
summary*object

Additional properties: Yes

Inherits: object

summary.min*string
summary.q1*string
summary.median*string
summary.mean*string
summary.q3*string
summary.max*string
viewport*object

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Histogram (object)

Histogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.HistogramData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSlider*object

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.summary*object

Additional properties: Yes

Inherits: object

config.summary.min*string
config.summary.q1*string
config.summary.median*string
config.summary.mean*string
config.summary.q3*string
config.summary.max*string
config.viewport*object

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type HistogramPostResponse (object)

HistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: lib.HistogramData

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.config*object

Inherits: lib.PlotConfig

histogram.config.completeCasesAllVars*number
histogram.config.completeCasesAxesVars*number
histogram.config.variables*array
histogram.config.variables[]object

Inherits: object

histogram.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.config.variables[].variableSpec.entityId*string
histogram.config.variables[].variableSpec.variableId*string
histogram.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.config.variables[].displayNamestring
histogram.config.variables[].displayRangeMinany
histogram.config.variables[].displayRangeMaxany
histogram.config.variables[].vocabularyarray
histogram.config.variables[].vocabulary[]string
histogram.config.variables[].imputeZero*boolean
histogram.config.variables[].hasStudyDependentVocabularyboolean
histogram.config.variables[].isCollection*boolean
histogram.config.variables[].membersarray
histogram.config.variables[].members[]object

Inherits: lib.VariableSpec

histogram.config.variables[].members[].entityId*string
histogram.config.variables[].members[].variableId*string
histogram.config.binSlider*object

Inherits: lib.BinSlider

histogram.config.binSlider.min*number
histogram.config.binSlider.max*number
histogram.config.binSlider.step*number
histogram.config.binSpec*object

Inherits: lib.BinSpec

histogram.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
histogram.config.binSpec.valuenumber
histogram.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

histogram.config.binSpec.rangeunion
histogram.config.binSpec.rangeanyOf
Any of the following types.
histogram.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

histogram.config.binSpec.range{NumberRange}..min*number
histogram.config.binSpec.range{NumberRange}..max*number
histogram.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

histogram.config.binSpec.range{DateRange}..min*string
histogram.config.binSpec.range{DateRange}..max*string
histogram.config.summary*object

Additional properties: Yes

Inherits: object

histogram.config.summary.min*string
histogram.config.summary.q1*string
histogram.config.summary.median*string
histogram.config.summary.mean*string
histogram.config.summary.q3*string
histogram.config.summary.max*string
histogram.config.viewport*object

Inherits: lib.NumericViewport

histogram.config.viewport.xMin*string
histogram.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type LineplotPostRequest (object)

LineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.LineplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotSpec (object)

LineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type LineplotConfig (object)

LineplotConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
binSliderobject

Inherits: lib.BinSlider

binSlider.min*number
binSlider.max*number
binSlider.step*number
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type Lineplot (object)

Lineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.LineplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.binSliderobject

Inherits: lib.BinSlider

config.binSlider.min*number
config.binSlider.max*number
config.binSlider.step*number
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type LineplotPostResponse (object)

LineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: lib.LineplotData

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.config*object

Inherits: lib.PlotConfig

lineplot.config.completeCasesAllVars*number
lineplot.config.completeCasesAxesVars*number
lineplot.config.variables*array
lineplot.config.variables[]object

Inherits: object

lineplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.config.variables[].variableSpec.entityId*string
lineplot.config.variables[].variableSpec.variableId*string
lineplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.config.variables[].displayNamestring
lineplot.config.variables[].displayRangeMinany
lineplot.config.variables[].displayRangeMaxany
lineplot.config.variables[].vocabularyarray
lineplot.config.variables[].vocabulary[]string
lineplot.config.variables[].imputeZero*boolean
lineplot.config.variables[].hasStudyDependentVocabularyboolean
lineplot.config.variables[].isCollection*boolean
lineplot.config.variables[].membersarray
lineplot.config.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.config.variables[].members[].entityId*string
lineplot.config.variables[].members[].variableId*string
lineplot.config.binSliderobject

Inherits: lib.BinSlider

lineplot.config.binSlider.min*number
lineplot.config.binSlider.max*number
lineplot.config.binSlider.step*number
lineplot.config.binSpecobject

Inherits: lib.BinSpec

lineplot.config.binSpec.typestring
Enum:
  • binWidth
  • numBins
lineplot.config.binSpec.valuenumber
lineplot.config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

lineplot.config.binSpec.rangeunion
lineplot.config.binSpec.rangeanyOf
Any of the following types.
lineplot.config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

lineplot.config.binSpec.range{NumberRange}..min*number
lineplot.config.binSpec.range{NumberRange}..max*number
lineplot.config.binSpec.range{DateRange}object

Inherits: lib.DateRange

lineplot.config.binSpec.range{DateRange}..min*string
lineplot.config.binSpec.range{DateRange}..max*string
lineplot.config.viewportobject

Inherits: lib.NumericViewport

lineplot.config.viewport.xMin*string
lineplot.config.viewport.xMax*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapMarkersOverlayPostRequest (object)

MapMarkersOverlayPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapMarkersOverlaySpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.longitudeVariableobject

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariableobject

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewportobject

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlaySpec (object)

MapMarkersOverlaySpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingness

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

longitudeVariableobject

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariableobject

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewportobject

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlayConfig (object)

MapMarkersOverlayConfig

Inherits: lib.PlotConfig

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapMarkersOverlay (object)

MapMarkersOverlay

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.MapMarkersOverlayData

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapMarkersOverlayPostResponse (object)

MapMarkersOverlayPostResponse

Inherits: object

Model

ParameterTypeDescription
mapMarkers*object

Inherits: object

mapMarkers.data*array
mapMarkers.data[]object

Inherits: lib.MapMarkersOverlayData

mapMarkers.data[].facetVariableDetailsarray

Max. items: 2

mapMarkers.data[].facetVariableDetails[]object

Inherits: object

mapMarkers.data[].facetVariableDetails[].entityId*string
mapMarkers.data[].facetVariableDetails[].variableId*string
mapMarkers.data[].facetVariableDetails[].value*string
mapMarkers.data[].value*array
mapMarkers.data[].value[]number
mapMarkers.data[].label*array
mapMarkers.data[].label[]string
mapMarkers.config*object

Inherits: lib.PlotConfig

mapMarkers.config.completeCasesAllVars*number
mapMarkers.config.completeCasesAxesVars*number
mapMarkers.config.variables*array
mapMarkers.config.variables[]object

Inherits: object

mapMarkers.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mapMarkers.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].variableSpec.entityId*string
mapMarkers.config.variables[].variableSpec.variableId*string
mapMarkers.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mapMarkers.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mapMarkers.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mapMarkers.config.variables[].displayNamestring
mapMarkers.config.variables[].displayRangeMinany
mapMarkers.config.variables[].displayRangeMaxany
mapMarkers.config.variables[].vocabularyarray
mapMarkers.config.variables[].vocabulary[]string
mapMarkers.config.variables[].imputeZero*boolean
mapMarkers.config.variables[].hasStudyDependentVocabularyboolean
mapMarkers.config.variables[].isCollection*boolean
mapMarkers.config.variables[].membersarray
mapMarkers.config.variables[].members[]object

Inherits: lib.VariableSpec

mapMarkers.config.variables[].members[].entityId*string
mapMarkers.config.variables[].members[].variableId*string
mapMarkers.config.viewport*object

Inherits: lib.GeolocationViewport

mapMarkers.config.viewport.latitude*object

Inherits: lib.NumericViewport

mapMarkers.config.viewport.latitude.xMin*string
mapMarkers.config.viewport.latitude.xMax*string
mapMarkers.config.viewport.longitude*object

Inherits: lib.LongitudeViewport

mapMarkers.config.viewport.longitude.left*number
mapMarkers.config.viewport.longitude.right*number
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type MapPostRequest (object)

MapPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MapSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type MapSpec (object)

MapSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type MapConfig (object)

MapConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesGeoVar*number

Type MapPostResponse (object)

MapPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.MapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number
config*object

Inherits: object

config.completeCasesGeoVar*number

Type MapElementInfo (object)

MapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type ScatterplotPostRequest (object)

ScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ScatterplotSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayVariableobject

Inherits: object

config.overlayVariable.entityId*string
config.overlayVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type ScatterplotSpec (object)

ScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type Scatterplot (object)

Scatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: lib.ScatterplotData

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotPostResponse (object)

ScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: lib.ScatterplotData

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.config*object

Inherits: lib.PlotConfig

scatterplot.config.completeCasesAllVars*number
scatterplot.config.completeCasesAxesVars*number
scatterplot.config.variables*array
scatterplot.config.variables[]object

Inherits: object

scatterplot.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.config.variables[].variableSpec.entityId*string
scatterplot.config.variables[].variableSpec.variableId*string
scatterplot.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.config.variables[].displayNamestring
scatterplot.config.variables[].displayRangeMinany
scatterplot.config.variables[].displayRangeMaxany
scatterplot.config.variables[].vocabularyarray
scatterplot.config.variables[].vocabulary[]string
scatterplot.config.variables[].imputeZero*boolean
scatterplot.config.variables[].hasStudyDependentVocabularyboolean
scatterplot.config.variables[].isCollection*boolean
scatterplot.config.variables[].membersarray
scatterplot.config.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.config.variables[].members[].entityId*string
scatterplot.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type TablePostRequest (object)

TablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.TableSpec

config.outputEntityId*string
config.outputVariable*array
config.outputVariable[]object

Inherits: object

config.outputVariable[].entityId*string
config.outputVariable[].variableId*string
config.pagingConfig*object

Additional properties: Yes

Inherits: object

config.pagingConfig.numRowsinteger

Format: int64

config.pagingConfig.offsetinteger

Format: int64

Type TableSpec (object)

TableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
outputVariable*array
outputVariable[]object

Inherits: object

outputVariable[].entityId*string
outputVariable[].variableId*string
pagingConfig*object

Additional properties: Yes

Inherits: object

pagingConfig.numRowsinteger

Format: int64

pagingConfig.offsetinteger

Format: int64

Type TablePostResponse (object)

TablePostResponse

Inherits: object

Model

ParameterTypeDescription
columns*array
columns[]object

Inherits: object

columns[].entityId*string
columns[].variableId*string
rows*array
rows[]array
rows[][]string

Type TwoByTwoSpec (object)

TwoByTwoSpec

Inherits: lib.MosaicSpec

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string
xAxisReferenceValue*string
yAxisReferenceValue*string

Type TwoByTwoPostRequest (object)

TwoByTwoPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string
config.xAxisReferenceValue*string
config.yAxisReferenceValue*string

Type Statistic (object)

Statistic

Inherits: object

Model

ParameterTypeDescription
value*number
confidenceIntervalstring
confidenceLevelnumber
pvalue*string

Type TwoByTwoStatsTable (object)

TwoByTwoStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
chisq*object

Inherits: object

chisq.value*number
chisq.confidenceIntervalstring
chisq.confidenceLevelnumber
chisq.pvalue*string
fisher*object

Inherits: object

fisher.value*number
fisher.confidenceIntervalstring
fisher.confidenceLevelnumber
fisher.pvalue*string
prevalenceobject

Inherits: object

prevalence.value*number
prevalence.confidenceIntervalstring
prevalence.confidenceLevelnumber
prevalence.pvalue*string
oddsratioobject

Inherits: object

oddsratio.value*number
oddsratio.confidenceIntervalstring
oddsratio.confidenceLevelnumber
oddsratio.pvalue*string
relativeriskobject

Inherits: object

relativerisk.value*number
relativerisk.confidenceIntervalstring
relativerisk.confidenceLevelnumber
relativerisk.pvalue*string
sensitivityobject

Inherits: object

sensitivity.value*number
sensitivity.confidenceIntervalstring
sensitivity.confidenceLevelnumber
sensitivity.pvalue*string
specificityobject

Inherits: object

specificity.value*number
specificity.confidenceIntervalstring
specificity.confidenceLevelnumber
specificity.pvalue*string
posPredictiveValueobject

Inherits: object

posPredictiveValue.value*number
posPredictiveValue.confidenceIntervalstring
posPredictiveValue.confidenceLevelnumber
posPredictiveValue.pvalue*string
negPredictiveValueobject

Inherits: object

negPredictiveValue.value*number
negPredictiveValue.confidenceIntervalstring
negPredictiveValue.confidenceLevelnumber
negPredictiveValue.pvalue*string

Type TwoByTwoPostResponse (object)

TwoByTwoPostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: lib.Mosaic

mosaic.data*array
mosaic.data[]object

Inherits: lib.MosaicData

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.config*object

Inherits: lib.PlotConfig

mosaic.config.completeCasesAllVars*number
mosaic.config.completeCasesAxesVars*number
mosaic.config.variables*array
mosaic.config.variables[]object

Inherits: object

mosaic.config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.config.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.config.variables[].variableSpec.entityId*string
mosaic.config.variables[].variableSpec.variableId*string
mosaic.config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.config.variables[].displayNamestring
mosaic.config.variables[].displayRangeMinany
mosaic.config.variables[].displayRangeMaxany
mosaic.config.variables[].vocabularyarray
mosaic.config.variables[].vocabulary[]string
mosaic.config.variables[].imputeZero*boolean
mosaic.config.variables[].hasStudyDependentVocabularyboolean
mosaic.config.variables[].isCollection*boolean
mosaic.config.variables[].membersarray
mosaic.config.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.config.variables[].members[].entityId*string
mosaic.config.variables[].members[].variableId*string
sampleSizeTable*array
sampleSizeTable[]object

Inherits: lib.SampleSizeTable

sampleSizeTable[].xVariableDetailsarray
sampleSizeTable[].xVariableDetails[]object

Inherits: object

sampleSizeTable[].xVariableDetails[].entityId*string
sampleSizeTable[].xVariableDetails[].variableId*string
sampleSizeTable[].xVariableDetails[].value*string
sampleSizeTable[].overlayVariableDetailsobject

Inherits: object

sampleSizeTable[].overlayVariableDetails.entityId*string
sampleSizeTable[].overlayVariableDetails.variableId*string
sampleSizeTable[].overlayVariableDetails.value*string
sampleSizeTable[].facetVariableDetailsarray

Max. items: 2

sampleSizeTable[].facetVariableDetails[]object

Inherits: object

sampleSizeTable[].facetVariableDetails[].entityId*string
sampleSizeTable[].facetVariableDetails[].variableId*string
sampleSizeTable[].facetVariableDetails[].value*string
sampleSizeTable[].size*array
sampleSizeTable[].size[]number
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string
completeCasesTable*array
completeCasesTable[]object

Inherits: lib.VariableCompleteCases

completeCasesTable[].variableDetails*object

Inherits: object

completeCasesTable[].variableDetails.entityId*string
completeCasesTable[].variableDetails.variableId*string
completeCasesTable[].completeCases*number

Type BarplotData (object)

BarplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type MapMarkersOverlayData (object)

MapMarkersOverlayData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
label*array
label[]string

Type BoxplotData (object)

BoxplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
lowerfence*array
lowerfence[]number
upperfence*array
upperfence[]number
q1*array
q1[]number
q3*array
q3[]number
median*array
median[]number
outliersarray
outliers[]array
outliers[][]number
rawDataarray
rawData[]array
rawData[][]number
meanarray
mean[]number
label*array
label[]string

Type BoxplotStatsTable (object)

BoxplotStatsTable

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xVariableDetailsobject

Inherits: object

xVariableDetails.entityId*string
xVariableDetails.variableId*string
xVariableDetails.value*string
statistic*string
pvalue*number
parameter*array
parameter[]number
method*string
statsError*string

Type HistogramData (object)

HistogramData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]number
binStart*array
binStart[]string
binEnd*array
binEnd[]string
binLabel*array
binLabel[]string

Type BinSlider (object)

BinSlider

Inherits: object

Model

ParameterTypeDescription
min*number
max*number
step*number

Type HeatmapData (object)

HeatmapData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
value*array
value[]array
value[][]number
label*array
label[]string

Type MosaicPostRequest (object)

MosaicPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MosaicSpec

config.outputEntityId*string
config.showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.facetVariablearray

Max. items: 2

config.facetVariable[]object

Inherits: object

config.facetVariable[].entityId*string
config.facetVariable[].variableId*string

Type MosaicSpec (object)

MosaicSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: lib.ShowMissingnessNoAxes

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type MosaicData (object)

MosaicData

Inherits: object

Model

ParameterTypeDescription
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
xLabel*array
xLabel[]string
yLabel*array
yLabel[]array
yLabel[][]string
value*array
value[]array
value[][]number

Type Mosaic (object)

Mosaic

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
config*object

Inherits: lib.PlotConfig

config.completeCasesAllVars*number
config.completeCasesAxesVars*number
config.variables*array
config.variables[]object

Inherits: object

config.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

config.variables[].variableSpec*object

Inherits: lib.VariableSpec

config.variables[].variableSpec.entityId*string
config.variables[].variableSpec.variableId*string
config.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

config.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

config.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

config.variables[].displayNamestring
config.variables[].displayRangeMinany
config.variables[].displayRangeMaxany
config.variables[].vocabularyarray
config.variables[].vocabulary[]string
config.variables[].imputeZero*boolean
config.variables[].hasStudyDependentVocabularyboolean
config.variables[].isCollection*boolean
config.variables[].membersarray
config.variables[].members[]object

Inherits: lib.VariableSpec

config.variables[].members[].entityId*string
config.variables[].members[].variableId*string

Type ScatterplotData (object)

ScatterplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
smoothedMeanXarray
smoothedMeanX[]string
smoothedMeanYarray
smoothedMeanY[]number
smoothedMeanSEarray
smoothedMeanSE[]number
smoothedMeanErrorstring
bestFitLineXarray
bestFitLineX[]string
bestFitLineYarray
bestFitLineY[]number
r2number

Type DensityplotData (object)

DensityplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
densityY*array
densityY[]number
densityX*array
densityX[]number

Type LineplotData (object)

LineplotData

Inherits: object

Model

ParameterTypeDescription
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
seriesY*array
seriesY[]string
seriesX*array
seriesX[]string
binStartarray
binStart[]string
binEndarray
binEnd[]string
binSampleSizearray
binSampleSize[]union

Inherits: lib.SampleSize

binSampleSize[]anyOf
Any of the following types.
binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

binSampleSize[]{SimpleSampleSize}..N*number
binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

binSampleSize[]{ProportionSampleSize}..numeratorN*number
binSampleSize[]{ProportionSampleSize}..denominatorN*number
errorBarsarray
errorBars[]object

Inherits: lib.ErrorBar

errorBars[].lowerBound*number
errorBars[].upperBound*number
errorBars[].error*string

Type PlotConfig (object)

PlotConfig

Inherits: object

Model

ParameterTypeDescription
completeCasesAllVars*number
completeCasesAxesVars*number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type SampleSizeTable (object)

SampleSizeTable

Inherits: object

Model

ParameterTypeDescription
xVariableDetailsarray
xVariableDetails[]object

Inherits: object

xVariableDetails[].entityId*string
xVariableDetails[].variableId*string
xVariableDetails[].value*string
overlayVariableDetailsobject

Inherits: object

overlayVariableDetails.entityId*string
overlayVariableDetails.variableId*string
overlayVariableDetails.value*string
facetVariableDetailsarray

Max. items: 2

facetVariableDetails[]object

Inherits: object

facetVariableDetails[].entityId*string
facetVariableDetails[].variableId*string
facetVariableDetails[].value*string
size*array
size[]number

Type VariableCompleteCases (object)

VariableCompleteCases

Inherits: object

Model

ParameterTypeDescription
variableDetails*object

Inherits: object

variableDetails.entityId*string
variableDetails.variableId*string
completeCases*number

Type CategoricalDistributionPostRequest (object)

CategoricalDistributionPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.variableId*string

Type CategoricalDistributionBin (object)

CategoricalDistributionBin

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
label*string
value*number

Type CategoricalDistributionPostResponse (object)

CategoricalDistributionPostResponse

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
countDistribution*array
countDistribution[]object

Additional properties: Yes

Inherits: object

countDistribution[].label*string
countDistribution[].value*number
proportionDistribution*array
proportionDistribution[]object

Additional properties: Yes

Inherits: object

proportionDistribution[].label*string
proportionDistribution[].value*number

Type ExampleComputeVizPostRequest (object)

ExampleComputeVizPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.ExampleComputeVizSpec

config.prefixVar*object

Inherits: object

config.prefixVar.entityId*string
config.prefixVar.variableId*string
computeConfig*object

Additional properties: Yes

Inherits: object

computeConfig.inputVariable*object

Inherits: object

computeConfig.inputVariable.entityId*string
computeConfig.inputVariable.variableId*string
computeConfig.valueSuffix*string

Type ExampleComputeVizSpec (object)

ExampleComputeVizSpec

Inherits: object

Model

ParameterTypeDescription
prefixVar*object

Inherits: object

prefixVar.entityId*string
prefixVar.variableId*string

Type ExampleComputeVizPostResponse (object)

ExampleComputeVizPostResponse

Inherits: object

Model

ParameterTypeDescription
countPluginResult*integer
numEmptyValues*integer
longestConcatenatedValue*string
avgConcatenatedLength*number

Type MultiStreamPostRequest (object)

MultiStreamPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.MultiStreamSpec

config.entityId*string

Type MultiStreamSpec (object)

MultiStreamSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostRequest (object)

RecordCountPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.RecordCountSpec

config.entityId*string

Type RecordCountSpec (object)

RecordCountSpec

Inherits: object

Model

ParameterTypeDescription
entityId*string

Type RecordCountPostResponse (object)

RecordCountPostResponse

Inherits: object

Model

ParameterTypeDescription
recordCount*integer

Type TestCollectionsPostRequest (object)

TestCollectionsPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: object

config.entityId*string
config.collectionId*string

Type CollectionFloatingBarplotPostRequest (object)

CollectionFloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string

Type CollectionFloatingBarplotSpec (object)

CollectionFloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string

Type CollectionFloatingBoxplotPostRequest (object)

CollectionFloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingBoxplotSpec (object)

CollectionFloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
maxAllowedDataPointsinteger

Format: int64

Type CollectionFloatingContTablePostRequest (object)

CollectionFloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.xAxisVariable.collection*object

Inherits: object

config.xAxisVariable.collection.entityId*string
config.xAxisVariable.collection.collectionId*string
config.xAxisVariable.selectedMembers*array
config.xAxisVariable.selectedMembers[]object

Inherits: object

config.xAxisVariable.selectedMembers[].entityId*string
config.xAxisVariable.selectedMembers[].variableId*string
config.xAxisVariable.selectedValuesarray
config.xAxisVariable.selectedValues[]string

Type CollectionFloatingContTableSpec (object)

CollectionFloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

xAxisVariable.collection*object

Inherits: object

xAxisVariable.collection.entityId*string
xAxisVariable.collection.collectionId*string
xAxisVariable.selectedMembers*array
xAxisVariable.selectedMembers[]object

Inherits: object

xAxisVariable.selectedMembers[].entityId*string
xAxisVariable.selectedMembers[].variableId*string
xAxisVariable.selectedValuesarray
xAxisVariable.selectedValues[]string

Type CollectionFloatingHistogramPostRequest (object)

CollectionFloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingHistogramSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.binSpec*object

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingHistogramSpec (object)

CollectionFloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
binSpec*object

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type CollectionFloatingLineplotPostRequest (object)

CollectionFloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.CollectionFloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

config.overlayConfig.collection*object

Inherits: object

config.overlayConfig.collection.entityId*string
config.overlayConfig.collection.collectionId*string
config.overlayConfig.selectedMembers*array
config.overlayConfig.selectedMembers[]object

Inherits: object

config.overlayConfig.selectedMembers[].entityId*string
config.overlayConfig.selectedMembers[].variableId*string
config.overlayConfig.selectedValuesarray
config.overlayConfig.selectedValues[]string
config.binSpecobject

Inherits: lib.BinWidthSpec

config.binSpec.typestring
Enum:
  • binWidth
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type CollectionFloatingLineplotSpec (object)

CollectionFloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfig*object

Additional properties: Yes

Inherits: lib.CollectionOverlayConfigWithValues

overlayConfig.collection*object

Inherits: object

overlayConfig.collection.entityId*string
overlayConfig.collection.collectionId*string
overlayConfig.selectedMembers*array
overlayConfig.selectedMembers[]object

Inherits: object

overlayConfig.selectedMembers[].entityId*string
overlayConfig.selectedMembers[].variableId*string
overlayConfig.selectedValuesarray
overlayConfig.selectedValues[]string
binSpecobject

Inherits: lib.BinWidthSpec

binSpec.typestring
Enum:
  • binWidth
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type StandaloneCollectionMapMarkerPostRequest (object)

StandaloneCollectionMapMarkerPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for a map marker

Inherits: lib.StandaloneCollectionMapMarkerSpec

config.outputEntityId*string

Entity ID associated with collection variable of interest.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number
config.collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

config.collection.collection*object

Inherits: object

config.collection.collection.entityId*string
config.collection.collection.collectionId*string
config.collection.selectedMembers*array
config.collection.selectedMembers[]object

Inherits: object

config.collection.selectedMembers[].entityId*string
config.collection.selectedMembers[].variableId*string
config.aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type StandaloneCollectionMapMarkerSpec (object)

StandaloneCollectionMapMarkerSpec

Specification for a map marker

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity ID associated with collection variable of interest.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number
collection*object

Collection variable to use for markers.

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

collection.collection*object

Inherits: object

collection.collection.entityId*string
collection.collection.collectionId*string
collection.selectedMembers*array
collection.selectedMembers[]object

Inherits: object

collection.selectedMembers[].entityId*string
collection.selectedMembers[].variableId*string
aggregatorConfig*object

Specification for how variable values will be aggregated into quantiative value shown in bar plot marker.

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregatorConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type CollectionOverlayConfig (object)

CollectionOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string

Type CollectionMapMarkerElement (object)

CollectionMapMarkerElement

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
entityCount*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number
values*array
values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

values[].variableId*string
values[].value*number
values[].confidenceInterval*object

Inherits: lib.NumberRange

values[].confidenceInterval.min*number
values[].confidenceInterval.max*number
values[].n*number

Type CollectionMemberAggregate (object)

CollectionMemberAggregate

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
variableId*string
value*number
confidenceInterval*object

Inherits: lib.NumberRange

confidenceInterval.min*number
confidenceInterval.max*number
n*number

Type StandaloneCollectionMapMarkerPostResponse (object)

StandaloneCollectionMapMarkerPostResponse

Inherits: object

Model

ParameterTypeDescription
markers*array
markers[]object

Data needed to render a collection map marker. Contains geographical data as well as per-variable collection var aggregates needed to render bar plots with error bar.

Additional properties: Yes

Inherits: object

markers[].entityCount*number
markers[].avgLat*number
markers[].avgLon*number
markers[].minLat*number
markers[].minLon*number
markers[].maxLat*number
markers[].maxLon*number
markers[].values*array
markers[].values[]object

Additional properties: Yes

Inherits: lib.CollectionMemberAggregate

markers[].values[].variableId*string
markers[].values[].value*number
markers[].values[].confidenceInterval*object

Inherits: lib.NumberRange

markers[].values[].confidenceInterval.min*number
markers[].values[].confidenceInterval.max*number
markers[].values[].n*number

Type FloatingBarplotPostRequest (object)

FloatingBarplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBarplotSpec

config.outputEntityId*string
config.barMode*string
Enum:
  • group
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string

Type FloatingBarplotSpec (object)

FloatingBarplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
barMode*string
Enum:
  • group
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string

Type FloatingBarplot (object)

FloatingBarplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBarplotPostResponse (object)

FloatingBarplotPostResponse

Inherits: object

Model

ParameterTypeDescription
barplot*object

Inherits: object

barplot.data*array
barplot.data[]object

Inherits: object

barplot.data[].overlayVariableDetailsobject

Inherits: object

barplot.data[].overlayVariableDetails.entityId*string
barplot.data[].overlayVariableDetails.variableId*string
barplot.data[].overlayVariableDetails.value*string
barplot.data[].facetVariableDetailsarray

Max. items: 2

barplot.data[].facetVariableDetails[]object

Inherits: object

barplot.data[].facetVariableDetails[].entityId*string
barplot.data[].facetVariableDetails[].variableId*string
barplot.data[].facetVariableDetails[].value*string
barplot.data[].value*array
barplot.data[].value[]number
barplot.data[].label*array
barplot.data[].label[]string
barplot.variables*array
barplot.variables[]object

Inherits: object

barplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

barplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

barplot.variables[].variableSpec.entityId*string
barplot.variables[].variableSpec.variableId*string
barplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

barplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

barplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

barplot.variables[].displayNamestring
barplot.variables[].displayRangeMinany
barplot.variables[].displayRangeMaxany
barplot.variables[].vocabularyarray
barplot.variables[].vocabulary[]string
barplot.variables[].imputeZero*boolean
barplot.variables[].hasStudyDependentVocabularyboolean
barplot.variables[].isCollection*boolean
barplot.variables[].membersarray
barplot.variables[].members[]object

Inherits: lib.VariableSpec

barplot.variables[].members[].entityId*string
barplot.variables[].members[].variableId*string

Type FloatingBoxplotPostRequest (object)

FloatingBoxplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingBoxplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplotSpec (object)

FloatingBoxplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingBoxplot (object)

FloatingBoxplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].lowerfence*array
data[].lowerfence[]number
data[].upperfence*array
data[].upperfence[]number
data[].q1*array
data[].q1[]number
data[].q3*array
data[].q3[]number
data[].median*array
data[].median[]number
data[].outliersarray
data[].outliers[]array
data[].outliers[][]number
data[].rawDataarray
data[].rawData[]array
data[].rawData[][]number
data[].meanarray
data[].mean[]number
data[].label*array
data[].label[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingBoxplotPostResponse (object)

FloatingBoxplotPostResponse

Inherits: object

Model

ParameterTypeDescription
boxplot*object

Inherits: object

boxplot.data*array
boxplot.data[]object

Inherits: object

boxplot.data[].overlayVariableDetailsobject

Inherits: object

boxplot.data[].overlayVariableDetails.entityId*string
boxplot.data[].overlayVariableDetails.variableId*string
boxplot.data[].overlayVariableDetails.value*string
boxplot.data[].facetVariableDetailsarray

Max. items: 2

boxplot.data[].facetVariableDetails[]object

Inherits: object

boxplot.data[].facetVariableDetails[].entityId*string
boxplot.data[].facetVariableDetails[].variableId*string
boxplot.data[].facetVariableDetails[].value*string
boxplot.data[].lowerfence*array
boxplot.data[].lowerfence[]number
boxplot.data[].upperfence*array
boxplot.data[].upperfence[]number
boxplot.data[].q1*array
boxplot.data[].q1[]number
boxplot.data[].q3*array
boxplot.data[].q3[]number
boxplot.data[].median*array
boxplot.data[].median[]number
boxplot.data[].outliersarray
boxplot.data[].outliers[]array
boxplot.data[].outliers[][]number
boxplot.data[].rawDataarray
boxplot.data[].rawData[]array
boxplot.data[].rawData[][]number
boxplot.data[].meanarray
boxplot.data[].mean[]number
boxplot.data[].label*array
boxplot.data[].label[]string
boxplot.variables*array
boxplot.variables[]object

Inherits: object

boxplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

boxplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

boxplot.variables[].variableSpec.entityId*string
boxplot.variables[].variableSpec.variableId*string
boxplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

boxplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

boxplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

boxplot.variables[].displayNamestring
boxplot.variables[].displayRangeMinany
boxplot.variables[].displayRangeMaxany
boxplot.variables[].vocabularyarray
boxplot.variables[].vocabulary[]string
boxplot.variables[].imputeZero*boolean
boxplot.variables[].hasStudyDependentVocabularyboolean
boxplot.variables[].isCollection*boolean
boxplot.variables[].membersarray
boxplot.variables[].members[]object

Inherits: lib.VariableSpec

boxplot.variables[].members[].entityId*string
boxplot.variables[].members[].variableId*string

Type FloatingContTablePostRequest (object)

FloatingContTablePostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingContTableSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string

Type FloatingContTableSpec (object)

FloatingContTableSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string

Type FloatingContTable (object)

FloatingContTable

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].xLabel*array
data[].xLabel[]string
data[].yLabel*array
data[].yLabel[]array
data[].yLabel[][]string
data[].value*array
data[].value[]array
data[].value[][]number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingContTablePostResponse (object)

FloatingContTablePostResponse

Inherits: object

Model

ParameterTypeDescription
mosaic*object

Inherits: object

mosaic.data*array
mosaic.data[]object

Inherits: object

mosaic.data[].facetVariableDetailsarray

Max. items: 2

mosaic.data[].facetVariableDetails[]object

Inherits: object

mosaic.data[].facetVariableDetails[].entityId*string
mosaic.data[].facetVariableDetails[].variableId*string
mosaic.data[].facetVariableDetails[].value*string
mosaic.data[].xLabel*array
mosaic.data[].xLabel[]string
mosaic.data[].yLabel*array
mosaic.data[].yLabel[]array
mosaic.data[].yLabel[][]string
mosaic.data[].value*array
mosaic.data[].value[]array
mosaic.data[].value[][]number
mosaic.variables*array
mosaic.variables[]object

Inherits: object

mosaic.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

mosaic.variables[].variableSpec*object

Inherits: lib.VariableSpec

mosaic.variables[].variableSpec.entityId*string
mosaic.variables[].variableSpec.variableId*string
mosaic.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

mosaic.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

mosaic.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

mosaic.variables[].displayNamestring
mosaic.variables[].displayRangeMinany
mosaic.variables[].displayRangeMaxany
mosaic.variables[].vocabularyarray
mosaic.variables[].vocabulary[]string
mosaic.variables[].imputeZero*boolean
mosaic.variables[].hasStudyDependentVocabularyboolean
mosaic.variables[].isCollection*boolean
mosaic.variables[].membersarray
mosaic.variables[].members[]object

Inherits: lib.VariableSpec

mosaic.variables[].members[].entityId*string
mosaic.variables[].members[].variableId*string
statsTablearray
statsTable[]object

Inherits: object

statsTable[].facetVariableDetailsarray

Max. items: 2

statsTable[].facetVariableDetails[]object

Inherits: object

statsTable[].facetVariableDetails[].entityId*string
statsTable[].facetVariableDetails[].variableId*string
statsTable[].facetVariableDetails[].value*string
statsTable[].chisq*object

Inherits: object

statsTable[].chisq.value*number
statsTable[].chisq.confidenceIntervalstring
statsTable[].chisq.confidenceLevelnumber
statsTable[].chisq.pvalue*string
statsTable[].fisher*object

Inherits: object

statsTable[].fisher.value*number
statsTable[].fisher.confidenceIntervalstring
statsTable[].fisher.confidenceLevelnumber
statsTable[].fisher.pvalue*string
statsTable[].prevalenceobject

Inherits: object

statsTable[].prevalence.value*number
statsTable[].prevalence.confidenceIntervalstring
statsTable[].prevalence.confidenceLevelnumber
statsTable[].prevalence.pvalue*string
statsTable[].oddsratioobject

Inherits: object

statsTable[].oddsratio.value*number
statsTable[].oddsratio.confidenceIntervalstring
statsTable[].oddsratio.confidenceLevelnumber
statsTable[].oddsratio.pvalue*string
statsTable[].relativeriskobject

Inherits: object

statsTable[].relativerisk.value*number
statsTable[].relativerisk.confidenceIntervalstring
statsTable[].relativerisk.confidenceLevelnumber
statsTable[].relativerisk.pvalue*string
statsTable[].sensitivityobject

Inherits: object

statsTable[].sensitivity.value*number
statsTable[].sensitivity.confidenceIntervalstring
statsTable[].sensitivity.confidenceLevelnumber
statsTable[].sensitivity.pvalue*string
statsTable[].specificityobject

Inherits: object

statsTable[].specificity.value*number
statsTable[].specificity.confidenceIntervalstring
statsTable[].specificity.confidenceLevelnumber
statsTable[].specificity.pvalue*string
statsTable[].posPredictiveValueobject

Inherits: object

statsTable[].posPredictiveValue.value*number
statsTable[].posPredictiveValue.confidenceIntervalstring
statsTable[].posPredictiveValue.confidenceLevelnumber
statsTable[].posPredictiveValue.pvalue*string
statsTable[].negPredictiveValueobject

Inherits: object

statsTable[].negPredictiveValue.value*number
statsTable[].negPredictiveValue.confidenceIntervalstring
statsTable[].negPredictiveValue.confidenceLevelnumber
statsTable[].negPredictiveValue.pvalue*string

Type FloatingHistogramPostRequest (object)

FloatingHistogramPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingHistogramSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.barMode*string
Enum:
  • overlay
  • stack
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpec*object

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingHistogramSpec (object)

FloatingHistogramSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
barMode*string
Enum:
  • overlay
  • stack
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpec*object

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingHistogram (object)

FloatingHistogram

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].value*array
data[].value[]number
data[].binStart*array
data[].binStart[]string
data[].binEnd*array
data[].binEnd[]string
data[].binLabel*array
data[].binLabel[]string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingHistogramPostResponse (object)

FloatingHistogramPostResponse

Inherits: object

Model

ParameterTypeDescription
histogram*object

Inherits: object

histogram.data*array
histogram.data[]object

Inherits: object

histogram.data[].overlayVariableDetailsobject

Inherits: object

histogram.data[].overlayVariableDetails.entityId*string
histogram.data[].overlayVariableDetails.variableId*string
histogram.data[].overlayVariableDetails.value*string
histogram.data[].facetVariableDetailsarray

Max. items: 2

histogram.data[].facetVariableDetails[]object

Inherits: object

histogram.data[].facetVariableDetails[].entityId*string
histogram.data[].facetVariableDetails[].variableId*string
histogram.data[].facetVariableDetails[].value*string
histogram.data[].value*array
histogram.data[].value[]number
histogram.data[].binStart*array
histogram.data[].binStart[]string
histogram.data[].binEnd*array
histogram.data[].binEnd[]string
histogram.data[].binLabel*array
histogram.data[].binLabel[]string
histogram.variables*array
histogram.variables[]object

Inherits: object

histogram.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

histogram.variables[].variableSpec*object

Inherits: lib.VariableSpec

histogram.variables[].variableSpec.entityId*string
histogram.variables[].variableSpec.variableId*string
histogram.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

histogram.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

histogram.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

histogram.variables[].displayNamestring
histogram.variables[].displayRangeMinany
histogram.variables[].displayRangeMaxany
histogram.variables[].vocabularyarray
histogram.variables[].vocabulary[]string
histogram.variables[].imputeZero*boolean
histogram.variables[].hasStudyDependentVocabularyboolean
histogram.variables[].isCollection*boolean
histogram.variables[].membersarray
histogram.variables[].members[]object

Inherits: lib.VariableSpec

histogram.variables[].members[].entityId*string
histogram.variables[].members[].variableId*string

Type FloatingLineplotPostRequest (object)

FloatingLineplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingLineplotSpec

config.outputEntityId*string
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.yAxisNumeratorValuesarray
config.yAxisNumeratorValues[]string
config.yAxisDenominatorValuesarray
config.yAxisDenominatorValues[]string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.binSpecobject

Inherits: lib.BinSpec

config.binSpec.typestring
Enum:
  • binWidth
  • numBins
config.binSpec.valuenumber
config.binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

config.binSpec.rangeunion
config.binSpec.rangeanyOf
Any of the following types.
config.binSpec.range{NumberRange}object

Inherits: lib.NumberRange

config.binSpec.range{NumberRange}..min*number
config.binSpec.range{NumberRange}..max*number
config.binSpec.range{DateRange}object

Inherits: lib.DateRange

config.binSpec.range{DateRange}..min*string
config.binSpec.range{DateRange}..max*string
config.valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
config.errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

config.viewportobject

Inherits: lib.NumericViewport

config.viewport.xMin*string
config.viewport.xMax*string

Type FloatingLineplotSpec (object)

FloatingLineplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
yAxisNumeratorValuesarray
yAxisNumeratorValues[]string
yAxisDenominatorValuesarray
yAxisDenominatorValues[]string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
binSpecobject

Inherits: lib.BinSpec

binSpec.typestring
Enum:
  • binWidth
  • numBins
binSpec.valuenumber
binSpec.unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

binSpec.rangeunion
binSpec.rangeanyOf
Any of the following types.
binSpec.range{NumberRange}object

Inherits: lib.NumberRange

binSpec.range{NumberRange}..min*number
binSpec.range{NumberRange}..max*number
binSpec.range{DateRange}object

Inherits: lib.DateRange

binSpec.range{DateRange}..min*string
binSpec.range{DateRange}..max*string
valueSpec*string
Enum:
  • median
  • mean
  • geometricMean
  • proportion
errorBars*string
Enum:
  • TRUE
  • FALSE

Inherits: lib.StringBoolean

viewportobject

Inherits: lib.NumericViewport

viewport.xMin*string
viewport.xMax*string

Type FloatingLineplot (object)

FloatingLineplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].binStartarray
data[].binStart[]string
data[].binEndarray
data[].binEnd[]string
data[].binSampleSizearray
data[].binSampleSize[]union

Inherits: lib.SampleSize

data[].binSampleSize[]anyOf
Any of the following types.
data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

data[].binSampleSize[]{SimpleSampleSize}..N*number
data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
data[].errorBarsarray
data[].errorBars[]object

Inherits: lib.ErrorBar

data[].errorBars[].lowerBound*number
data[].errorBars[].upperBound*number
data[].errorBars[].error*string
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingLineplotPostResponse (object)

FloatingLineplotPostResponse

Inherits: object

Model

ParameterTypeDescription
lineplot*object

Inherits: object

lineplot.data*array
lineplot.data[]object

Inherits: object

lineplot.data[].overlayVariableDetailsobject

Inherits: object

lineplot.data[].overlayVariableDetails.entityId*string
lineplot.data[].overlayVariableDetails.variableId*string
lineplot.data[].overlayVariableDetails.value*string
lineplot.data[].facetVariableDetailsarray

Max. items: 2

lineplot.data[].facetVariableDetails[]object

Inherits: object

lineplot.data[].facetVariableDetails[].entityId*string
lineplot.data[].facetVariableDetails[].variableId*string
lineplot.data[].facetVariableDetails[].value*string
lineplot.data[].seriesY*array
lineplot.data[].seriesY[]string
lineplot.data[].seriesX*array
lineplot.data[].seriesX[]string
lineplot.data[].binStartarray
lineplot.data[].binStart[]string
lineplot.data[].binEndarray
lineplot.data[].binEnd[]string
lineplot.data[].binSampleSizearray
lineplot.data[].binSampleSize[]union

Inherits: lib.SampleSize

lineplot.data[].binSampleSize[]anyOf
Any of the following types.
lineplot.data[].binSampleSize[]{SimpleSampleSize}object

Inherits: lib.SimpleSampleSize

lineplot.data[].binSampleSize[]{SimpleSampleSize}..N*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}object

Inherits: lib.ProportionSampleSize

lineplot.data[].binSampleSize[]{ProportionSampleSize}..numeratorN*number
lineplot.data[].binSampleSize[]{ProportionSampleSize}..denominatorN*number
lineplot.data[].errorBarsarray
lineplot.data[].errorBars[]object

Inherits: lib.ErrorBar

lineplot.data[].errorBars[].lowerBound*number
lineplot.data[].errorBars[].upperBound*number
lineplot.data[].errorBars[].error*string
lineplot.variables*array
lineplot.variables[]object

Inherits: object

lineplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

lineplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

lineplot.variables[].variableSpec.entityId*string
lineplot.variables[].variableSpec.variableId*string
lineplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

lineplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

lineplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

lineplot.variables[].displayNamestring
lineplot.variables[].displayRangeMinany
lineplot.variables[].displayRangeMaxany
lineplot.variables[].vocabularyarray
lineplot.variables[].vocabulary[]string
lineplot.variables[].imputeZero*boolean
lineplot.variables[].hasStudyDependentVocabularyboolean
lineplot.variables[].isCollection*boolean
lineplot.variables[].membersarray
lineplot.variables[].members[]object

Inherits: lib.VariableSpec

lineplot.variables[].members[].entityId*string
lineplot.variables[].members[].variableId*string

Type FloatingScatterplotPostRequest (object)

FloatingScatterplotPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.FloatingScatterplotSpec

config.outputEntityId*string
config.valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
config.xAxisVariable*object

Inherits: object

config.xAxisVariable.entityId*string
config.xAxisVariable.variableId*string
config.yAxisVariable*object

Inherits: object

config.yAxisVariable.entityId*string
config.yAxisVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplotSpec (object)

FloatingScatterplotSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
yAxisVariable*object

Inherits: object

yAxisVariable.entityId*string
yAxisVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
maxAllowedDataPointsinteger

Format: int64

Type FloatingScatterplot (object)

FloatingScatterplot

Inherits: object

Model

ParameterTypeDescription
data*array
data[]object

Inherits: object

data[].overlayVariableDetailsobject

Inherits: object

data[].overlayVariableDetails.entityId*string
data[].overlayVariableDetails.variableId*string
data[].overlayVariableDetails.value*string
data[].facetVariableDetailsarray

Max. items: 2

data[].facetVariableDetails[]object

Inherits: object

data[].facetVariableDetails[].entityId*string
data[].facetVariableDetails[].variableId*string
data[].facetVariableDetails[].value*string
data[].seriesY*array
data[].seriesY[]string
data[].seriesX*array
data[].seriesX[]string
data[].smoothedMeanXarray
data[].smoothedMeanX[]string
data[].smoothedMeanYarray
data[].smoothedMeanY[]number
data[].smoothedMeanSEarray
data[].smoothedMeanSE[]number
data[].smoothedMeanErrorstring
data[].bestFitLineXarray
data[].bestFitLineX[]string
data[].bestFitLineYarray
data[].bestFitLineY[]number
data[].r2number
variables*array
variables[]object

Inherits: object

variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

variables[].variableSpec*object

Inherits: lib.VariableSpec

variables[].variableSpec.entityId*string
variables[].variableSpec.variableId*string
variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

variables[].displayNamestring
variables[].displayRangeMinany
variables[].displayRangeMaxany
variables[].vocabularyarray
variables[].vocabulary[]string
variables[].imputeZero*boolean
variables[].hasStudyDependentVocabularyboolean
variables[].isCollection*boolean
variables[].membersarray
variables[].members[]object

Inherits: lib.VariableSpec

variables[].members[].entityId*string
variables[].members[].variableId*string

Type FloatingScatterplotPostResponse (object)

FloatingScatterplotPostResponse

Inherits: object

Model

ParameterTypeDescription
scatterplot*object

Inherits: object

scatterplot.data*array
scatterplot.data[]object

Inherits: object

scatterplot.data[].overlayVariableDetailsobject

Inherits: object

scatterplot.data[].overlayVariableDetails.entityId*string
scatterplot.data[].overlayVariableDetails.variableId*string
scatterplot.data[].overlayVariableDetails.value*string
scatterplot.data[].facetVariableDetailsarray

Max. items: 2

scatterplot.data[].facetVariableDetails[]object

Inherits: object

scatterplot.data[].facetVariableDetails[].entityId*string
scatterplot.data[].facetVariableDetails[].variableId*string
scatterplot.data[].facetVariableDetails[].value*string
scatterplot.data[].seriesY*array
scatterplot.data[].seriesY[]string
scatterplot.data[].seriesX*array
scatterplot.data[].seriesX[]string
scatterplot.data[].smoothedMeanXarray
scatterplot.data[].smoothedMeanX[]string
scatterplot.data[].smoothedMeanYarray
scatterplot.data[].smoothedMeanY[]number
scatterplot.data[].smoothedMeanSEarray
scatterplot.data[].smoothedMeanSE[]number
scatterplot.data[].smoothedMeanErrorstring
scatterplot.data[].bestFitLineXarray
scatterplot.data[].bestFitLineX[]string
scatterplot.data[].bestFitLineYarray
scatterplot.data[].bestFitLineY[]number
scatterplot.data[].r2number
scatterplot.variables*array
scatterplot.variables[]object

Inherits: object

scatterplot.variables[].variableClass*string
Enum:
  • native
  • derived
  • computed

Inherits: string

scatterplot.variables[].variableSpec*object

Inherits: lib.VariableSpec

scatterplot.variables[].variableSpec.entityId*string
scatterplot.variables[].variableSpec.variableId*string
scatterplot.variables[].plotReference*string
Enum:
  • xAxis
  • yAxis
  • zAxis
  • overlay
  • facet1
  • facet2
  • geo
  • latitude
  • longitude

Inherits: string

scatterplot.variables[].dataType*string
Enum:
  • category
  • string
  • number
  • date
  • longitude
  • integer

Inherits: lib.API_VariableType

scatterplot.variables[].dataShape*string
Enum:
  • continuous
  • categorical
  • ordinal
  • binary

Inherits: lib.API_VariableDataShape

scatterplot.variables[].displayNamestring
scatterplot.variables[].displayRangeMinany
scatterplot.variables[].displayRangeMaxany
scatterplot.variables[].vocabularyarray
scatterplot.variables[].vocabulary[]string
scatterplot.variables[].imputeZero*boolean
scatterplot.variables[].hasStudyDependentVocabularyboolean
scatterplot.variables[].isCollection*boolean
scatterplot.variables[].membersarray
scatterplot.variables[].members[]object

Inherits: lib.VariableSpec

scatterplot.variables[].members[].entityId*string
scatterplot.variables[].members[].variableId*string

Type StandaloneMapBubblesLegendPostRequest (object)

StandaloneMapBubblesLegendPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapBubblesLegendSpec

config.outputEntityId*string
config.colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

config.colorLegendConfig.geoAggregateVariable*object

Inherits: object

config.colorLegendConfig.geoAggregateVariable.entityId*string
config.colorLegendConfig.geoAggregateVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
config.colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.sizeConfig*object

Inherits: lib.SizeLegendConfig

config.sizeConfig.geoAggregateVariable*object

Inherits: object

config.sizeConfig.geoAggregateVariable.entityId*string
config.sizeConfig.geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendSpec (object)

StandaloneMapBubblesLegendSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
colorLegendConfig*object

Inherits: lib.OverlayLegendConfig

colorLegendConfig.geoAggregateVariable*object

Inherits: object

colorLegendConfig.geoAggregateVariable.entityId*string
colorLegendConfig.geoAggregateVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

colorLegendConfig.quantitativeOverlayConfig.overlayVariable*object

Inherits: object

colorLegendConfig.quantitativeOverlayConfig.overlayVariable.entityId*string
colorLegendConfig.quantitativeOverlayConfig.overlayVariable.variableId*string
colorLegendConfig.quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

colorLegendConfig.quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

sizeConfig*object

Inherits: lib.SizeLegendConfig

sizeConfig.geoAggregateVariable*object

Inherits: object

sizeConfig.geoAggregateVariable.entityId*string
sizeConfig.geoAggregateVariable.variableId*string

Type OverlayLegendConfig (object)

OverlayLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
quantitativeOverlayConfig*object

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

quantitativeOverlayConfig.overlayVariable*object

Inherits: object

quantitativeOverlayConfig.overlayVariable.entityId*string
quantitativeOverlayConfig.overlayVariable.variableId*string
quantitativeOverlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

quantitativeOverlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

Type SizeLegendConfig (object)

SizeLegendConfig

Inherits: object

Model

ParameterTypeDescription
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string

Type StandaloneMapBubblesLegendPostResponse (object)

StandaloneMapBubblesLegendPostResponse

Inherits: object

Model

ParameterTypeDescription
minColorValue*string
maxColorValue*string
minSizeValue*number
maxSizeValue*number

Type StandaloneMapBubblesPostRequest (object)

StandaloneMapBubblesPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Specification for map bubbles.

Inherits: lib.StandaloneMapBubblesSpec

config.outputEntityId*string

Entity whose cardinality will be reported per marker.

config.geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

config.overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapBubblesSpec (object)

StandaloneMapBubblesSpec

Specification for map bubbles.

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string

Entity whose cardinality will be reported per marker.

geoAggregateVariable*object

Geohash component variable to group markers by. This is usually determined by zoom level of the client application.

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Variable representing longitude of output entity.

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Variable representing latitude of output entity.

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Overlay configuration for quantitative overlay. The quantitative overlay value can be used to render color on the markers.

Additional properties: Yes

Inherits: lib.QuantitativeOverlayConfig

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
overlayConfig.aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

overlayConfig.aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Viewport used to filter markers. Only entities that are contained in the viewport will be grouped into markers.

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapBubblesPostResponse (object)

StandaloneMapBubblesPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.ColoredMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValue*string
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type ColoredMapElementInfo (object)

ColoredMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValue*string
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type StandaloneMapMarkersPostRequest (object)

StandaloneMapMarkersPostRequest

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

config*object

Inherits: lib.StandaloneMapMarkersSpec

config.outputEntityId*string
config.geoAggregateVariable*object

Inherits: object

config.geoAggregateVariable.entityId*string
config.geoAggregateVariable.variableId*string
config.longitudeVariable*object

Inherits: object

config.longitudeVariable.entityId*string
config.longitudeVariable.variableId*string
config.latitudeVariable*object

Inherits: object

config.latitudeVariable.entityId*string
config.latitudeVariable.variableId*string
config.overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

config.overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

config.overlayConfig.overlayVariable*object

Inherits: object

config.overlayConfig.overlayVariable.entityId*string
config.overlayConfig.overlayVariable.variableId*string
config.valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

config.viewport*object

Inherits: lib.GeolocationViewport

config.viewport.latitude*object

Inherits: lib.NumericViewport

config.viewport.latitude.xMin*string
config.viewport.latitude.xMax*string
config.viewport.longitude*object

Inherits: lib.LongitudeViewport

config.viewport.longitude.left*number
config.viewport.longitude.right*number

Type StandaloneMapMarkersSpec (object)

StandaloneMapMarkersSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
geoAggregateVariable*object

Inherits: object

geoAggregateVariable.entityId*string
geoAggregateVariable.variableId*string
longitudeVariable*object

Inherits: object

longitudeVariable.entityId*string
longitudeVariable.variableId*string
latitudeVariable*object

Inherits: object

latitudeVariable.entityId*string
latitudeVariable.variableId*string
overlayConfigobject

Discriminator: overlayType

Inherits: lib.OverlayConfig

overlayConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: lib.OverlayType

overlayConfig.overlayVariable*object

Inherits: object

overlayConfig.overlayVariable.entityId*string
overlayConfig.overlayVariable.variableId*string
valueSpec*string
Enum:
  • count
  • proportion

Inherits: string

viewport*object

Inherits: lib.GeolocationViewport

viewport.latitude*object

Inherits: lib.NumericViewport

viewport.latitude.xMin*string
viewport.latitude.xMax*string
viewport.longitude*object

Inherits: lib.LongitudeViewport

viewport.longitude.left*number
viewport.longitude.right*number

Type StandaloneMapMarkersPostResponse (object)

StandaloneMapMarkersPostResponse

Inherits: object

Model

ParameterTypeDescription
mapElements*array
mapElements[]object

Inherits: lib.StandaloneMapElementInfo

mapElements[].geoAggregateValue*string
mapElements[].entityCount*number
mapElements[].overlayValues*array
mapElements[].overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

mapElements[].overlayValues[].binStart*string
mapElements[].overlayValues[].binEnd*string
mapElements[].overlayValues[].binLabel*string
mapElements[].overlayValues[].value*number
mapElements[].overlayValues[].count*number
mapElements[].avgLat*number
mapElements[].avgLon*number
mapElements[].minLat*number
mapElements[].minLon*number
mapElements[].maxLat*number
mapElements[].maxLon*number

Type OverlayType (string)

OverlayType
Enum:
  • continuous
  • categorical

Inherits: string

Type OverlayConfig (object)

OverlayConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string

Type ContinousOverlayConfig (object)

ContinousOverlayConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRange

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string

Type CategoricalOverlayConfig (object)

CategoricalOverlayConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.OverlayConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
overlayValues*array
overlayValues[]string

Type StandaloneMapElementInfo (object)

StandaloneMapElementInfo

Inherits: object

Model

ParameterTypeDescription
geoAggregateValue*string
entityCount*number
overlayValues*array
overlayValues[]object

Inherits: lib.LegacyLabeledRangeWithCountAndValue

overlayValues[].binStart*string
overlayValues[].binEnd*string
overlayValues[].binLabel*string
overlayValues[].value*number
overlayValues[].count*number
avgLat*number
avgLon*number
minLat*number
minLon*number
maxLat*number
maxLon*number

Type DataPluginRequestBase (object)

DataPluginRequestBase

Inherits: object

Model

ParameterTypeDescription
studyId*string
filtersarray
filters[]object

Additional properties: Yes

Discriminator: type

Inherits: object

filters[].entityId*string
filters[].type*string
Enum:
  • stringSet
  • numberSet
  • dateSet
  • numberRange
  • dateRange
  • longitudeRange
  • multiFilter

Inherits: lib.API_FilterType

derivedVariablesarray
derivedVariables[]object

Inherits: lib.VariableSpec

derivedVariables[].entityId*string
derivedVariables[].variableId*string
derivedVariables[].functionName*string
derivedVariables[].displayName*string
derivedVariables[].config*object

Additional properties: Yes

Type EmptyDataPluginSpec (object)

EmptyDataPluginSpec

Inherits: object

Model

ParameterTypeDescription

Type StringBoolean (string)

StringBoolean
Enum:
  • TRUE
  • FALSE

Inherits: string

Type StrataVariableDetails (object)

StrataVariableDetails

Model

ParameterTypeDescription
entityId*string
variableId*string
value*string

Type BinSpec (object)

BinSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
  • numBins
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type BinWidthSpec (object)

BinWidthSpec

Inherits: object

Model

ParameterTypeDescription
typestring
Enum:
  • binWidth
valuenumber
unitsstring
Enum:
  • day
  • week
  • month
  • year

Inherits: string

rangeunion
rangeanyOf
Any of the following types.
range{NumberRange}object

Inherits: lib.NumberRange

range{NumberRange}..min*number
range{NumberRange}..max*number
range{DateRange}object

Inherits: lib.DateRange

range{DateRange}..min*string
range{DateRange}..max*string

Type NumberRange (object)

NumberRange

Inherits: object

Model

ParameterTypeDescription
min*number
max*number

Type DateRange (object)

DateRange

Inherits: object

Model

ParameterTypeDescription
min*string
max*string

Type NumericViewport (object)

NumericViewport

Inherits: object

Model

ParameterTypeDescription
xMin*string
xMax*string

Type LongitudeViewport (object)

LongitudeViewport

Inherits: object

Model

ParameterTypeDescription
left*number
right*number

Type GeolocationViewport (object)

GeolocationViewport

Inherits: object

Model

ParameterTypeDescription
latitude*object

Inherits: object

latitude.xMin*string
latitude.xMax*string
longitude*object

Inherits: object

longitude.left*number
longitude.right*number

Type ErrorBar (object)

ErrorBar

Inherits: object

Model

ParameterTypeDescription
lowerBound*number
upperBound*number
error*string

Type SimpleSampleSize (object)

SimpleSampleSize

Inherits: object

Model

ParameterTypeDescription
N*number

Type ProportionSampleSize (object)

ProportionSampleSize

Inherits: object

Model

ParameterTypeDescription
numeratorN*number
denominatorN*number

Type SampleSize (union)

SampleSize

Inherits: lib.SimpleSampleSize | lib.ProportionSampleSize

Model

ParameterTypeDescription
anyOf
Any of the following types.
{SimpleSampleSize}object

Inherits: object

{SimpleSampleSize}.N*number
{ProportionSampleSize}object

Inherits: object

{ProportionSampleSize}.numeratorN*number
{ProportionSampleSize}.denominatorN*number

Type ShowMissingness (string)

ShowMissingness
Enum:
  • allVariables
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type ShowMissingnessNoAxes (string)

ShowMissingnessNoAxes
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

Type BoxplotWith1ComputeSpec (object)

BoxplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

points*string
Enum:
  • outliers
  • all
mean*string
Enum:
  • TRUE
  • FALSE

Inherits: string

computeStats*string
Enum:
  • TRUE
  • FALSE

Inherits: string

xAxisVariableobject

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type ScatterplotWith1ComputeSpec (object)

ScatterplotWith1ComputeSpec

Inherits: object

Model

ParameterTypeDescription
outputEntityId*string
showMissingnessstring
Enum:
  • strataVariables
  • noVariables
  • TRUE
  • FALSE

Inherits: string

valueSpec*string
Enum:
  • raw
  • smoothedMeanWithRaw
  • bestFitLineWithRaw
xAxisVariable*object

Inherits: object

xAxisVariable.entityId*string
xAxisVariable.variableId*string
overlayVariableobject

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
facetVariablearray

Max. items: 2

facetVariable[]object

Inherits: object

facetVariable[].entityId*string
facetVariable[].variableId*string

Type Aggregator (string)

Aggregator
Enum:
  • mean
  • median

Inherits: string

Type QuantitativeOverlayConfig (object)

QuantitativeOverlayConfig

Additional properties: Yes

Inherits: object

Model

ParameterTypeDescription
overlayVariable*object

Inherits: object

overlayVariable.entityId*string
overlayVariable.variableId*string
aggregationConfig*object

Discriminator: overlayType

Inherits: lib.QuantitativeAggregationConfig

aggregationConfig.overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type QuantitativeAggregationConfig (object)

QuantitativeAggregationConfig

Discriminator: overlayType

Inherits: object

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

Type ContinuousAggregationConfig (object)

ContinuousAggregationConfig

Discriminator: overlayType

Discriminator value: continuous

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

aggregator*string
Enum:
  • mean
  • median

Inherits: string

Type CategoricalAggregationConfig (object)

CategoricalAggregationConfig

Discriminator: overlayType

Discriminator value: categorical

Inherits: lib.QuantitativeAggregationConfig

Model

ParameterTypeDescription
overlayType*string
Enum:
  • continuous
  • categorical

Inherits: string

numeratorValues*array
numeratorValues[]string
denominatorValues*array
denominatorValues[]string

Type CollectionOverlayConfigWithValues (object)

CollectionOverlayConfigWithValues

Additional properties: Yes

Inherits: lib.CollectionOverlayConfig

Model

ParameterTypeDescription
collection*object

Inherits: object

collection.entityId*string
collection.collectionId*string
selectedMembers*array
selectedMembers[]object

Inherits: object

selectedMembers[].entityId*string
selectedMembers[].variableId*string
selectedValuesarray
selectedValues[]string

Type LegacyLabeledRange (object)

LegacyLabeledRange

Inherits: object

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string

Type LegacyLabeledRangeWithCountAndValue (object)

LegacyLabeledRangeWithCountAndValue

Model

ParameterTypeDescription
binStart*string
binEnd*string
binLabel*string
value*number
count*number

Type Error (object)

Error

Discriminator: status

Inherits: object

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Type ErrorType (string)

ErrorType
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: string

Type BadRequestError (object)

Bad Request

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Examples

{
   "status": "bad-request",
   "message": "malformed JSON"
 }

Type UnauthorizedError (object)

Unauthorized

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Model

ParameterTypeDescription
status*string
Enum:
  • bad-request
  • unauthorized
  • forbidden
  • not-found
  • bad-method
  • invalid-input
  • server-error

Inherits: error.ErrorType

message*string

Examples

{

From 2d3a05ffae8e713253775d178eaf4a40efc2a24c Mon Sep 17 00:00:00 2001
From: Danielle Callan 
Date: Wed, 10 Jan 2024 12:24:44 -0500
Subject: [PATCH 4/5] clean up

---
 .../java/org/veupathdb/service/eda/ds/core/AbstractPlugin.java | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/src/main/java/org/veupathdb/service/eda/ds/core/AbstractPlugin.java b/src/main/java/org/veupathdb/service/eda/ds/core/AbstractPlugin.java
index 44715f2d..3f20804d 100644
--- a/src/main/java/org/veupathdb/service/eda/ds/core/AbstractPlugin.java
+++ b/src/main/java/org/veupathdb/service/eda/ds/core/AbstractPlugin.java
@@ -724,9 +724,6 @@ public boolean validateImputeZeroesRequest(Map dataSpec
 
     List dataSpecsWithStudyDependentVocabs = dataSpecs.entrySet().stream().filter(entry -> hasStudyDependentVocabulary(entry.getValue())).map(Map.Entry::getValue).toList();
     List entities = dataSpecsWithStudyDependentVocabs.stream().map(data -> getDynamicDataSpecEntityId(data)).toList();
-    //if (entities.size() == 0) {
-    //  return false;
-    //}
 
     boolean allEqualEntities = entities.isEmpty() || Collections.frequency(entities, entities.get(0)) == entities.size();
     if (!allEqualEntities) { 

From 7eb624fa9a8ba8ea20456d1e5f55b773aab0ffba Mon Sep 17 00:00:00 2001
From: Danielle Callan 
Date: Wed, 10 Jan 2024 12:25:10 -0500
Subject: [PATCH 5/5] strokeWidth -> weight for network links

---
 schema/library.raml                                             | 2 +-
 schema/url/networks.raml                                        | 2 +-
 .../plugin/correlation/AbstractCorrelationBipartiteNetwork.java | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/schema/library.raml b/schema/library.raml
index 53279a33..206bb3fa 100644
--- a/schema/library.raml
+++ b/schema/library.raml
@@ -926,7 +926,7 @@ types:
     properties:
       source: NodeData
       target: NodeData
-      strokeWidth: string
+      weight: string
       color: string
   NetworkData:
     type: object
diff --git a/schema/url/networks.raml b/schema/url/networks.raml
index 8fbe5752..96ade114 100644
--- a/schema/url/networks.raml
+++ b/schema/url/networks.raml
@@ -11,7 +11,7 @@ types:
     properties:
       source: NodeData
       target: NodeData
-      strokeWidth: string
+      weight: string
       color: string
   
   NetworkData:
diff --git a/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java b/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java
index f77316fd..a90d2908 100644
--- a/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java
+++ b/src/main/java/org/veupathdb/service/eda/ds/plugin/correlation/AbstractCorrelationBipartiteNetwork.java
@@ -95,7 +95,7 @@ protected void writeResults(OutputStream out, Map dataStrea
       LinkData link = new LinkDataImpl();
       link.setSource(sourceNode);
       link.setTarget(targetNode);
-      link.setStrokeWidth(String.valueOf(Math.abs(Float.parseFloat(correlationRow.getCorrelationCoef()))));
+      link.setWeight(String.valueOf(Math.abs(Float.parseFloat(correlationRow.getCorrelationCoef()))));
       // Link color is the sign of the correlation
       String color = Float.parseFloat(correlationRow.getCorrelationCoef()) < 0 ? "-1" : "1";
       link.setColor(color);