KPI History and Prediction widget payload format

Payload format attributes must be set for the IBM® Business Monitor widgets for which you are creating addressable URLs.

Attributes for KPI History and Prediction widget

Dashboard space name	URL name	Description
kpis	p0	Models for which you want to retrieve the KPIs.
version	p1	Version of models for which you want to retrieve the KPIs.
granularity	p2	Granularity of the data displayed on the chart
timeZone	p3	Time zone
location	p4	Location of the KPI history data that is used for daylight saving time
timeRangeMethod	p5	Type of time-range method
repeatingBasis	p6	Basis type of repeating period
repeatingDuration	p7	Duration of repeating period
repeatingQuantity	p8	Quantity of repeating period
rollingDuration	p9	Duration of rolling period
rollingQuantity	p10	Quantity of rolling period
fixedStartDate	p11	Start date of the fixed period
fixedEndDate	p12	End date of the fixed period
predictionModelCheckbox	p13	Enable to show predictions based on the selected prediction model
predictionModelOption	p14	Show predictions based on the selected prediction model
predictionDefault	p15	Show prediction data on graph by default
showRanges	p16	Display KPI ranges
showTarget	p17	Display KPI target

Attribute details

Table 1. kpis (p0)
Row	Explanation
Required	Yes
Possible values	None
Attribute type	String
Format	`monitor_model_id`:`model_version`:`kpi_id`
Example	`"p0": "ClipsAndTacks:20070911120730:Ship_Count_KPI"`

Table 2. version (p1)
Row	Explanation
Required	No
Possible values	`0` (latest), `1` (all)
Attribute type	Integer
Example	`"p1": 0`

Table 3. granularity (p2)
Row	Explanation
Required	Yes
Possible values	`0` (yearly), `1` (quarterly), `2` (monthly), `3` (weekly), `4` (daily), `5` (hourly)
Attribute type	Integer
Example	`"p2": 3`

Table 4. timeZone (p3)
Row	Explanation
Required	No
Possible values	See time zone values listed in Table 6.
Attribute type	String
Example	`"p3": "Etc/GMT+8"`

Table 5. location (p4)
Row	Explanation
Required	No
Possible values	See location values listed in Table 6.
Attribute type	String
Example	`"p4": "US/Alaska"`

