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.

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 type (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
denomx	The statistical variable to use as the denominator when calculating per capita for the x-axis data	dcid of the statistical variable	&denomx=Count_Person
denomy	The statistical variable to use as the denominator when calculating per capita for the y-axis data	dcid of the statistical variable	&denomy=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}}