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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNSIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjB9._GiPW9VtIuJ_NbBC1ajF1d3Puh9fLR-X6Sit31yrHWY Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNSIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjYxODc3NjB9._GiPW9VtIuJ_NbBC1ajF1d3Puh9fLR-X6Sit31yrHWY" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "85fb2f9b-798f-40c0-9aec-13100007473f", "url": "/v2/events/85fb2f9b-798f-40c0-9aec-13100007473f", "created_at": "2015-03-05T19:15:59Z", "updated_at": null }, "entity": { "type": "name-1175", "actor": "guid-35b7eccb-39b6-44a6-a98c-d60aeb220d1e", "actor_type": "name-1176", "actor_name": "name-1177", "actee": "guid-4389b9f9-3b23-4deb-bcc5-8681046cd982", "actee_type": "name-1178", "actee_name": "name-1179", "timestamp": "2015-03-05T19:15:59Z", "metadata": { }, "space_guid": "5573933d-99ff-4c93-ae13-88aa8a1902a4", "organization_guid": "c6c50fe5-6477-4bbc-b9d1-f37a0b7c2e21" } }, { "metadata": { "guid": "9a527be5-7af5-466f-8396-d77ff6506500", "url": "/v2/events/9a527be5-7af5-466f-8396-d77ff6506500", "created_at": "2015-03-05T19:15:59Z", "updated_at": null }, "entity": { "type": "name-1183", "actor": "guid-04688a2d-c5ad-4a18-a0b6-680790b82ad5", "actor_type": "name-1184", "actor_name": "name-1185", "actee": "guid-3ee5e319-39f3-4867-a964-8be2fd03f7c3", "actee_type": "name-1186", "actee_name": "name-1187", "timestamp": "2015-03-05T19:16:00Z", "metadata": { }, "space_guid": "24068e6a-d7dc-47c4-bd00-da4a14b2ef92", "organization_guid": "dd294e7f-a1f6-4113-b08a-0d74b9a6a125" } }, { "metadata": { "guid": "efc25542-1205-4404-8ffd-0034ac187027", "url": "/v2/events/efc25542-1205-4404-8ffd-0034ac187027", "created_at": "2015-03-05T19:15:59Z", "updated_at": null }, "entity": { "type": "name-1191", "actor": "guid-2302e29d-9663-46ee-a226-4e1c22d08b41", "actor_type": "name-1192", "actor_name": "name-1193", "actee": "guid-4a8f1a33-5d98-465b-8eb5-04d5f2520bfe", "actee_type": "name-1194", "actee_name": "name-1195", "timestamp": "2015-03-05T19:16:00Z", "metadata": { }, "space_guid": "9015dcd9-de4d-4a42-b50f-ec20e462e35a", "organization_guid": "d09413e4-509f-4a59-8ed0-24255d8406e7" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: a6a7509e-9583-4e9e-9a0d-8245d695cc67 Content-Length: 2400 X-Content-Type-Options: nosniff