List all App Usage Events
GET /v2/app_usage_events
Events are sorted by internal database IDs. This order may differ from created_at.
Events close to the current time should not be processed because other events may still have open
transactions that will change their order in the results.
Request
Route
GET /v2/app_usage_events?results-per-page=1&after_guid=7d7ef31e-b564-4f1d-addf-0ec27f5e0049
Parameters
| Name |
Description |
Valid Values |
Example Values |
|
page
|
Page of results to fetch
|
|
|
|
results-per-page
|
Number of results per page
|
|
|
|
order-direction
|
Order of the results: asc (default) or desc
|
|
|
|
inline-relations-depth
|
0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
|
|
|
|
orphan-relations
|
0 - de-duplicate object entries in response
|
|
|
|
exclude-relations
|
comma-delimited list of relations to drop from response
|
|
|
|
include-relations
|
comma-delimited list of the only relations to include in response
|
|
|
|
after_guid
|
Restrict results to App Usage Events after the one with the given guid
|
|
|
results-per-page: 1
after_guid: 7d7ef31e-b564-4f1d-addf-0ec27f5e0049
Body
| Name |
Description |
Default |
Valid Values |
Example Values |
|
guid
|
The guid of the event.
|
|
|
|
|
state
|
The desired state of the app or 'BUILDPACK_SET' when buildpack info has been set.
|
|
- STARTED
- STOPPED
- BUILDPACK_SET
|
|
|
package_state
|
The state of the package.
|
|
|
|
|
instance_count
|
How many instance of the app.
|
|
|
|
|
memory_in_mb_per_instance
|
How much memory per app instance.
|
|
|
|
|
app_guid
|
The GUID of the app.
|
|
|
|
|
app_name
|
The name of the app.
|
|
|
|
|
org_guid
|
The GUID of the organization.
|
|
|
|
|
space_guid
|
The GUID of the space.
|
|
|
|
|
space_name
|
The name of the space.
|
|
|
|
|
buildpack_guid
|
The GUID of the buildpack used to stage the app.
|
|
|
|
|
parent_app_guid
|
The GUID for a parent v3 application if one exists
|
|
|
|
|
parent_app_name
|
The name for a parent v3 application if one exists
|
|
|
|
|
process_type
|
The process_type for applictions.
|
|
|
|
|
buildpack_name
|
The name of the buildpack or the URL of the custom buildpack used to stage the app.
|
|
|
- https://example.com/buildpack.git
- admin_buildpack
|
|
created_at
|
The timestamp when the event is recorded. It is possible that later events may have earlier created_at values.
|
|
|
|
Headers
cURL
curl "https://api.[your-domain.com]/v2/app_usage_events?results-per-page=1&after_guid=7d7ef31e-b564-4f1d-addf-0ec27f5e0049" -X GET \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwOSIsImVtYWlsIjoiZW1haWwtMjI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTV9.IUHzzThSuhpKQ3FqN9yaY62ZlBZAE-KSCG9UJMUGPzk" \
-H "Host: example.org" \
-H "Cookie: "
Response
Status
200 OK
Body
{
"total_results": 2,
"total_pages": 2,
"prev_url": null,
"next_url": "/v2/app_usage_events?after_guid=7d7ef31e-b564-4f1d-addf-0ec27f5e0049&order-direction=asc&page=2&results-per-page=1",
"resources": [
{
"metadata": {
"guid": "f8f237f0-9a55-405d-ba3f-ac29388c3e62",
"url": "/v2/app_usage_events/f8f237f0-9a55-405d-ba3f-ac29388c3e62",
"created_at": "2015-06-04T00:05:15Z"
},
"entity": {
"state": "STARTED",
"memory_in_mb_per_instance": 564,
"instance_count": 1,
"app_guid": "guid-07be83d1-48e3-4358-bc72-3554435013b3",
"app_name": "name-1821",
"space_guid": "guid-27860275-7875-48c3-a2f4-c126377227d9",
"space_name": "name-1822",
"org_guid": "guid-cc2e0b32-cb61-44d0-a520-848ea576ac00",
"buildpack_guid": "guid-179eb4ee-db76-4aef-b46e-af77346cb248",
"buildpack_name": "name-1823",
"package_state": "STAGED",
"parent_app_guid": null,
"parent_app_name": null,
"process_type": "web"
}
}
]
}
Headers