get_resource_usage

This function will return usage/availability information of given resource (or entire site) for specified period of time. Note that the output is minimized, so only periods with usage (reservations or vacations) will be returned. (click for full documentation)

resource_id

int

ID of the resource. Pass null if you want info for all resources to be returned. In this case and if using a metasite API key, you'll need to pass the site id in the site_id parameter.

site_id

int

Required only for metasite API keys and when resource_id is null. Otherwise skip this parameter.

start_date

DateTime (date part) *

DateTime (time part)

Start date of the period

end_date

DateTime (date part) *

DateTime (time part)

End date of the period

separate_periods

bool

If set to true, then this function will return usage by grouping together time ranges with the same usage value instead of returning it for each time slot. See the output format for more information. By default this is set to false.

separate_units

bool

You can retrieve usage for individual units if you set this to true

language

string

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

string*

your API key - Click here to get your key

* - champ obligatoire

API Playground - get_resource_usage