Table 6. Time zone information
Name	Possible time zone values	Location	Possible location values
GMT-12:00	`Etc/GMT+12`
GMT-11:00	`Etc/GMT+11`	Pacific/Midway	`"Pacific/Niue"`, `"Pacific/Pago_Pago"`, `"Pacific/Samoa"`
GMT-10:00	`Etc/GMT+10`	Pacific/Fakaofo	`"Pacific/Rarotonga"`, `"Pacific/Tahiti"`, `"US/Aleutian"`, `"US/Hawaii"`
GMT-09:30	`Pacific/Marquesas`	Pacific/Marquesas
GMT-09:00	`Etc/GMT+9`	Pacific/Gambier	`"US/Alaska"`
GMT-08:00	`Etc/GMT+8`	America/Los Angeles	`"America/Tijuana""America/Vancouver"`, `"Pacific/Pitcairn"`
GMT-07:00	`Etc/GMT+7`	America/Chihuahua	`"America/Dawson_Creek"`, `"America/Denver", "America/Edmonton"`, `"America/Hermosillo"`, `"America/Phoenix"`, `"Navajo"`
GMT-06:00	`Etc/GMT+6`	America/Belize	`"America/Chicago"`, `"America/Costa_Rica"`, `"America/El_Salvador"`, `"America/Guatemala"`, `"America/Managua"`, `"America/Mexico_City"`, `"America/Regina"`, `"America/Tegucigalpa"`, `"America/Winnipeg"`, `"Chile/EasterIsland"`, `"Pacific/Galapagos"`
GMT-05:00	`Etc/GMT+5`	America/Bogota	`"America/Cayman"`, `"America/Coral_Harbour"`, `"America/Grand_Turk"`, `"America/Guayaquil"`, `"America/Havana"`, `"America/Jamaica"`, `"America/Lima"`, `"America/Nassau"`, `"America/New_York"`, `"America/Panama"`, `"America/Port-au-Prince"`, `"America/Porto_Acre"`, `"America/Toronto"`
GMT-04:00	`Etc/GMT+4`	America/Anguilla	`"America/Antigua"`, `"America/Aruba"`, `"America/Asuncion"`, `"America/Barbados"`, `"America/Boa_Vista"`, `"America/Caracas"`, `"America/Cuiaba"`, `"America/Curacao"`, `"America/Dominica"`, `"America/Grenada"`, `"America/Guadeloupe"`, `"America/Guyana"`, `"America/Halifax"`, `"America/La_Paz"`, `"America/Martinique"`, `"America/Montserrat"`, `"America/Port_of_Spain"`, `"America/Porto_Velho"`, `"America/Puerto_Rico"`, `"America/Santiago"`, `"America/Santo_Domingo"`, `"America/St_Kitts"`, `"America/St_Lucia"`, `"America/St_Thomas"`, `"America/St_Vincent"`, `"America/Tortola"`, `"America/Virgin"`, `"Atlantic/Bermuda"`, `"Atlantic/Stanley"`
GMT-03:30	`CNT`	Canada/Newfoundland
GMT-03:00	`Etc/GMT+3`	America/Buenos_Aires	`"America/Cayenne"`, `"America/Fortaleza"`, `"America/Godthab"`, `"America/Miquelon"`, `"America/Montevideo"`, `"America/Paramaribo"`, `"America/Recife"`, `"America/Rosario"`, `"America/Sao_Paulo"`, `"Antarctica/Rothera"`
GMT-02:00	`Etc/GMT+2`	America/Noronha	`"Atlantic/South_Georgia"`
GMT-01:00	`Etc/GMT+1`	America/Scoresbysund	`"Atlantic/Azores"`, `"Atlantic/Cape_Verde"`
GMT	`Etc/GMT0`	Africa/Abidjan	`"Africa/Accra"`, `"Africa/Bamako"`, `"Africa/Banjul"`, `"Africa/Bissau"`, `"Africa/Casablanca"`, `"Africa/Conakry"`, `"Africa/Dakar"`, `"Africa/El_Aaiun"`, `"Africa/Freetown"`, "Africa/Lome", `"Africa/Monrovia"`, `"Africa/Nouakchott"`, `"Africa/Ouagadougou"`, `"Africa/Sao_Tome"`, `"Africa/Timbuktu"`, `"America/Danmarkshavn"`, `"Atlantic/Canary"`, `"Atlantic/Faeroe"`, `"Atlantic/Madeira"`, `"Atlantic/Reykjavik"`, `"Atlantic/St_Helena"`, `"Etc/Greenwich"`, `"Europe/Belfast"`, `"Europe/Dublin"`, `"Europe/Lisbon"`, `"Europe/London"`
GMT+01:00	`Etc/GMT-1`	Africa/Algiers	`"Africa/Bangui"`, `"Africa/Brazzaville"`, `"Africa/Ceuta"`, `"Africa/Douala"`, `"Africa/Kinshasa"`, `"Africa/Libreville"`, `"Africa/Luanda"`, `"Africa/Malabo"`, `"Africa/Ndjamena"`, `"Africa/Niamey"`, `"Africa/Porto-Novo"`, `"Africa/Tunis"`, `"Africa/Windhoek"`, `"Arctic/Longyearbyen"`, `"Atlantic/Jan_Mayen"`, `"Europe/Amsterdam"`, `"Europe/Andorra"`, `"Europe/Belgrade"`, `"Europe/Berlin"`, `"Europe/Bratislava"`, `"Europe/Brussels"`, `"Europe/Budapest"`, `"Europe/Copenhagen"`, `"Europe/Gibraltar"`, `"Europe/Ljubljana"`, `"Europe/Luxembourg"`, `"Europe/Madrid"`, `"Europe/Malta"`, `"Europe/Monaco"`, `"Europe/Oslo"`, `"Europe/Paris"`, `"Europe/Prague"`, `"Europe/Rome"`, `"Europe/San_Marino"`, `"Europe/Sarajevo"`, `"Europe/Skopje"`, `"Europe/Stockholm"`, `"Europe/Tirane"`, `"Europe/Vaduz"`, `"Europe/Vatican"`, `"Europe/Vienna"`, `"Europe/Warsaw"`, `"Europe/Zagreb"`, `"Europe/Zurich"`
GMT+02:00	`Etc/GMT-2`	Africa/Blantyre	`"Africa/Bujumbura"`, `"Africa/Cairo"`, `"Africa/Gaborone"`, `"Africa/Harare"`, `"Africa/Johannesburg"`, `"Africa/Kigali"`, `"Africa/Lubumbashi"`, `"Africa/Lusaka"`, `"Africa/Maputo"`, `"Africa/Maseru"`, `"Africa/Mbabane"`, `"Africa/Tripoli"`, `"Asia/Amman"`, `"Asia/Beirut"`, `"Asia/Damascus"`, `"Asia/Gaza"`, `"Asia/Nicosia"`, `"Asia/Tel_Aviv"`, `"Europe/Athens"`, `"Europe/Bucharest"`, `"Europe/Chisinau"`, `"Europe/Helsinki"`, `"Europe/Istanbul"`, `"Europe/Kaliningrad"`, `"Europe/Kiev"`, `"Europe/Mariehamn"`, `"Europe/Minsk"`, `"Europe/Nicosia"`, `"Europe/Riga"`, `"Europe/Simferopol"`, `"Europe/Sofia"`, `"Europe/Tallinn"`, `"Europe/Tiraspol"`, `"Europe/Uzhgorod"`, `"Europe/Vilnius"`, `"Europe/Zaporozhye"`
GMT+03:07	`Etc/GMT-3`	Africa/Addis_Ababa	`"Africa/Asmera"`, `"Africa/Dar_es_Salaam"`, `"Africa/Djibouti"`, `"Africa/Kampala"`, `"Africa/Khartoum"`, `"Africa/Mogadishu"`, `"Africa/Nairobi"`, `"Antarctica/Syowa"`, `"Asia/Aden"`, `"Asia/Baghdad"`, `"Asia/Bahrain"`, `"Asia/Kuwait"`, `"Asia/Qatar"`, `"Asia/Riyadh"`, `"Europe/Moscow"`, `"Indian/Antananarivo"`, `"Indian/Comoro"`, `"Indian/Mayotte"`
GMT+03:30	`Asia/Riyadh87`	Asia/Riyadh87
GMT+03:00	`Iran`	Asia/Tehran
GMT+04:00	`Etc/GMT-4`	Asia/Baku	`"Asia/Dubai"`, `"Asia/Muscat"`, `"Asia/Tbilisi"`, `"Asia/Yerevan"`, `"Europe/Samara"`, `"Indian/Mahe"`, `"Indian/Mauritius"`, `"Indian/Reunion"`
GMT+04:30	`Asia/Kabul`	Asia/Kabul
GMT+05:00	`Etc/GMT-5`	Asia/Aqtau	`"Asia/Aqtobe"`, `"Asia/Ashgabat"`, `"Asia/Dushanbe"`, `"Asia/Karachi"`, `"Asia/Oral"`, `"Asia/Tashkent"`, `"Asia/Yekaterinburg"`, `"Indian/Kerguelen"`, `"Indian/Maldives"`
GMT+05:30	`IST`	Asia/Calcutta	`"Asia/Colombo"`
GMT+05:45	`Asia/Katmandu`	Asia/Katmandu
GMT+06:00	`Etc/GMT-6`	Antarctica/Mawson	`"Antarctica/Vostok"`, `"Asia/Almaty"`, `"Asia/Bishkek"`, `"Asia/Dacca"`, `"Asia/Novosibirsk"`, `"Asia/Omsk"`, `"Asia/Qyzylorda"`, `"Asia/Thimbu"`, `"Indian/Chagos"`
GMT+06:30	`Asia/Rangoon`	Asia/Rangoon	`"Indian/Cocos"`
GMT+07:00	`Etc/GMT-7`	Antarctica/Davis	`"Asia/Bangkok"`, `"Asia/Hovd"`, `"Asia/Jakarta"`, `"Asia/Krasnoyarsk"`, `"Asia/Saigon"`, `"Indian/Christmas"`
GMT+08:00	`Etc/GMT-8`	Antarctica/Casey	`"Asia/Brunei"`, `"Asia/Hong_Kong"`, `"Asia/Irkutsk"`, `"Asia/Kuala_Lumpur"`, `"Asia/Makassar"`, `"Asia/Manila"`, `"Asia/Shanghai"`, `"Asia/Singapore"`, `"Asia/Taipei"`, `"Asia/Ulaanbaatar"`, `"Asia/Ulan_Bator"`, `"Asia/Urumqi"`, `"Australia/Perth"`
GMT+09:00	`Etc/GMT-9`	Asia/Choibalsan	`"Asia/Dili"`, `"Asia/Jayapura"`, `"Asia/Pyongyang"`, `"Asia/Seoul"`, `"Asia/Tokyo"`, `"Asia/Yakutsk"`, `"Pacific/Palau"`
GMT+09:30	`ACT`	Australia/Adelaide	`"Australia/Darwin"`
GMT+10:00	`Etc/GMT-10`	Antarctica/DumontDUrville	`"Asia/Sakhalin"`, `"Asia/Vladivostok"`, `"Australia/Brisbane"`, `"Australia/Sydney"`, `"Australia/Tasmania"`, `"Pacific/Guam"`, `"Pacific/Port_Moresby"`, `"Pacific/Saipan"`, `"Pacific/Truk"`, `"Pacific/Yap"`
GMT+10:30	`Australia/Lord_Howe`	Australia/Lord_Howe
GMT+11:00	`Etc/GMT-11`	Asia/Magadan	`"Pacific/Efate"`, `"Pacific/Guadalcanal"`, `"Pacific/Kosrae"`, `"Pacific/Noumea"`, `"Pacific/Ponape"`
GMT+11:30	`Pacific/Norfolk`	Pacific/Norfolk
GMT+12:00	`Etc/GMT-12`	Antarctica/McMurdo	`"Antarctica/South_Pole"`, `"Asia/Anadyr"`, `"Asia/Kamchatka"`, `"Kwajalein"`, `"Pacific/Auckland"`, `"Pacific/Fiji"`, `"Pacific/Funafuti"`, `"Pacific/Kwajalein"`, `"Pacific/Majuro"`, `"Pacific/Nauru"`, `"Pacific/Tarawa"`, `"Pacific/Wake"`, `"Pacific/Wallis"`
GMT+12:45	`Pacific/Chatham`	Pacific/Chatham
GMT+13:00	`Etc/GMT-13`	Pacific/Enderbury	`"Pacific/Tongatapu"`
GMT+14:00	`Etc/GMT-14`	Pacific/Kiritimati

