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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMiIsImVtYWlsIjoiZW1haWwtNzBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwM30.rQQZIg4zZGzxhZ8RLxaQ0LXd9rdP3NJjzcQ4O8ZVFkU Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMiIsImVtYWlsIjoiZW1haWwtNzBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzMzk4MTEwM30.rQQZIg4zZGzxhZ8RLxaQ0LXd9rdP3NJjzcQ4O8ZVFkU" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "3ccae238-6a20-41ed-ba6b-dca48e0178a5", "url": "/v2/events/3ccae238-6a20-41ed-ba6b-dca48e0178a5", "created_at": "2015-06-04T00:05:03Z", "updated_at": null }, "entity": { "type": "name-1172", "actor": "guid-6d288325-756c-418c-9a72-745d8dcef9db", "actor_type": "name-1173", "actor_name": "name-1174", "actee": "guid-1caa01bc-7eca-42f3-8a23-1dbd49ab0d6b", "actee_type": "name-1175", "actee_name": "name-1176", "timestamp": "2015-06-04T00:05:03Z", "metadata": { }, "space_guid": "01b4ba0e-4560-412c-a788-8ad5680a483d", "organization_guid": "74ee7ef4-a83b-425a-b239-bfe05c3a12b2" } }, { "metadata": { "guid": "5878a82e-8a73-4e9e-a264-b3099a76bbf1", "url": "/v2/events/5878a82e-8a73-4e9e-a264-b3099a76bbf1", "created_at": "2015-06-04T00:05:03Z", "updated_at": null }, "entity": { "type": "name-1180", "actor": "guid-4d25fad9-240f-4962-ac03-cbfa7260b334", "actor_type": "name-1181", "actor_name": "name-1182", "actee": "guid-0b979348-e763-4b22-bbe7-cfaaf28054b3", "actee_type": "name-1183", "actee_name": "name-1184", "timestamp": "2015-06-04T00:05:03Z", "metadata": { }, "space_guid": "140ac59d-97e2-432c-b401-03bd5148da6e", "organization_guid": "893ce617-263b-41b9-bc78-6fcb97a3f116" } }, { "metadata": { "guid": "62f0321c-2929-4eb2-ae9d-d6a69411e175", "url": "/v2/events/62f0321c-2929-4eb2-ae9d-d6a69411e175", "created_at": "2015-06-04T00:05:03Z", "updated_at": null }, "entity": { "type": "name-1188", "actor": "guid-8d1c4936-6f07-4503-8ed9-171f7484604b", "actor_type": "name-1189", "actor_name": "name-1190", "actee": "guid-b34ef72a-47a0-49f1-bce1-7e6cd416735f", "actee_type": "name-1191", "actee_name": "name-1192", "timestamp": "2015-06-04T00:05:03Z", "metadata": { }, "space_guid": "5b0764c2-0f95-45d8-a918-2043982b3765", "organization_guid": "d6caec96-adb6-413b-aee6-91daa5521a98" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 47b6daaa-1213-4af5-a5bc-2e5cc32ace69 Content-Length: 2400 X-Content-Type-Options: nosniff