Website usage tips

URL Params for each tool

Each of the tools on our website have a host of URL params that can be used. Here are the available URL params for each tool.

Visualizations (new version of map, scatter, and timeline)

Param key	Param description	Param values	Example	Applicable Visualization types
visType	The visualization type	one of map, scatter, or timeline	&visType=map	all
place	The place to show data for	place dcid	&place=country/USA	all
placeType	The type of place to show data for	place type	&placeType=State	scatter, map
sv	information about the statistical variables to show data for	A list of json objects separated by "___". Map can take 1 variable, scatter can take 2, and timeline can take any number. Each json object is the information for one variable and has the following fields: dcid: the dcid of the variable. pc: whether or not to show the per capita for this variable. Defaults to false if not set. log: whether or not to show this information on a log scale. Only available for scatter. Defaults to false if not set. date: the date to get the data for. Only available for map and scatter. Defaults to using latest available date if not set denom: the denominator to use for per capita calculations. Only available for map and scatter. Defaults to Count_Person if not set.	&sv={"dcid":{"dcid":"Count_Person_Male_AsianAlone","pc":"1","date":"2019","denom":"Count_Person_Male"}___ "Count_Person_Female_AsianAlone","pc":"1","date":"2019","denom":"Count_Person_Female"}	all
display	Display options	a json object with the following fields: q: show quadrants on scatter tool l: show place labels on scatter tool	&display={"q":"1","l":"1"}	scatter

Map

Param key	Param description	Param values	Example
pd	The selected place (ie. The place to show a map of)	place dcid	&pd=country/USA
ept	Type of place to show the map broken down into	place type	&ept=State
sv	The statistical variable to show the data for on the map	dcid of the statistical variable	&sv=Count_Person_Female
pc	Whether or not to show the data as a calculation of per capita	1 for true	&pc=1
ppt	type of place to show as points on the map	place type	&ppt=EpaReportingFacility
mapsv	the statistical variable to show the data for for the points on the map	dcid of the statistical variable	&mapsv=Annual_Emissions_CarbonDioxide_NonBiogenic
mp	Whether or not to show points on the map	1 for true	&mp=1
dt	Date to show data for	Date of the format YYYY or YYYY-MM or YYYY-MM-DD	&dt=2019
color	The color to use as the max color for the scale	color	&color=blue
domain	The values of the scale	3 numbers joined by ":"	&domain=0:5:10
denom	The statistical variable to use as the denominator when calculating per capita	dcid of the statistical variable	&denom=Count_Person

Scatter

Param key	Param description	Param values	Example
epd	The enclosing place (ie. the place to show broken down data for)	place dcid	&epd=country/USA
ept	Type of place to show the data for	place type	&ept=State
lb	Minimum population of places to show on the chart	number	&lb=100000
ub	Maximum population of places to show on the chart	number	&ub=10000000
svx	The statistical variable to use for the x-axis	dcid of the statistical variable	&svx=Count_Person_Female
svy	The statistical variable to use for the y-axis	dcid of the statistical variable	&svy=Count_Person_Male
pcx	Whether or not to show the x-axis as a calculation of per capita	1 for true	&pcx=1
pcy	Whether or not to show the y-axis as a calculation of per capita	1 for true	&pcy=1
logx	Whether or not to show the x-axis as a log scale	1 for true	&logx=1
logy	Whether or not to show the y-axis as a log scale	1 for true	&logy=1
datex	The date to show x-axis data for	Date of the format YYYY or YYYY-MM or YYYY-MM-DD	&datex=2019
datey	The date to show y-axis data for	Date of the format YYYY or YYYY-MM or YYYY-MM-DD	&datey=2019
dx	The statistical variable to use as the denominator when calculating per capita for the x-axis data	dcid of the statistical variable	&dx=Count_Person
dy	The statistical variable to use as the denominator when calculating per capita for the y-axis data	dcid of the statistical variable	&dy=Count_Person
qd	Whether or not to show quadrants on the chart	1 for true, otherwise false	&qd=1
ld	Whether or not to show labels with the place name on the chart	1 for true	&ld=1
ct	The chart type to show	1 for bivariate map, otherwise show scatter plot	&ct=1
dd	Whether or not to show density distribution on the chart	1 for true	&dd=1
rg	Whether or not to show regression line on the chart	1 for true	&rg=1

Timeline

Param key	Param description	Param values	Example
statsVar	The statistical variables to show charts for	statistical variable dcids separated by "__"	&statsVar=Count_Person_Female__Count_Person_Male
place	The places to show charts about	place dcids separated by ","	&place=geoId/06,country/USA
chart	Options selected for each chart: delta (whether or not to show delta), pc (whether or not to show per capita), denom (dcid of statistical variable used to calculate per capita)	map of chart mprop to options object	&chart={"withdrawalRate":{"delta":true,"pc":true}}

Browser

Param key	Param description	Param values	Example
openSv	Opens the stat var hierarchy to the specified sv's	statistical variable dcids separated by "__"	&openSv=Count_Person_Female__Count_Person_Male
statVar	The statVar to show charts for	stat var dcid	&statVar=Count_Person
all	If set, all properties will be shown (including geoJsonCoordinates, etc)	1	&all=1