Table 7. timeRangeMethod (p5)
Row	Explanation
Required	Yes
Possible values	`0` (repeatingPeriod), `1` (rollingPeriod), `2` (fixedPeriod)
Attribute type	Integer
Example	`"p5": 0`

If the method is "repeatingPeriod", "repeatingBasis" and "repeatingDuration" and "repeatingQuantity" are required.
If the method is "rollingPeriod", "rollingDuration" and "rollingQuantity" are required.
If the method is "fixedPeriod", "fixedStartDate" and "fixedEndDate" are required.

Table 8. repeatingBasis (p6)
Row	Explanation
Required	No
Possible values	`0` (previousPeriod), `1` (periodInProgress)
Attribute type	Integer
Example	`"p6": 1`

Table 9. repeatingDuration (p7)
Row	Explanation
Required	No
Possible values	`0` (yearly), `1` (quarterly), `2` (monthly), `3` (daily)
Attribute type	Integer
Example	`"p7": 1`

Table 10. repeatingQuantity (p8)
Row	Explanation
Required	No
Possible values	None
Attribute type	Integer
Example	`"p8": 3`

Table 11. rollingDuration (p9)
Row	Explanation
Required	No
Possible values	`0` (yearly), `1` (quarterly), `2` (monthly), `3` (daily)
Attribute type	Integer
Example	`"p9": 3`

