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.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NyIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYxOTl9.dF-1qutHhEbrV5zTwbrkKRtNtWfo_IC2Auyya9tGVMY Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3NyIsImVtYWlsIjoiZW1haWwtMTIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzk0MjYxOTl9.dF-1qutHhEbrV5zTwbrkKRtNtWfo_IC2Auyya9tGVMY" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "70cbfe64-c23b-4d51-a356-9347fdfdd98c", "url": "/v2/events/70cbfe64-c23b-4d51-a356-9347fdfdd98c", "created_at": "2015-08-06T00:36:39Z", "updated_at": null }, "entity": { "type": "name-618", "actor": "guid-b6e172cd-0407-45d3-8562-0e99a1cf152a", "actor_type": "name-619", "actor_name": "name-620", "actee": "guid-def34e0e-6ad4-4721-ae4d-6654aa19cdaf", "actee_type": "name-621", "actee_name": "name-622", "timestamp": "2015-08-06T00:36:39Z", "metadata": { }, "space_guid": "a5e8190e-c571-4bfe-a759-f4061b86d212", "organization_guid": "4e73c899-e144-4833-9e24-26f344528e35" } }, { "metadata": { "guid": "39ff0ce8-34ee-4fad-9e0a-37ae5b8c8ec4", "url": "/v2/events/39ff0ce8-34ee-4fad-9e0a-37ae5b8c8ec4", "created_at": "2015-08-06T00:36:39Z", "updated_at": null }, "entity": { "type": "name-626", "actor": "guid-a14b3f85-b33f-47cc-82a1-5f43cc74f36b", "actor_type": "name-627", "actor_name": "name-628", "actee": "guid-ba8eb2dc-ab07-499b-8516-75f24875b8aa", "actee_type": "name-629", "actee_name": "name-630", "timestamp": "2015-08-06T00:36:39Z", "metadata": { }, "space_guid": "28b4e266-dd7d-4976-83ee-068e15d55390", "organization_guid": "a51b5366-d3b6-4d5e-bcef-7fb71c97f423" } }, { "metadata": { "guid": "8b1044ee-020f-481a-a68b-d62801c1b229", "url": "/v2/events/8b1044ee-020f-481a-a68b-d62801c1b229", "created_at": "2015-08-06T00:36:39Z", "updated_at": null }, "entity": { "type": "name-634", "actor": "guid-727622f1-338b-4d45-a487-97f3733432c0", "actor_type": "name-635", "actor_name": "name-636", "actee": "guid-3a2c8940-838e-4600-b63d-d0ef643ea3eb", "actee_type": "name-637", "actee_name": "name-638", "timestamp": "2015-08-06T00:36:39Z", "metadata": { }, "space_guid": "03442a0f-8a4c-4389-8675-ea17cc5401ad", "organization_guid": "ca75fc2d-fdb9-4992-8dd8-71e5ce299d9c" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 30679de4-21c3-440e-9201-e84d88596a08 Content-Length: 2385 X-Content-Type-Options: nosniff