Build your own tabulate query
There are many options for customizing your tabulation. Use the parameters below to subset, compute, order, filter and format the results and return aggregate level data.
If you're having trouble getting started, try building your query first in Tabulation Engine. It can then generate the API query you need, and you can fine-tune it from there.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
count | string | Flag specifying whether the total row count should be returned alongside the data. true or false | |
dims | string | Columns to use as dimensions. |
Examples: V[0-9]+,V1a,$keyword, V1, $keyword, V[0-9]+ |
| format | string | | RDS can return a variety of JSON objects to plug into various JavaScript charting libraries. Default value is mtna_simple
Available values : mtna mtna_simple amcharts gcharts plotly_bar plotly_boxplot plotly_bubble plotly_hist plotly_pie plotly_scatter |
| groupby | string | | When computing a new variable using a function that depends on aggregation the group by parameter can specify which columns to group by.
Examples: V1 or V1,V2 |
| inject | string | | Flag specifying if we want the values injected into the returned records. true or false |
| limit | string | | The limit of records to return. e.g. 100 |
| measure | string | | The value being measured. This can be the count of responses, the percentage of response, or another function. The syntax is <computed_variable_name>:<function>. Examples: count:Count(*), percent:PCT(*), count:Sum(cnt_confirmed) |
| metadata | string | | Flag specifying whether metadata should be returned along side the data.
true or false |
| offset | string | | The record to start at. e.g. 10 |
| orderby | string | | Allows the data to be reordered in ascending or descending order by column
Examples: V1 DESC, V1 DESC,V2 ASC. |
| totals | string | | Flag specifying whether subtotals should be returned along side the data.
true or false |
| weights | string | | The IDs of variables to use as weights in the resulting data.
Examples: V1, V1,V2,V3 |
| where | string | | The where parameter allows filters to be applied to the data that will be returned. This follows a syntax similar to a SQL where clause.
Examples: V1=1 AND V2=2, V1!=1 or V1!=NULL, V1 matches [0-9]+, V1=1 or V1=Bob, (V1=1 AND V2=2) OR V3=3, V1>=1 or V1<1, V1 like a% |
RESPONSES
status: OK
{"info":{"cached":false,"columnCount":1,"columnOffset":0,"end":"2020-02-25T15:36:29.230Z","includeMetadata":true,"moreColumns":false,"moreRows":false,"notes":[],"postQueryTime":0,"preQueryTime":219,"queryTime":48,"rowCount":1,"rowLimit":5,"rowOffset":2,"start":"2020-02-25T15:36:28.963Z","tableCellCount":1,"totalProcessingTime":267},"records":[[126]],"totals":[],"variables":[{"fixedStorageWidth":21,"id":"count","isPrivate":false,"name":"count","reference":false,"revisionNumber":0,"storageType":"NUMERIC","uri":"computation.variable.count"}]}