Documentation

Create Actual Usage Entry

POST /actualusage

Create a usage entry with a start and end time, or open and close a session in separate requests using open_session and close_session. Use Update or Delete Actual Usage Entry to change a record by ID.

Note: Please also refer to the advanced usage instructions for interacting with individual resources via the API. This can be found on the Actual Usage tab of a resource when editing it in QReserve.

Request Body

Field Type Required Description
start number (float/integer) No Start Unix timestamp in seconds
end number (float/integer) No End Unix timestamp in seconds
source string No Source of the actual usage entry
in_use boolean Yes Whether the resource is in use
metrics object No Additional metrics for the actual usage entry
require_user boolean No Whether a user is required for this actual usage entry
ignore_user boolean No Whether to ignore the user for this actual usage entry
use_res_user boolean No Whether to use the user from the reservation
reservable_id string No ID of the reservable resource
api_key string No API key for authentication
reservation_id string No ID of the reservation
user_id string No ID of the user
user_email string No Email of the user
user_identifier string No Identifier for the user
open_session boolean No Whether to open a new session
auto_end integer No Auto-end timestamp for the session
update_session boolean No Whether to update an existing session
close_session boolean No Whether to close an existing session
return_data boolean No Whether to return data in the response

Response

Success Response (200 OK)

Response depends on the operation and whether return_data is set to true.

Error Responses

  • 400 Bad Request: Invalid request or validation error
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission for this operation
  • 422 Unprocessable Entity: The body does not match the request schema.

Batch Operations: Send a JSON object with a list array to submit multiple entries. With return_data enabled, data contains the resulting records.


See the Actual Usage API overview for related endpoints.