{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:mastercard-spending-pulse/get-gasweekly":{"get":{"operationId":"open_data_mastercard_spending_pulse_get_gasweekly","summary":"Returns the weekly gasoline report. This resource pulls back the report with ProductLine = \"US Weekly…","description":"GET /gasweekly","tags":["open-data"],"parameters":[{"name":"CurrentRow","in":"query","required":false,"description":"Starting record number to return.","schema":{"type":"string","description":"Starting record number to return."},"example":"1"},{"name":"Offset","in":"query","required":false,"description":"Used to restrict the number of records returned if needed to be less than max.","schema":{"type":"string","description":"Used to restrict the number of records returned if needed to be less than max."},"example":"25"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-spending-pulse/get-parameters":{"get":{"operationId":"open_data_mastercard_spending_pulse_get_parameters","summary":"Returns a distinct list of all reports are available and that one is subscribed to.","description":"GET /parameters","tags":["open-data"],"parameters":[{"name":"CurrentRow","in":"query","required":false,"description":"Starting record number to return.","schema":{"type":"string","description":"Starting record number to return."},"example":"1"},{"name":"Offset","in":"query","required":false,"description":"Used to restrict the number of records returned if needed to be less than max.","schema":{"type":"string","description":"Used to restrict the number of records returned if needed to be less than max."},"example":"25"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-spending-pulse/get-spendingpulse":{"get":{"operationId":"open_data_mastercard_spending_pulse_get_spendingpulse","summary":"Returns all Spending Pulse reports (with the exception of the gasoline weekly report, which has its own…","description":"GET /spendingpulse","tags":["open-data"],"parameters":[{"name":"CurrentRow","in":"query","required":false,"description":"Starting record number to return.","schema":{"type":"string","description":"Starting record number to return."},"example":"1"},{"name":"Offset","in":"query","required":false,"description":"Used to restrict the number of records returned if needed to be less than max.","schema":{"type":"string","description":"Used to restrict the number of records returned if needed to be less than max."},"example":"25"},{"name":"ProductLine","in":"query","required":false,"description":"Product Line. Either ?US Executive Report? or ?Weekly Sales?","schema":{"type":"string","description":"Product Line. Either ?US Executive Report? or ?Weekly Sales?"},"example":"Weekly Sales"},{"name":"PublicationCoveragePeriod","in":"query","required":false,"description":"Publication Coverage Period indicates what period is to be covered, often the current report will include the month prior.","schema":{"type":"string","description":"Publication Coverage Period indicates what period is to be covered, often the current report will include the month prior."},"example":"March 2015"},{"name":"Country","in":"query","required":false,"description":"Country code.","schema":{"type":"string","description":"Country code."},"example":"US"},{"name":"ReportType","in":"query","required":false,"description":"Report type name, today the only report supported is \"monitor\".","schema":{"type":"string","description":"Report type name, today the only report supported is \"monitor\"."},"example":"reportA"},{"name":"Period","in":"query","required":false,"description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual","schema":{"type":"string","description":"Indicates the period covered by the data with possible values of - day, week, month, quarter, annual"},"example":"Weekly"},{"name":"Sector","in":"query","required":false,"description":"Sector name.","schema":{"type":"string","description":"Sector name."},"example":"sectorA"},{"name":"Ecomm","in":"query","required":false,"description":"Ecommerce indicator.","schema":{"type":"string","description":"Ecommerce indicator."},"example":"Y"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:mastercard-spending-pulse/get-subscription":{"get":{"operationId":"open_data_mastercard_spending_pulse_get_subscription","summary":"Returns a list of all reports one is currently subscribed to.","description":"GET /subscription","tags":["open-data"],"parameters":[{"name":"CurrentRow","in":"query","required":false,"description":"Starting record number to return.","schema":{"type":"string","description":"Starting record number to return."},"example":"1"},{"name":"Offset","in":"query","required":false,"description":"Used to restrict the number of records returned if needed to be less than max.","schema":{"type":"string","description":"Used to restrict the number of records returned if needed to be less than max."},"example":"25"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}