Skip to content

Budgets

Returns budgets available in the system. Returned data can be limited with year query parameter.

Operations

Download budgets as JSON

Request

GET https://api.zoined.com/v2/download/budgets?limit=1000&offset=0&year=2018&label=forecast&metric=sales

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
yearnumber

Returns budgets for given year(s) only

Example:year=2018
labelstring

Returns budgets with given label(s) only

Example:label=forecast
metricstring

Returns budgets for given metric(s) only

Example:metric=sales
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/budgets?limit=1000&offset=0&year=2018&label=forecast&metric=sales' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
yearnumberrequired

Year this budget entry refers to

Example:2019
monthnumber

Month this budget entry refers to. Either month or week must be specified.

Example:1
weeknumber

Week this budget entry refers to. Either month or week must be specified.

Example:12
daynumber

Optional day this budget entry refers to

Example:1
hournumber

Optional hour this budget refers to. Day must be also specified if hour is specified.

Example:12
labelstring

Label (type) this budget has

Example:"forecast"
dimensionsobjectrequired

Key-value pairs of dimensions and values for entry

Example:
{}
metricsobjectrequired

Key-value pairs of metric values for given time and dimensions

Example:
{}
Response
{
  "year": 2019,
  "month": 1,
  "week": 12,
  "day": 1,
  "hour": 12,
  "label": "forecast",
  "dimensions": {},
  "metrics": {}
}