Table 12. rollingQuantity (p10)
Row	Explanation
Required	No
Possible values	None
Attribute type	Integer
Example	`"p10": 5`

Table 13. fixedStartDate (p11)
Row	Explanation
Required	No
Possible values	None
Attribute type	String
Format	`yyyy`-`mm`-`ddThh`:`mm`:`ss`
Example	`"p11": "2010-06-30T15:07:00"`

Table 14. fixedEndDate (p12)
Row	Explanation
Required	No
Possible values	None
Attribute type	String
Format	`yyyy`-`mm`-`ddThh`:`mm`:`ss`
Example	`"p12": "2010-06-30T15:07:18"`

Table 15. predictionModelCheckbox (p13)
Row	Explanation
Required	No
Possible values	`0` (false), `1` (true)
Attribute type	Integer
Example	`"p13": 1`

Table 16. predictionModelOption (p14)
Row	Explanation
Required	No
Possible values	None
Attribute type	String
Example	`"p14": "abc"`

Table 17. predictionDefault (p15)
Row	Explanation
Required	No
Possible values	`0` (false), `1` (true)
Attribute type	Integer
Example	`"p15": 0`

Table 18. showRanges (p16)
Row	Explanation
Required	No
Possible values	`0` (false), `1` (true)
Attribute type	Integer
Example	`"p16": 1`

Table 19. showTarget (p17)
Row	Explanation
Required	No
Possible values	`0` (false), `1` (true)
Attribute type	Integer
Example	`"p17": 1`

Example

{"p0": "ClipsAndTacks:20070911120730:Ship_Count_KPI", "p2": 3, "p3": "Etc/GMT+8", "p4": "America/Los_Angeles", "p5": 0 , "p6": 1, "p7": 2, "p8": 3}