Field guide

Web service return

Web service return
Field Type Description
results Object The results set consist of a collection of geo and a collection of indicators.

Example

"results": {
	"geo": [],
	"indicators": []
}

geo

For the returned set of indicators, the geo object will contain the list of geographies that apply for that entire set. This will enable web developers to display only the geographies that make sense for the set of indicators in question.

geo
Field Type Description
geo_code Integer The integer representation of the geography used by the indicators system. Canada is represented by "0"; provincial geographies have a value between 1 and 13.

Example

"geo_code": "0",
label Object The English/French label for the geography.

Example

"label": {
	"en": "Canada",
	"fr": "Canada"}

themes_en/themes_fr

For the returned set of indicators, the themes_en/themes_fr objects will contain the list of themes that apply for that entire set.

themes_en/themes_fr
Field Type Description
theme_id Integer The integer representation of the theme used by the indicators system.

Example

"theme_id": "920",
label Object The label for the theme.

Example

"label": "Agriculture",

indicators

indicators
Field Type Description
registry_number Integer The unique ID of the release that contains the indicator. The registry_number and indicator_number form a unique and stable identifier for the indicator.

Example

"registry_number": "1234",
indicator_number Integer Part of the unique identifier of an indicator. This is used only for identification purposes, not ordering indicators within the same release.

Example

"indicator_number": "1",
geo_code Integer The geography for the indicator represented as an integer value. The geo object contains the English/French label for this geographic code.

Example

"geo_code": "0",
title Object The official English/French label for this indicator.

Example

"title": {
	"en": "Operating profits",
	"fr": "Bénéfices d'exploitation"
},
value Object The English/French formatted value for this indicator.

Note: The indicator value may be blank for certain indicators such as index data.

Example

"value": {
	"en": "$75.4 billion",
	"fr": "75,4 milliard de dollars"
},
refper Object The English/French reference period for this indicator value.

Example

"refper": {
	"en": "First quarter 2015",
	"fr": "Premier trimestre 2015"
},
daily_url Object The English/French URL of the release that contains the indicator.

Example

"daily_url": {
	"en": "/daily-quotidien/...-eng.htm",
	"fr": "/daily-quotidien/...-fra.htm"
},
daily_title Object The English/French title of the release that contains the indicator.

Example

"daily_title": {
	"en": "Quarterly financial statistics",
	"fr": "Statistiques financières trimestrielles"
},
source Integer When the value is derived from CANSIM data, the array number (returned as an integer value) will be stored here; depending on the presentation needs, the source may be displayed (if displayed, the web developer should also provide the hyperlink).

When the indicator value does not come from CANSIM, source will be set to zero.

Example

"source": "1870002",
themes String The set of theme IDs associated with the indicator. Each theme ID is delimited with the asterisk (*) symbol.

Example

"themes": "*3867**30000**30004*",
release_date Date The release date for this indicator in the format DD/MM/YY.

Example

"release_date": "04/12/2014",
growth_rate Growth rate Some indicators may also have a growth rate with their value (and certain indicators have only growth rates and no value).

Example

"growth_rate": {
	"growth": {
		"en": "-6.0%",
		"fr": "-6,0 %"
	},
	"arrow_direction": "2",
	"details": {
		"en": "(quarterly change)",
		"fr": "(variation trimestrielle)"
	}
}

When no growth rate is present, the field will be assigned "null" as shown below:

"growth_rate": null,

growth_rate

growth_rate
Field Type Description
growth Object Growth consist of an English/French formatted value. The growth rate may be expressed as a percent change, or percentage point change or a difference between two data points (hence, the growth rate might be expressed with a scalar factor and unit of measure).

Example

"growth": {
	"en": "-6.0%",
	"fr": "-6,0 %"
},
arrow_direction Object Indicates what type of arrow to use when displaying the growth rate:
  • 0: No arrow
  • 1: Up arrow
  • 2: Down arrow

Example

"arrow_direction": "2",
details Object The English/French periodicity for the growth rate.

Example

"details": {
	"en": "(quarterly change)",
	"fr": "(variation trimestrielle)"
},
Date modified: