Home
Version 3
App Usage Events API

App Usage Events API

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=329d656a-d600-42ba-8fa6-8e9dacfca5dc

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: 329d656a-d600-42ba-8fa6-8e9dacfca5dc

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.
  • PENDING
  • STAGED
  • FAILED
instance_count How many instance of the app.
memory_in_mb_per_instance How much memory per app instance.
  • 128
  • 256
  • 512
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.
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

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2ODB9.e0UJnDlJIFAt9bu1Lx93nmgRW6eaMf0D3KlY5PXi81k
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/app_usage_events?results-per-page=1&after_guid=329d656a-d600-42ba-8fa6-8e9dacfca5dc" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NCIsImVtYWlsIjoiZW1haWwtMjg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjU5NDg2ODB9.e0UJnDlJIFAt9bu1Lx93nmgRW6eaMf0D3KlY5PXi81k" \
	-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=329d656a-d600-42ba-8fa6-8e9dacfca5dc&order-direction=asc&page=2&results-per-page=1",
  "resources": [
    {
      "metadata": {
        "guid": "45811a1e-9d05-4790-91ad-a56c30cb6cd7",
        "url": "/v2/app_usage_events/45811a1e-9d05-4790-91ad-a56c30cb6cd7",
        "created_at": "2015-03-03T00:51:20Z"
      },
      "entity": {
        "state": "STARTED",
        "memory_in_mb_per_instance": 564,
        "instance_count": 1,
        "app_guid": "guid-73771d56-f112-49dd-bfc6-981ba2795dc6",
        "app_name": "name-2069",
        "space_guid": "guid-0e073a1e-646d-420d-bed7-2b28a99842a2",
        "space_name": "name-2070",
        "org_guid": "guid-576d53a4-15ff-4331-88bc-c641aa4fa7dd",
        "buildpack_guid": "guid-dab0e2eb-b3ff-4d49-88e0-7fc4b3b7882c",
        "buildpack_name": "name-2071",
        "package_state": "STAGED"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: dc6fad1c-c30c-4ad6-a453-c4a292bc11d1
Content-Length: 970
X-Content-Type-Options: nosniff