New in 0.2.x
The following endpoint will be released in version 0.2.x (part of the mobile application API update). Please check the version here before attempting to use this endpoint.
Get Time Allocations
Resource URL
GET /activities/allocations
Parameters
Table of allowed parameters.
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
|---|---|---|
| _filters | partial string | Filter the allocation sum. See activity filters. |
Handling the response
Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.
| billable | unsigned | Total billable time for all activities found (in seconds) |
|---|---|---|
| nonbillable | unsigned | Total non-billable time for all activities found (in seconds) |
| charged | double | The total value charged. |
Don't see a field you're after? Please feel free to let us know. Keep in mind these are based on a group of activities. For example, we could add an optional field for the first date logged value.
Sample Response
GET /activities/allocations.json?_filters=owner_type(staff),owner_id(1),date_logged_before(<timestamp>)
Would return the total time logged for the staff member with id one, logged before the unix <timestamp> value.
{
"response" : {
"billable":93612,
"nonbillable":14490
},
"meta" : {
"status" : "ok",
"message" : "Everything executed as expected."
}
}