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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5MzR9.lNOqN25xe1rIJ5SOtI1ATh9SXZywFovpOjWOGGtWlRI Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5NyIsImVtYWlsIjoiZW1haWwtMTMwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDQ3ODI5MzR9.lNOqN25xe1rIJ5SOtI1ATh9SXZywFovpOjWOGGtWlRI" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "60d44868-d84c-4852-b7c0-2262a7c35cc8", "url": "/v2/events/60d44868-d84c-4852-b7c0-2262a7c35cc8", "created_at": "2015-10-07T00:35:34Z", "updated_at": null }, "entity": { "type": "name-1703", "actor": "guid-dade183d-a298-44a6-872e-696ac23ba49e", "actor_type": "name-1704", "actor_name": "name-1705", "actee": "guid-ab55cabe-151b-4558-9b6d-d8e5cd7aa2d2", "actee_type": "name-1706", "actee_name": "name-1707", "timestamp": "2015-10-07T00:35:34Z", "metadata": { }, "space_guid": "c43b50c8-22f0-4283-9162-f7465744758f", "organization_guid": "bb4b2fa0-4e10-4c58-ba65-3b1c2b2b3aab" } }, { "metadata": { "guid": "c540243c-5d92-41f8-8fed-41b4df4e89be", "url": "/v2/events/c540243c-5d92-41f8-8fed-41b4df4e89be", "created_at": "2015-10-07T00:35:34Z", "updated_at": null }, "entity": { "type": "name-1711", "actor": "guid-161e2361-245f-4f59-8dee-582e13b1ed7b", "actor_type": "name-1712", "actor_name": "name-1713", "actee": "guid-2175fb01-da32-4a78-a7e9-5769074be51f", "actee_type": "name-1714", "actee_name": "name-1715", "timestamp": "2015-10-07T00:35:34Z", "metadata": { }, "space_guid": "38d466f6-88bf-463f-8dc6-4fc1281f3b15", "organization_guid": "27f81989-6279-4917-90b4-a8a4fe192d33" } }, { "metadata": { "guid": "148f49d9-eff1-44c4-82f3-27ae37dae9c0", "url": "/v2/events/148f49d9-eff1-44c4-82f3-27ae37dae9c0", "created_at": "2015-10-07T00:35:34Z", "updated_at": null }, "entity": { "type": "name-1719", "actor": "guid-37069877-689b-4e17-a3b3-7087dc726326", "actor_type": "name-1720", "actor_name": "name-1721", "actee": "guid-da703763-23d7-47ac-900b-5eae235f08c3", "actee_type": "name-1722", "actee_name": "name-1723", "timestamp": "2015-10-07T00:35:34Z", "metadata": { }, "space_guid": "c4b1c1f6-2ec6-406d-94de-20f98f17d3ce", "organization_guid": "ea084d71-2d76-4805-afda-a084cb6cfe45" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 3ac26515-0bbd-419b-a7a6-8b7aaf9d41a2 Content-Length: 2400 X-Content-Type-Options: nosniff