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.eyJ1c2VyX2lkIjoidWFhLWlkLTExMiIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODU5OTQyOX0.fHIm4coLBke0zwh192H358Y1ODGs7I6bX2gNhMLTyDw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMiIsImVtYWlsIjoiZW1haWwtNzRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODU5OTQyOX0.fHIm4coLBke0zwh192H358Y1ODGs7I6bX2gNhMLTyDw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "a8de5d05-7dbc-4140-b9f0-d628a093a4e9", "url": "/v2/events/a8de5d05-7dbc-4140-b9f0-d628a093a4e9", "created_at": "2016-03-14T22:30:29Z", "updated_at": null }, "entity": { "type": "name-1252", "actor": "guid-bcad516b-a044-4785-bc10-f248f2ce93f4", "actor_type": "name-1253", "actor_name": "name-1254", "actee": "guid-2b2104fa-c433-4200-8516-753a7bed27bb", "actee_type": "name-1255", "actee_name": "name-1256", "timestamp": "2016-03-14T22:30:29Z", "metadata": { }, "space_guid": "73f8dc41-a461-49c8-81cf-81a3ed6fd91e", "organization_guid": "06588a08-5a63-4b31-9495-5eeff2d7f63b" } }, { "metadata": { "guid": "3a3040af-0e78-44ee-96e4-a3ce04d37472", "url": "/v2/events/3a3040af-0e78-44ee-96e4-a3ce04d37472", "created_at": "2016-03-14T22:30:29Z", "updated_at": null }, "entity": { "type": "name-1260", "actor": "guid-0dfb3db5-81ba-485e-b3fe-e74e02a0537e", "actor_type": "name-1261", "actor_name": "name-1262", "actee": "guid-3b23f6b1-e84f-4d2b-b8e3-a90f6478adfb", "actee_type": "name-1263", "actee_name": "name-1264", "timestamp": "2016-03-14T22:30:29Z", "metadata": { }, "space_guid": "1ee929cd-739b-4fd6-85c0-efabbdfb5a44", "organization_guid": "ee72f217-3bc2-4141-9bee-903dcec4b25b" } }, { "metadata": { "guid": "fd1269f4-16ff-4961-8e9d-06f79dc7b64d", "url": "/v2/events/fd1269f4-16ff-4961-8e9d-06f79dc7b64d", "created_at": "2016-03-14T22:30:29Z", "updated_at": null }, "entity": { "type": "name-1268", "actor": "guid-7985ba95-7bb6-4a44-972a-06561d440563", "actor_type": "name-1269", "actor_name": "name-1270", "actee": "guid-f8b3ab57-77f6-456f-97cf-384257acb76b", "actee_type": "name-1271", "actee_name": "name-1272", "timestamp": "2016-03-14T22:30:29Z", "metadata": { }, "space_guid": "c82912bb-30f7-45a4-b5aa-fa13434e7498", "organization_guid": "953e4501-6443-4380-b896-50540f21cfa2" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2400 X-Content-Type-Options: nosniff