UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 45 kB
{"openapi":"3.0.0","info":{"description":"This API will provide monthly data which includes metrics such as sales volume and growth rate.","title":"Spending Pulse","version":"1.0","x-artifactId":"spending-pulse","x-origin":[{"format":"swagger","url":"https://developer.mastercard.com/devzone/api/portal/swagger/spendingpulse","version":"2.0"}],"x-providerName":"mastercard.com","x-serviceName":"SpendingPulse"},"paths":{"/gasweekly":{"get":{"description":"Returns the weekly gasoline report. This resource pulls back the report with ProductLine = \"US Weekly Gasoline Demand Report\". Keep in mind that you must be subscribed to the gasoline weekly report to be able to receive data back from this resource.\n","parameters":[{"description":"Starting record number to return.","in":"query","name":"CurrentRow","required":false,"example":"1","schema":{"type":"string"}},{"description":"Used to restrict the number of records returned if needed to be less than max.","in":"query","name":"Offset","required":false,"example":"25","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of subscriptions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GasWeeklyListResponse"}}}},"default":{"description":"Unexpected errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSchema"}}}}},"summary":"Returns the weekly gasoline report. This resource pulls back the report with ProductLine = \"US Weekly Gasoline Demand Report\". Keep in mind that you must be subscribed to the gasoline weekly report to be able to receive data back from this resource.","tags":["Gas Weekly"],"x-samples":[{"name":"example_gasweekly","request":{"application/json":"{\n \"CurrentRow\": \"1\",\n \"Offset\" : \"25\"\n}"},"response":{"application/json":"{\n \"GasWeeklyList\": {\n \"Count\": \"4\",\n \"GasWeeklyArray\": {\n \"GasWeeklyRecord\": [\n {\n \"Country\": \"US\",\n \"PADDCode\": \"NE\",\n \"PADDMillionsofBarrelsSold\": \"5\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.001\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.002\",\n \"Period\": \"Week\",\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"TotalBarrelsChangeFromPriorWeek\": \"5\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"40\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"15\",\n \"TotalMillionsOfBarrelsSold\": \"40\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.005\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.004\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.006\",\n \"WeekEndDate\": \"6/12/2015\"\n },\n {\n \"Country\": \"US\",\n \"PADDCode\": \"CA\",\n \"PADDMillionsofBarrelsSold\": \"5\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.015\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.025\",\n \"Period\": \"Week\",\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"TotalBarrelsChangeFromPriorWeek\": \"5\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"40\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"15\",\n \"TotalMillionsOfBarrelsSold\": \"40\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.005\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.004\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.006\",\n \"WeekEndDate\": \"6/12/2015\"\n },\n {\n \"Country\": \"US\",\n \"PADDCode\": \"NE\",\n \"PADDMillionsofBarrelsSold\": \"6\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.002\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.003\",\n \"Period\": \"Week\",\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"TotalBarrelsChangeFromPriorWeek\": \"6\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"50\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"16\",\n \"TotalMillionsOfBarrelsSold\": \"50\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.006\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.005\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.007\",\n \"WeekEndDate\": \"6/5/2015\"\n }\n ]\n },\n \"Message\": \"Success\"\n }\n}"}},{"name":"example_gasweekly_for_explorer","populateDefaults":{"application/json":"{\n \"CurrentRow\" : true,\n \"Offset\" : true\n}"},"request":{"application/json":"{\n \"CurrentRow\" : \"0\",\n \"Offset\" : \"2\"\n}"},"response":{"application/json":"{\n \"GasWeeklyList\": {\n \"Count\": \"4\",\n \"Message\": \"Success\",\n \"GasWeeklyArray\": {\n \"GasWeeklyRecord\": [\n {\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Week\",\n \"Sector\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"WeekEndDate\": \"6/12/2015\",\n \"TotalMillionsOfBarrelsSold\": \"40\",\n \"TotalBarrelsChangeFromPriorWeek\": \"5\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.004\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.005\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"40\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.006\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"15\",\n \"AveragePricePerGalRegularGasoline\": \"\",\n \"PADDCode\": \"NE\",\n \"PADDMillionsofBarrelsSold\": \"5\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.001\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.002\"\n },\n {\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Week\",\n \"Sector\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"WeekEndDate\": \"6/12/2015\",\n \"TotalMillionsOfBarrelsSold\": \"40\",\n \"TotalBarrelsChangeFromPriorWeek\": \"5\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.004\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.005\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"40\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.006\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"15\",\n \"AveragePricePerGalRegularGasoline\": \"\",\n \"PADDCode\": \"CA\",\n \"PADDMillionsofBarrelsSold\": \"5\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.015\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.025\"\n },\n {\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Week\",\n \"Sector\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"WeekEndDate\": \"6/5/2015\",\n \"TotalMillionsOfBarrelsSold\": \"50\",\n \"TotalBarrelsChangeFromPriorWeek\": \"6\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.005\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.006\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"50\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.007\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"16\",\n \"AveragePricePerGalRegularGasoline\": \"\",\n \"PADDCode\": \"NE\",\n \"PADDMillionsofBarrelsSold\": \"6\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.002\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.003\"\n },\n {\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Week\",\n \"Sector\": \"Gas\",\n \"SubSector\": \"Gas\",\n \"Segment\": \"Gas\",\n \"WeekEndDate\": \"6/5/2015\",\n \"TotalMillionsOfBarrelsSold\": \"50\",\n \"TotalBarrelsChangeFromPriorWeek\": \"6\",\n \"TotalPercentChangeInBarrelsFromPriorWeek\": \"0.005\",\n \"TotalPercentChangeInBarrelsFrom52WeeksAgo\": \"0.006\",\n \"TotalMillionsOfBarrels4WeekAverage\": \"50\",\n \"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo\": \"0.007\",\n \"TotalMillionsOfBarrelsDailyAverage\": \"16\",\n \"AveragePricePerGalRegularGasoline\": \"\",\n \"PADDCode\": \"CA\",\n \"PADDMillionsofBarrelsSold\": \"6\",\n \"PADDPercentChangeInBarrelsFromPriorWeek\": \"0.016\",\n \"PADDPercentChangeinBarrelsfrom52WeeksAgo\": \"0.026\"\n }\n ]\n }\n }\n}"},"type":"documentation"}]}},"/parameters":{"get":{"description":"Returns a distinct list of all reports are available and that one is subscribed to.\n","parameters":[{"description":"Starting record number to return.","in":"query","name":"CurrentRow","required":false,"example":"1","schema":{"type":"string"}},{"description":"Used to restrict the number of records returned if needed to be less than max.","in":"query","name":"Offset","required":false,"example":"25","schema":{"type":"string"}}],"responses":{"200":{"description":"A List of Parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParameterListResponse"}}}},"default":{"description":"Unexpected errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSchema"}}}}},"summary":"Returns a distinct list of all reports are available and that one is subscribed to.","tags":["Parameters"],"x-samples":[{"name":"example_parameters","request":{"application/json":"{\n \"CurrentRow\": \"1\",\n \"Offset\" : \"25\"\n}"},"response":{"application/json":"{\n \"ParameterList\": {\n \"Count\": \"4\",\n \"Message\": \"Success\",\n \"ParameterArray\": {\n \"Parameter\": [\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Weekly\",\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"March 2015\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\"\n },\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Monthly\",\n \"ProductLine\": \"US Gasoline Monthly\",\n \"PublicationCoveragePeriod\": \"March 2015\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\"\n },\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Weekly\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"March 2015\",\n \"ReportType\": \"reportA\",\n \"Sector\": \"sectorA\"\n },\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Weekly\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"March 2015\",\n \"ReportType\": \"reportB\",\n \"Sector\": \"sectorB\"\n }\n ]\n }\n }\n}"}},{"name":"example_parameters_for explorer","populateDefaults":{"application/json":"{\n \"CurrentRow\": true,\n \"Offset\" : true\n}"},"request":{"application/json":"{\n \"CurrentRow\": \"1\",\n \"Offset\" : \"25\"\n}"},"response":{"application/json":"{\n \"ParameterList\": {\n \"Count\": \"4\",\n \"Message\": \"Success\",\n \"ParameterArray\": {\n \"Parameter\": [\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Weekly\",\n \"ProductLine\": \"US Gasoline Weekly\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\"\n },\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Monthly\",\n \"ProductLine\": \"US Gasoline Monthly\",\n \"PublicationCoveragePeriod\": \"Month\",\n \"ReportType\": \"Gas\",\n \"Sector\": \"Gas\"\n },\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Weekly\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"reportA\",\n \"Sector\": \"sectorA\"\n },\n {\n \"Country\": \"US\",\n \"Ecomm\": \"Y\",\n \"Period\": \"Weekly\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"reportB\",\n \"Sector\": \"sectorB\"\n }\n ]\n }\n }\n}"},"type":"documentation"}]}},"/spendingpulse":{"get":{"description":"Returns all Spending Pulse reports (with the exception of the gasoline weekly report, which has its own resource), that one is subscribed to.\n","parameters":[{"description":"Starting record number to return.","in":"query","name":"CurrentRow","required":false,"example":"1","schema":{"type":"string"}},{"description":"Used to restrict the number of records returned if needed to be less than max.","in":"query","name":"Offset","required":false,"example":"25","schema":{"type":"string"}},{"description":"Product Line. Either ?US Executive Report? or ?Weekly Sales?","in":"query","name":"ProductLine","required":false,"example":"Weekly Sales","schema":{"type":"string"}},{"description":"Publication Coverage Period indicates what period is to be covered, often the current report will include the month prior.","in":"query","name":"PublicationCoveragePeriod","required":false,"example":"March 2015","schema":{"type":"string"}},{"description":"Country code.","in":"query","name":"Country","required":false,"example":"US","schema":{"type":"string"}},{"description":"Report type name, today the only report supported is \"monitor\".","in":"query","name":"ReportType","required":false,"example":"reportA","schema":{"type":"string"}},{"description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual","in":"query","name":"Period","required":false,"example":"Weekly","schema":{"type":"string"}},{"description":"Sector name.","in":"query","name":"Sector","required":false,"example":"sectorA","schema":{"type":"string"}},{"description":"Ecommerce indicator.","in":"query","name":"Ecomm","required":false,"example":"Y","schema":{"type":"string"}}],"responses":{"200":{"description":"A List of Spending Pulse Reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpendingPulseListResponse"}}}},"default":{"description":"Unexpected errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSchema"}}}}},"summary":"Returns all Spending Pulse reports (with the exception of the gasoline weekly report, which has its own resource), that one is subscribed to.","tags":["SpendingPulse Report"],"x-samples":[{"name":"example_spendingpulse","request":{"application/json":"{\n \"CurrentRow\": \"1\",\n \"Offset\" : \"25\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"March 2015\",\n \"Country\": \"US\",\n \"ReportType\": \"reportA\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorA\",\n \"Ecomm\": \"Y\"\n}"},"response":{"application/json":"{\n \"SpendingPulseList\": {\n \"Count\": \"2\",\n \"Message\": \"Success\",\n \"SpendingPulseArray\": {\n \"SpendingPulseRecord\": [\n {\n \"Country\": \"US\",\n \"CurrencyOfForSalesValue\": \"US Dollars\",\n \"Ecomm\": \"Y\",\n \"ImpliedDeflatorMonthOverMonthChange\": \"0.0012\",\n \"ImpliedDeflatorYearOverYearChange\": \"0.0011\",\n \"NonGregorianReportingPeriod\": \"2015-05\",\n \"Period\": \"Weekly\",\n \"PeriodEndDate\": \"5/14/2015\",\n \"PeriodStartDate\": \"5/8/2015\",\n \"PriceAdjustmentFlag\": \"Y\",\n \"PriceIndex3MonthMovingAverageChange\": \"0.012\",\n \"PriceIndexMonthOverMonthChange\": \"0.005\",\n \"PriceIndexValue\": \"0.00115\",\n \"PriceIndexYearOverYearChange\": \"0.00115\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"reportA\",\n \"ReportingCalender\": \"G\",\n \"Sales3MonthMovingAverageChange\": \"150\",\n \"SalesMonthOverMonthChange\": \"50\",\n \"SalesValueIndex\": \"5\",\n \"SalesYearOverYearChange\": \"500\",\n \"SalesYearToDateChange\": \"20\",\n \"SameStoreSalesIndex3MonthMovingAverageChange\": \"0.68\",\n \"SameStoreSalesIndexYearOverYearChange\": \"0.6\",\n \"SeasonalAdjustmentFlag\": \"Y\",\n \"Sector\": \"sectorA\",\n \"Segment\": \"seg1\",\n \"SubGeographyValue\": \"region\",\n \"SubSector\": \"subA\",\n \"TransactionIndex3MonthMovingAverageChange\": \"0.58\",\n \"TransactionIndexMonthOverMonthChange\": \"0.57\",\n \"TransactionIndexValue\": \"0.5\",\n \"TransactionIndexYearOverYearChange\": \"0.56\"\n },\n {\n \"Country\": \"US\",\n \"CurrencyOfForSalesValue\": \"US Dollars\",\n \"Ecomm\": \"Y\",\n \"ImpliedDeflatorMonthOverMonthChange\": \"0.0012\",\n \"ImpliedDeflatorYearOverYearChange\": \"0.0011\",\n \"NonGregorianReportingPeriod\": \"2015-05\",\n \"Period\": \"Weekly\",\n \"PeriodEndDate\": \"5/7/2015\",\n \"PeriodStartDate\": \"5/1/2015\",\n \"PriceAdjustmentFlag\": \"Y\",\n \"PriceIndex3MonthMovingAverageChange\": \"0.013\",\n \"PriceIndexMonthOverMonthChange\": \"0.006\",\n \"PriceIndexValue\": \"0.000116\",\n \"PriceIndexYearOverYearChange\": \"0.00116\",\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"ReportType\": \"reportA\",\n \"ReportingCalender\": \"G\",\n \"Sales3MonthMovingAverageChange\": \"160\",\n \"SalesMonthOverMonthChange\": \"60\",\n \"SalesValueIndex\": \"6\",\n \"SalesYearOverYearChange\": \"600\",\n \"SalesYearToDateChange\": \"30\",\n \"SameStoreSalesIndex3MonthMovingAverageChange\": \"0.88\",\n \"SameStoreSalesIndexYearOverYearChange\": \"0.8\",\n \"SeasonalAdjustmentFlag\": \"Y\",\n \"Sector\": \"sectorA\",\n \"Segment\": \"seg1\",\n \"SubGeographyValue\": \"region\",\n \"SubSector\": \"subA\",\n \"TransactionIndex3MonthMovingAverageChange\": \"0.48\",\n \"TransactionIndexMonthOverMonthChange\": \"0.47\",\n \"TransactionIndexValue\": \"0.4\",\n \"TransactionIndexYearOverYearChange\": \"0.46\"\n }\n ]\n }\n }\n}"}},{"name":"example_spendingpulse_for_explorer","populateDefaults":{"application/json":"{\n \"CurrentRow\" : true,\n \"Offset\" : true,\n \"Country\" : true,\n \"Sector\" : true,\n \"ProductLine\" : true,\n \"PublicationCoveragePeriod\" : true,\n \"ReportType\" : true,\n \"Ecomm\" : true,\n \"Period\" : true\n}"},"request":{"application/json":"{\n \"CurrentRow\" : \"1\",\n \"Offset\" : \"2\",\n \"Country\" : \"US\",\n \"Sector\" : \"sectorA\",\n \"ProductLine\" : \"Weekly+Sales\",\n \"PublicationCoveragePeriod\" : \"Week\",\n \"ReportType\" : \"reportA\",\n \"Ecomm\" : \"Y\",\n \"Period\" : \"Weekly\"\n}"},"response":{"application/json":"{\n \"SpendingPulseList\": {\n \"Count\": \"4\",\n \"Message\": \"Success\",\n \"SpendingPulseArray\": {\n \"SpendingPulseRecord\": [\n {\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"reportA\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorA\",\n \"SubSector\": \"subA\",\n \"Segment\": \"seg1\",\n \"Ecomm\": \"Y\",\n \"SeasonalAdjustmentFlag\": \"Y\",\n \"PriceAdjustmentFlag\": \"Y\",\n \"ImpliedDeflatorYearOverYearChange\": \"0.0011\",\n \"ImpliedDeflatorMonthOverMonthChange\": \"0.0012\",\n \"PeriodStartDate\": \"5/8/2015\",\n \"PeriodEndDate\": \"5/14/2015\",\n \"ReportingCalender\": \"G\",\n \"NonGregorianReportingPeriod\": \"2015-05\",\n \"SubGeographyValue\": \"region\",\n \"SalesValueIndex\": \"5\",\n \"CurrencyOfForSalesValue\": \"US Dollars\",\n \"SalesYearOverYearChange\": \"500\",\n \"SalesMonthOverMonthChange\": \"50\",\n \"Sales3MonthMovingAverageChange\": \"150\",\n \"SalesYearToDateChange\": \"20\",\n \"PriceIndexValue\": \"0.00115\",\n \"PriceIndexYearOverYearChange\": \"0.00115\",\n \"PriceIndexMonthOverMonthChange\": \"0.005\",\n \"PriceIndex3MonthMovingAverageChange\": \"0.012\",\n \"TransactionIndexValue\": \"0.5\",\n \"TransactionIndexYearOverYearChange\": \"0.56\",\n \"TransactionIndexMonthOverMonthChange\": \"0.57\",\n \"TransactionIndex3MonthMovingAverageChange\": \"0.58\",\n \"SameStoreSalesIndexYearOverYearChange\": \"0.6\",\n \"SameStoreSalesIndex3MonthMovingAverageChange\": \"0.68\"\n },\n {\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"reportA\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorA\",\n \"SubSector\": \"subA\",\n \"Segment\": \"seg1\",\n \"Ecomm\": \"Y\",\n \"SeasonalAdjustmentFlag\": \"Y\",\n \"PriceAdjustmentFlag\": \"Y\",\n \"ImpliedDeflatorYearOverYearChange\": \"0.0011\",\n \"ImpliedDeflatorMonthOverMonthChange\": \"0.0012\",\n \"PeriodStartDate\": \"5/1/2015\",\n \"PeriodEndDate\": \"5/7/2015\",\n \"ReportingCalender\": \"G\",\n \"NonGregorianReportingPeriod\": \"2015-05\",\n \"SubGeographyValue\": \"region\",\n \"SalesValueIndex\": \"6\",\n \"CurrencyOfForSalesValue\": \"US Dollars\",\n \"SalesYearOverYearChange\": \"600\",\n \"SalesMonthOverMonthChange\": \"60\",\n \"Sales3MonthMovingAverageChange\": \"160\",\n \"SalesYearToDateChange\": \"30\",\n \"PriceIndexValue\": \"0.000116\",\n \"PriceIndexYearOverYearChange\": \"0.00116\",\n \"PriceIndexMonthOverMonthChange\": \"0.006\",\n \"PriceIndex3MonthMovingAverageChange\": \"0.013\",\n \"TransactionIndexValue\": \"0.4\",\n \"TransactionIndexYearOverYearChange\": \"0.46\",\n \"TransactionIndexMonthOverMonthChange\": \"0.47\",\n \"TransactionIndex3MonthMovingAverageChange\": \"0.48\",\n \"SameStoreSalesIndexYearOverYearChange\": \"0.8\",\n \"SameStoreSalesIndex3MonthMovingAverageChange\": \"0.88\"\n },\n {\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"reportB\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorB\",\n \"SubSector\": \"subA\",\n \"Segment\": \"seg1\",\n \"Ecomm\": \"Y\",\n \"SeasonalAdjustmentFlag\": \"Y\",\n \"PriceAdjustmentFlag\": \"Y\",\n \"ImpliedDeflatorYearOverYearChange\": \"0.0011\",\n \"ImpliedDeflatorMonthOverMonthChange\": \"0.0012\",\n \"PeriodStartDate\": \"5/8/2015\",\n \"PeriodEndDate\": \"5/14/2015\",\n \"ReportingCalender\": \"G\",\n \"NonGregorianReportingPeriod\": \"2015-05\",\n \"SubGeographyValue\": \"region\",\n \"SalesValueIndex\": \"5\",\n \"CurrencyOfForSalesValue\": \"US Dollars\",\n \"SalesYearOverYearChange\": \"500\",\n \"SalesMonthOverMonthChange\": \"50\",\n \"Sales3MonthMovingAverageChange\": \"150\",\n \"SalesYearToDateChange\": \"20\",\n \"PriceIndexValue\": \"0.00115\",\n \"PriceIndexYearOverYearChange\": \"0.00115\",\n \"PriceIndexMonthOverMonthChange\": \"0.005\",\n \"PriceIndex3MonthMovingAverageChange\": \"0.012\",\n \"TransactionIndexValue\": \"0.5\",\n \"TransactionIndexYearOverYearChange\": \"0.56\",\n \"TransactionIndexMonthOverMonthChange\": \"0.57\",\n \"TransactionIndex3MonthMovingAverageChange\": \"0.58\",\n \"SameStoreSalesIndexYearOverYearChange\": \"0.6\",\n \"SameStoreSalesIndex3MonthMovingAverageChange\": \"0.68\"\n },\n {\n \"ProductLine\": \"Weekly Sales\",\n \"PublicationCoveragePeriod\": \"Week\",\n \"Country\": \"US\",\n \"ReportType\": \"reportB\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorB\",\n \"SubSector\": \"subA\",\n \"Segment\": \"seg1\",\n \"Ecomm\": \"Y\",\n \"SeasonalAdjustmentFlag\": \"Y\",\n \"PriceAdjustmentFlag\": \"Y\",\n \"ImpliedDeflatorYearOverYearChange\": \"0.0011\",\n \"ImpliedDeflatorMonthOverMonthChange\": \"0.0012\",\n \"PeriodStartDate\": \"5/1/2015\",\n \"PeriodEndDate\": \"5/7/2015\",\n \"ReportingCalender\": \"G\",\n \"NonGregorianReportingPeriod\": \"2015-05\",\n \"SubGeographyValue\": \"region\",\n \"SalesValueIndex\": \"6\",\n \"CurrencyOfForSalesValue\": \"US Dollars\",\n \"SalesYearOverYearChange\": \"600\",\n \"SalesMonthOverMonthChange\": \"60\",\n \"Sales3MonthMovingAverageChange\": \"160\",\n \"SalesYearToDateChange\": \"30\",\n \"PriceIndexValue\": \"0.000116\",\n \"PriceIndexYearOverYearChange\": \"0.00116\",\n \"PriceIndexMonthOverMonthChange\": \"0.006\",\n \"PriceIndex3MonthMovingAverageChange\": \"0.013\",\n \"TransactionIndexValue\": \"0.4\",\n \"TransactionIndexYearOverYearChange\": \"0.46\",\n \"TransactionIndexMonthOverMonthChange\": \"0.47\",\n \"TransactionIndex3MonthMovingAverageChange\": \"0.48\",\n \"SameStoreSalesIndexYearOverYearChange\": \"0.8\",\n \"SameStoreSalesIndex3MonthMovingAverageChange\": \"0.88\"\n }\n ]\n }\n }\n}"},"type":"documentation"}]}},"/subscription":{"get":{"description":"Returns a list of all reports one is currently subscribed to.\n","parameters":[{"description":"Starting record number to return.","in":"query","name":"CurrentRow","required":false,"example":"1","schema":{"type":"string"}},{"description":"Used to restrict the number of records returned if needed to be less than max.","in":"query","name":"Offset","required":false,"example":"25","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of subscriptions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionListResponse"}}}},"default":{"description":"Unexpected errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSchema"}}}}},"summary":"Returns a list of all reports one is currently subscribed to.","tags":["Subscription"],"x-samples":[{"name":"example_subscription","request":{"application/json":"{\n \"CurrentRow\": \"1\",\n \"Offset\" : \"25\"\n}"},"response":{"application/json":"{\n \"SubscriptionList\": {\n \"Count\": \"4\",\n \"Message\": \"Success\",\n \"SubscriptionArray\": {\n \"Subscription\": [\n {\n \"Country\": \"US\",\n \"ReportType\": \"reportA\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorA\",\n \"Ecomm\": \"Y\"\n },\n {\n \"Country\": \"US\",\n \"ReportType\": \"sectorB\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorB\",\n \"Ecomm\": \"Y\"\n },\n {\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Weekly\",\n \"Sector\": \"Gas\",\n \"Ecomm\": \"N\"\n },\n {\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Monthly\",\n \"Sector\": \"Gas\",\n \"Ecomm\": \"N\"\n }\n ]\n }\n }\n}"}},{"name":"example_subscription_for explorer","populateDefaults":{"application/json":"{\n \"CurrentRow\": true,\n \"Offset\" : true\n}"},"request":{"application/json":"{\n \"CurrentRow\": \"1\",\n \"Offset\" : \"25\"\n}"},"response":{"application/json":"{\n \"SubscriptionList\": {\n \"Count\": \"4\",\n \"Message\": \"Success\",\n \"SubscriptionArray\": {\n \"Subscription\": [\n {\n \"Country\": \"US\",\n \"ReportType\": \"reportA\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorA\",\n \"Ecomm\": \"Y\"\n },\n {\n \"Country\": \"US\",\n \"ReportType\": \"sectorB\",\n \"Period\": \"Weekly\",\n \"Sector\": \"sectorB\",\n \"Ecomm\": \"Y\"\n },\n {\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Weekly\",\n \"Sector\": \"Gas\",\n \"Ecomm\": \"N\"\n },\n {\n \"Country\": \"US\",\n \"ReportType\": \"Gas\",\n \"Period\": \"Monthly\",\n \"Sector\": \"Gas\",\n \"Ecomm\": \"N\"\n }\n ]\n }\n }\n}"},"type":"documentation"}]}}},"servers":[{"url":"https://api.mastercard.com/spendingpulse/v1/spulse.svc"}],"components":{"schemas":{"Error":{"properties":{"Description":{"description":"This is the text description of the error. This is optional and will only be displayed if more information is available than is stored in the data identifier and reason code.","example":"Unauthorized Access","type":"string"},"ReasonCode":{"description":"This will identify the reason for the error.","example":"AUTHENTICATION_FAILED","type":"string"},"Recoverable":{"description":"This is a true/false presentation to explain if the transaction was submitted again would it be successful or not.","example":true,"type":"boolean"},"Source":{"description":"Unique identifier that attempts to define the field in error when available. If a specific field can't be identified System will be returned.","example":"System","type":"string"}}},"ErrorSchema":{"properties":{"Errors":{"$ref":"#/components/schemas/Errors"}}},"Errors":{"properties":{"Error":{"items":{"$ref":"#/components/schemas/Error"},"type":"array"}}},"GasWeeklyArray":{"properties":{"GasWeeklyRecord":{"items":{"$ref":"#/components/schemas/GasWeeklyRecord"},"type":"array"}}},"GasWeeklyList":{"properties":{"Count":{"description":"Total number of records returned from the query.","example":100,"type":"string"},"GasWeeklyArray":{"$ref":"#/components/schemas/GasWeeklyArray"},"Message":{"description":"Success/Failure.","example":"Success","type":"string"}}},"GasWeeklyListResponse":{"properties":{"GasWeeklyList":{"$ref":"#/components/schemas/GasWeeklyList"}}},"GasWeeklyRecord":{"properties":{"AveragePricePerGalRegularGasoline":{"description":"Average price at the pump for all gallons sold during the reporting week.","example":true,"type":"string"},"Country":{"description":"Country Code.","example":"UK","type":"string"},"PADDCode":{"description":"PADD (Petroleum Administration for Defense Districts) are defined by the U.S. Energy Information Administration. The PADD Districts are New England, Central Atlantic, Lower Atlantic, Midwest, Gulf Coast, Rocky Mountain, West Coast.","example":"West Coast","type":"string"},"PADDMillionsofBarrelsSold":{"description":"For the PADD being reported, the estimated number of barrels (42 U.S. gallons) of regular motor gasoline (includes all finished motor gasoline grades and formulations or blends . It does not contain diesel nor aviation fuel.) sold during the week.","example":12.023,"type":"string"},"PADDPercentChangeInBarrelsFromPriorWeek":{"description":"The percent change from one week ago in the PADDMillionsofBarrelsSold.","example":0.021,"type":"string"},"PADDPercentChangeinBarrelsfrom52WeeksAgo":{"description":"The percent change from 52 weeks ago in the PADDMillionsofBarrelsSold.","example":true,"type":"string"},"Period":{"description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual","example":"Week","type":"string"},"ProductLine":{"description":"Overall product line that the report belongs to, the only report for this resource is US Weekly Gasoline Demand Report.","example":"US Weekly Gasoline Demand Report","type":"string"},"PublicationCoveragePeriod":{"description":"Publication Coverage Period indicates what period is to be covered. For this report it will include the gasoline week ending date which will always be a Friday.","example":20150710,"type":"string"},"ReportType":{"description":"Report type name, today the only report supported is \"monitor\".","example":"monitor","type":"string"},"Sector":{"description":"Gas","example":"Gas","type":"string"},"Segment":{"description":"Not used.","example":true,"type":"string"},"SubSector":{"description":"Not used.","example":true,"type":"string"},"TotalBarrelsChangeFromPriorWeek":{"description":"Change in TotalMillionsOfBarrelsSold from one week ago.","example":1.426,"type":"string"},"TotalMillionsOfBarrels4WeekAverage":{"description":"Average millions of barrels of gasoline sold per week during the prior 4 weeks.","example":66.78,"type":"string"},"TotalMillionsOfBarrelsDailyAverage":{"description":"Average millions of barrels of gasoline sold per day during the week being reported.","example":9.759,"type":"string"},"TotalMillionsOfBarrelsSold":{"description":"Estimated number of barrels (42 U.S. Gallons) of regular motor gasoline (includes all finished motor gasoline grades and formulations or blends . IT does not contain diesel nor aviation fuel).","example":68.313,"type":"string"},"TotalPercentChangeInBarrelsFrom52WeeksAgo":{"description":"Percent change from 52 weeks ago in the TotalMillionsOfBarrelsSold.","example":true,"type":"string"},"TotalPercentChangeInBarrelsFromPriorWeek":{"description":"Percent change from one week ago in the TotalMillionsOfBarrelsSold.","example":0.021,"type":"string"},"TotalPercentChangeInThe4WeekAverageFrom52WeeksAgo":{"description":"Percent change from 52 weeks ago in the TotalMillionsOfBarrels4WeekAverage.","example":true,"type":"string"},"WeekEndDate":{"description":"End of week date.","example":"5/1/2015","type":"string"}}},"Parameter":{"properties":{"Country":{"description":"Country Code.","example":"UK","type":"string"},"Ecomm":{"description":"Ecommerce indicator. \"yes\" or \"no\" are the options.","example":"yes","type":"string"},"Period":{"description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual","example":"Week","type":"string"},"ProductLine":{"description":"Product lines available for the consumer ?US Executive Report? and/or ?US Weekly Gasoline Report?.","example":"US Executive","type":"string"},"PublicationCoveragePeriod":{"description":"Publication Coverage Period indicates what period is to be covered by the current report.","example":"March 2015","type":"string"},"ReportType":{"description":"Report type name, today the only report supported is \"monitor\".","example":"monitor","type":"string"},"Sector":{"description":"Sector name/id.","example":"Petrol","type":"string"}}},"ParameterArray":{"properties":{"Parameter":{"items":{"$ref":"#/components/schemas/Parameter"},"type":"array"}}},"ParameterList":{"properties":{"Count":{"description":"Total number of records returned from the query.","example":100,"type":"string"},"Message":{"description":"Success/Failure.","example":"Success","type":"string"},"ParameterArray":{"$ref":"#/components/schemas/ParameterArray"}}},"ParameterListResponse":{"properties":{"ParameterList":{"$ref":"#/components/schemas/ParameterList"}}},"SpendingPulseArray":{"properties":{"SpendingPulseRecord":{"items":{"$ref":"#/components/schemas/SpendingPulseRecord"},"type":"array"}}},"SpendingPulseList":{"properties":{"Count":{"description":"Total number of records returned from the query.","example":100,"type":"string"},"Message":{"description":"Success/Failure.","example":"Success","type":"string"},"SpendingPulseArray":{"$ref":"#/components/schemas/SpendingPulseArray"}}},"SpendingPulseListResponse":{"properties":{"SpendingPulseList":{"$ref":"#/components/schemas/SpendingPulseList"}}},"SpendingPulseRecord":{"properties":{"Country":{"description":"Country Code.","example":"UK","type":"string"},"CurrencyOfForSalesValue":{"description":"A value to indicate the currency in which the sales value is being reported. For sales index values, this field is not used.","example":"us dollar","type":"string"},"Ecomm":{"description":"Ecommerce indicator. \"yes\" or \"no\" are the options.","example":"Yes","type":"string"},"ImpliedDeflatorMonthOverMonthChange":{"description":"Percent change from one month ago in the implied deflator (the deflator is used in seasonal adjustment calculation).","example":2,"type":"string"},"ImpliedDeflatorYearOverYearChange":{"description":"Percent change from one year ago in the implied deflator (the deflator is used in seasonal adjustment calculation).","example":1,"type":"string"},"NonGregorianReportingPeriod":{"description":"For only those data reported by a non-Gregorian calendar (e.g. US Sectors which are reported based on the National Retail Federation 4-5-4 calendar) this value designates the retail period being reported. As an example, for the US apparel sector, for Period Date = February 2015, the reporting period is 2015-01 (February is the first month of US retail year 2015).","example":"2015-01","type":"string"},"Period":{"description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual","example":"Week","type":"string"},"PeriodEndDate":{"description":"Date indicating the end of the period covered by ensuing data.","example":"05/31/2015","type":"string"},"PeriodStartDate":{"description":"Date indicating the beginning of the period covered by ensuing data.","example":"05/01/2015","type":"string"},"PriceAdjustmentFlag":{"description":"Price adjustment indicator.","example":"Yes","type":"string"},"PriceIndex3MonthMovingAverageChange":{"description":"Percent change from one year ago in the three-month moving PriceIndexValue average.","example":11,"type":"string"},"PriceIndexMonthOverMonthChange":{"description":"Percent change from one month ago in the PriceIndexValue.","example":10,"type":"string"},"PriceIndexValue":{"description":"Published price index value for the period being reported. Not a currency value - a decimal index value. The price index takes into account both the average ticket value and the size of the basket. Changes in either will be reflected in the price index changes.","example":8,"type":"string"},"PriceIndexYearOverYearChange":{"description":"Percent change from one year ago in the PriceIndexValue.","example":9,"type":"string"},"ProductLine":{"description":"Product line, either for this resource it will be ?US Executive\".","example":"US Executive","type":"string"},"PublicationCoveragePeriod":{"description":"Publication Coverage Period indicates what period is to be covered, often the current report will include the month prior.","example":"March 2015","type":"string"},"ReportType":{"description":"Report type name, today the only report supported is \"monitor\".","example":"monitor","type":"string"},"ReportingCalender":{"description":"Value indicates calendar used for periodic aggregation (e.g. \"G\" = Gregorian, \"454\" = US Retail, \"445\" = UK ONS, etc.) Please note that some data are reported under more than one calendar. As a result, in order to uniquely identify the data being reported, the reporting calendar must be included.","example":"gregorian","type":"string"},"Sales3MonthMovingAverageChange":{"description":"Percent change from one year ago in the three-month moving SalesIndexValue average.","example":6,"type":"string"},"SalesMonthOverMonthChange":{"description":"Percent change from one month ago in the SalesValueIndex.","example":5,"type":"string"},"SalesValueIndex":{"description":"Aggregated/computed value of sales for the period being reported. This may be an index value (not a currency value - just a decimal value) or it may be a currency value that would typically be in local currency (dollar, pound, yen, etc.)","example":3,"type":"string"},"SalesYearOverYearChange":{"description":"Percent change from one year ago in the SalesValueIndex.","example":4,"type":"string"},"SalesYearToDateChange":{"description":"Percent change from year ago.","example":7,"type":"string"},"SameStoreSalesIndex3MonthMovingAverageChange":{"description":"Percent change from one month ago in the SameStoreSalesIndex.","example":17,"type":"string"},"SameStoreSalesIndexYearOverYearChange":{"description":"Percent change from one year ago in the SameStoreSalesIndex.","example":16,"type":"string"},"SeasonalAdjustmentFlag":{"description":"Seasonal data adjustment indicator.","example":"Yes","type":"string"},"Sector":{"description":"Sector name/id.","example":"Petrol","type":"string"},"Segment":{"description":"Sub unit within a sector e.g. Sector = restaurant; SubSector = Full Service; Segment = Fine Dining.","example":"Fine Dining","type":"string"},"SubGeographyValue":{"description":"For those data reported by sub-geographies (e.g. regions, states, etc.) the sub-geography being reported.","example":"region","type":"string"},"SubSector":{"description":"Sub unit within a sector e.g. Sector = Electronics & Appliances; SubSector = Electronics.","example":"Electronics","type":"string"},"TransactionIndex3MonthMovingAverageChange":{"description":"Percent change from one year ago in the three-month moving TransactionIndexValue average.","example":3,"type":"string"},"TransactionIndexMonthOverMonthChange":{"description":"Percent change from one month ago in the TransactionIndexValue.","example":14,"type":"string"},"TransactionIndexValue":{"description":"Published transaction index value for the period being reported. Not a currency value - a decimal index value. The transaction index is a relative indication of transactions volume in the sector/sub-sector/segment being reported.","example":12,"type":"string"},"TransactionIndexYearOverYearChange":{"description":"Percent change from one year ago in the TransactionIndexValue.","example":13,"type":"string"}}},"Subscription":{"properties":{"Country":{"description":"Country Code.","example":"UK","type":"string"},"Ecomm":{"description":"Ecommerce indicator. \"yes\" or \"no\" are the options.","example":"Yes","type":"string"},"Period":{"description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual","example":"Week","type":"string"},"ReportType":{"description":"Report type name, today the only report supported is \"monitor\".","example":"monitor","type":"string"},"Sector":{"description":"Sector name.","example":"Sporting Goods","type":"string"}}},"SubscriptionArray":{"properties":{"Subscription":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"}}},"SubscriptionList":{"properties":{"Count":{"description":"Total number of records returned from the query.","example":100,"type":"string"},"Message":{"description":"Success/Failure","example":"Success","type":"string"},"SubscriptionArray":{"$ref":"#/components/schemas/SubscriptionArray"}}},"SubscriptionListResponse":{"properties":{"SubscriptionList":{"$ref":"#/components/schemas/SubscriptionList"}}}}}}