GET /v2/events
Name | Description | Valid Values | Example Values |
---|---|---|---|
q |
Parameters used to filter the result set. Format queries as <filter><op><value> Valid ops: : >= <= < > IN Valid filters: timestamp, type, actee |
|
|
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 |
|
|
Name | Description | Default | Valid Values | Example Values |
---|---|---|---|---|
guid | The guid of the event. |
|
|
|
type | The type of the event. |
|
|
|
actor | The GUID of the actor. |
|
|
|
actor_type | The actor type. |
|
|
|
actor_name | The name of the actor. |
|
|
|
actee | The GUID of the actee. |
|
|
|
actee_type | The actee type. |
|
|
|
actee_name | The name of the actee. |
|
|
|
timestamp | The event creation time. |
|
|
|
metadata | The additional information about event. | {} |
|
|
space_guid | The guid of the associated space. |
|
|
|
organization_guid | The guid of the associated organization. |
|
|
Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MyIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MTl9.wpSN4-mieb7TDScUd3WnaezDwrBTpAAPUO_alugLoYU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0MyIsImVtYWlsIjoiZW1haWwtMjQ1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjY2MzM5MTl9.wpSN4-mieb7TDScUd3WnaezDwrBTpAAPUO_alugLoYU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "826f6338-1348-40e1-ad2a-998ca45fc948", "url": "/v2/events/826f6338-1348-40e1-ad2a-998ca45fc948", "created_at": "2015-03-10T23:11:58Z", "updated_at": null }, "entity": { "type": "name-1903", "actor": "guid-4b765ab2-6615-45f1-bd19-9ba0f010eefd", "actor_type": "name-1904", "actor_name": "name-1905", "actee": "guid-a51a7b50-da2f-4484-8cd6-ee7dea8e8841", "actee_type": "name-1906", "actee_name": "name-1907", "timestamp": "2015-03-10T23:11:58Z", "metadata": { }, "space_guid": "24f4acff-b5c6-4cc1-9a6f-22bfef7e695a", "organization_guid": "8e03ebdf-f333-43aa-9cf3-b06491048fa6" } }, { "metadata": { "guid": "cfa19b22-8b5a-4910-80f0-d060a6f4b880", "url": "/v2/events/cfa19b22-8b5a-4910-80f0-d060a6f4b880", "created_at": "2015-03-10T23:11:58Z", "updated_at": null }, "entity": { "type": "name-1911", "actor": "guid-186f5e45-723d-482e-9b6a-d2fdbd5b1601", "actor_type": "name-1912", "actor_name": "name-1913", "actee": "guid-9e4c5937-f5e0-4521-a0c3-b1dc070edf86", "actee_type": "name-1914", "actee_name": "name-1915", "timestamp": "2015-03-10T23:11:58Z", "metadata": { }, "space_guid": "15dde468-6ce5-4fa3-9ac2-040c2c97021d", "organization_guid": "765e247d-2058-45e8-8ef8-dd0179e63d13" } }, { "metadata": { "guid": "bd3b6f37-1316-454a-bf68-b15345b3b81b", "url": "/v2/events/bd3b6f37-1316-454a-bf68-b15345b3b81b", "created_at": "2015-03-10T23:11:58Z", "updated_at": null }, "entity": { "type": "name-1919", "actor": "guid-0695db2e-10f9-4622-addf-edba72af6b97", "actor_type": "name-1920", "actor_name": "name-1921", "actee": "guid-262da4ed-5f2c-4e59-912e-82bd8829b519", "actee_type": "name-1922", "actee_name": "name-1923", "timestamp": "2015-03-10T23:11:58Z", "metadata": { }, "space_guid": "40ba6aff-62df-43a8-924c-8be3714d7548", "organization_guid": "99e3e188-1c8d-4700-8949-5284dfc3c1a1" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: b25425f5-5fd7-4366-a29b-e60b66fb96cc Content-Length: 2400 X-Content-Type-Options: nosniff