Get Summarizations Service
URL http://baoapi.esri.com/rest/report/GetSummarizations

Get a list of summarization variables and their metadata which are accessible with the API subscriber account.

Output

The Get Summarizations utility service returns a list of available summarization variables and some associated metadata based on the specific API account type used to access the service. The result of this service is an ArrayOfSummarizationInfo. This can be used in subsequent analysis in the Summarizations parameter in Benchmark Report.

Description

The Get Summarizations service returns a list of available summarization variables based on the specific subscription level including their name, alias, the variable group category names they belong to, the number of decimal spaces the values for these variables use and for some fields, the recommended percentage field to use for any analysis is also returned. These variables include business, demographic and Census data and projections for 1990, 2000, 2009 and 2014 that is aggregated to the U.S. Census block group level.

Some applications of Get Summarizations include the following:

Usage Tips

You can provide arguments to the Get Summarizations utility service as defined in the parameters table below.

Parameters

Parameter Details
Token (Required) Description: A valid API token string.

Syntax: Token=<string>

Example: Token=ABC123...

Notes: The value associated with the Token parameter is for example purposes only. See Get Token for more information on obtaining a token.

ActiveDatasetID Description: Specify a dataset to perform Online API tasks or operations.

Default: USA

Syntax: ActiveDatasetID=<string>

Example: ActiveDatasetID=Canada

Notes: See the Get Datasets task to dynamically query the available dataset IDs.

Access to additional datasets is subject to the type, terms and restrictions associated with your Online API subscription.

Callback Description: Wrap the JSON or PJSON response in a named function that can be executed by client-side JavaScript upon receipt.

Default: null

Syntax: Callback=<string>

Example: Callback=MyCallbackFunction

Notes:
The response will be wrapped in a callback function only if a non-null Callback parameter value is specified and if the response format (the f parameter) is set to JSON or PJSON
.

Callback functions are useful for consuming the service in JavaScript-based client applications as shown in this basic example.

f Description: The response format.

Default: HTML

Syntax: f=<HTML | JSON | PJSON>

Example: f=JSON

Length Description: The number of analysis/summarization variable records returned beginning at the StartIndex parameter value

Default: (all records)

Syntax: Length=<int>

Example: Length=100

Visibility Description: A keyword representing the set of fields/properties which are included in each analysis/summarization variable record included in the output

Default: $default

Syntax: Visibility=<$all | $default | $id | $min>

Example: Visibility=$all

Notes:
$all - Returns all available fields/properties (name, alias, category, longdescription, keywords, units, and mappable).
$default - Returns the name, alias, category, longdescription fields/properties only.
$id - Returns the name field/property only.
$min - Returns the name and alias fields/properties only.

Query Description: Field/property name followed by a string query on that field/property.

Default: null

Syntax: Query=<name | alias | category | longdescription | keywords | units | mappable> : <string>

Example: Query=name:population

Notes:
A query with no results will return an error message.

Any of the seven fields/properties can be queried regardless of the visibility of the field

The (case-sensitive) fields/properties which can be queried include name, alias, category, longdescription, keywords, units, or mappable.

When including multiple strings in the query parameter value, the service will match analysis/summarization variable records if one or more of the string values are contained in the associated field/property.

 

Start Description: Zero-based index specifying the starting analysis/summarization variable record when one or more records are returned.

Default: 0

Syntax: Start=<int>

Example: Start=100

Notes:
An out-of-range StartIndex value will result in an error message.

Example Usage


Example 1:Get a list of summarization variables accessible from a given API subscription account.

Request Example (1)

http://baoapi.esri.com/rest/report/GetSummarizations?
f=PJSON&
Token=ABC123
(Example uses limited demo account)

Notes: See Get Token for more information on obtaining a token.

Variable availability is API account dependent.

Example Response

JSON Response Syntax

{
  "result": <ArrayOfSummarizationInfo>
}

JSON Response Example

{
  "result": [
	  {
		"Name": "TOTPOP_CY",
		"Alias": "2010 Total Population",
		"Category": "2010 Key Demographic Indicators (Esri)",
		"LongDescription": "2010 Total Population (Esri)",
		"Keywords": "2010\/2015 Demographics (Esri Data)",
		"Units": "count",
		"Mappable": true
	  },
	  {
		"Name": "HHPOP_CY",
		"Alias": "2010 Household Population",
		"Category": "2010 Key Demographic Indicators (Esri)",
		"LongDescription": "2010 Household Population (Esri)",
		"Keywords": "2010\/2015 Demographics (Esri Data)",
		"Percentage": "TOTPOP_CY",
		"Units": "count",
		"Mappable": true
	  },
	  {
		"Name": "FAMPOP_CY",
		"Alias": "2010 Family Population",
		"Category": "2010 Key Demographic Indicators (Esri)",
		"LongDescription": "2010 Family Population (Esri)",
		"Keywords": "2010\/2015 Demographics (Esri Data)",
		"Percentage": "TOTPOP_CY",
		"Units": "count",
		"Mappable": true
	  },
	  {
		"Name": "GQPOP_CY",
		"Alias": "2010 Group Quarters Population",
		"Category": "2010 Key Demographic Indicators (Esri)",
		"LongDescription": "2010 Group Quarters Population (Esri)",
		"Keywords": "2010\/2015 Demographics (Esri Data)",
		"Percentage": "TOTPOP_CY",
		"Units": "count",
		"Mappable": true
	  },

  
    ...
    
	  {
		"Name": "MOEMEDYBLT",
		"Alias": "MOE Median Yr Struct Blt: HUs",
		"Category": "2005-2009 ACS Housing Units by Year Structure Built",
		"LongDescription": "2005-2009 MOE Median Year Structure Built (Total Housing Units)",
		"Keywords": "ACS (2005-2009);Housing",
		"Units": "count",
		"Mappable": true
      }
  ]
}


See Also

Get Token

Benchmark Report