Build your own select query
GET http://host/api/query/{catalog}/{dataProductId}/select?collimit=<integer>&coloffset=<integer>&cols=<string>&count=<boolean>&format=<format enum>&groupby=<string array>&inject=<boolean>&limit=<number>&lock=<string>&metadata=<boolean>&offset=<number>&orderby=<string>&weights=<string array>&where=<string>
All of the available parameters are listed below. Combine them as you wish to compute, order, filter, and format the data to fit your needs.
Having trouble figuring out where to begin? Browse data products and play around with subgroups in the RDS Explorer, and generate your API query from the UI, using the < > icon at the top right.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
collimit | string | Optional - Limits the number of columns returned. | |
coloffset | string | Optional - Determines which column to start at. | |
cols | string | Optional - Column names, regular expressions, key words, variable groups, or concepts to select. Any of these can be excluded as well by prepending '~' to these syntaxes. | |
count | string | Required - Flag specifying whether the total row count should be returned along side | |
| the data. | |||
format | string | Optional - RDS can return a variety of JSON objects to plug into various java script | |
charting libraries. Possible Values: mtna, mtna_simple, amcharts,gcharts, plotly_bar, plotly_boxplot, plotly_bubble, plotly_hist, plotly_pie, plotly_scatter | |||
groupby | string | Optional - When computing a new variable using a function that depends onaggregation the group by parameter can specify which columns to group by. | |
inject | string | Required - Flag specifying to inject codes into the returned records. | |
limit | string | Optional - The limit of records to return. | |
lock | string | Optional - Column names, regular expressions, key words, variable groups, or | |
| concepts to lock. These will be returned first and listed out in | |||
| DataSetInformation that is returned on the DataSet. | |||
metadata | string | Required - Flag specifying if metadata should be returned along side the data. | |
offset | string | Optional - The record to start at. | |
orderby | string | Optional - Allows the data to be reordered in ascending or descending order by column | |
weights | string | Optional - The IDs of variables to use as weights in the resulting data. | |
where | string | Optional - 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 |