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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzOSIsImVtYWlsIjoiZW1haWwtOTBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc4MX0.JyqKRMkBFxwsQqXr-63tJ8B8HVptHmuBrWy_h4gW6_4 Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzOSIsImVtYWlsIjoiZW1haWwtOTBAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc4MX0.JyqKRMkBFxwsQqXr-63tJ8B8HVptHmuBrWy_h4gW6_4" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "67303dcc-5716-4cc8-91d7-c24884976527", "url": "/v2/events/67303dcc-5716-4cc8-91d7-c24884976527", "created_at": "2015-07-06T23:23:00Z", "updated_at": null }, "entity": { "type": "name-465", "actor": "guid-589bd7c7-f790-46c0-b73b-fef6c8e120f4", "actor_type": "name-466", "actor_name": "name-467", "actee": "guid-c47bd457-58d8-4b9c-b591-036dad89bc99", "actee_type": "name-468", "actee_name": "name-469", "timestamp": "2015-07-06T23:23:00Z", "metadata": { }, "space_guid": "611b5b25-7384-4b9f-a6ce-52e6ff2b45ad", "organization_guid": "15ddf89a-6c01-4f0c-8ca6-afefddce4604" } }, { "metadata": { "guid": "aaef5011-326f-4424-ab59-cdeb669bf925", "url": "/v2/events/aaef5011-326f-4424-ab59-cdeb669bf925", "created_at": "2015-07-06T23:23:00Z", "updated_at": null }, "entity": { "type": "name-473", "actor": "guid-195ca288-99ce-4272-b2c7-a678b647cacb", "actor_type": "name-474", "actor_name": "name-475", "actee": "guid-ed599546-82e4-41ab-b80d-cffc07a0c7bc", "actee_type": "name-476", "actee_name": "name-477", "timestamp": "2015-07-06T23:23:01Z", "metadata": { }, "space_guid": "bfa22ddb-0f6c-4f2e-b294-b5da207f215e", "organization_guid": "78e95620-4a96-42aa-b1bd-594a2cdcb160" } }, { "metadata": { "guid": "c00752be-08bd-4352-8904-46ef5067955d", "url": "/v2/events/c00752be-08bd-4352-8904-46ef5067955d", "created_at": "2015-07-06T23:23:00Z", "updated_at": null }, "entity": { "type": "name-481", "actor": "guid-2fc4a1a7-7e74-4fab-8265-be806f273dc5", "actor_type": "name-482", "actor_name": "name-483", "actee": "guid-1db6ef4b-b03c-499f-a33d-5ae6a5bacc12", "actee_type": "name-484", "actee_name": "name-485", "timestamp": "2015-07-06T23:23:01Z", "metadata": { }, "space_guid": "1cbe0a4b-3caa-4c4c-81cb-19b4a6e0eb50", "organization_guid": "4c615f0e-43f7-45ec-85bd-c9deb79f01ef" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 437f3916-8c50-4512-b243-2b7f9da5e050 Content-Length: 2385 X-Content-Type-Options: nosniff