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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0OTUzMTUxN30.PZutMMv7KwbdHTOTimBXUBQnRQYkqB3-P8kQdoyBgTo Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyNSIsImVtYWlsIjoiZW1haWwtOTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0OTUzMTUxN30.PZutMMv7KwbdHTOTimBXUBQnRQYkqB3-P8kQdoyBgTo" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "b36b9c8a-6e2b-4357-880b-de95f63db5ac", "url": "/v2/events/b36b9c8a-6e2b-4357-880b-de95f63db5ac", "created_at": "2015-11-30T23:38:37Z", "updated_at": null }, "entity": { "type": "name-633", "actor": "guid-6e493e9c-be9e-49fb-b150-e3cc01608ca8", "actor_type": "name-634", "actor_name": "name-635", "actee": "guid-a61b472e-14f3-46b2-9bb8-289feabde915", "actee_type": "name-636", "actee_name": "name-637", "timestamp": "2015-11-30T23:38:37Z", "metadata": { }, "space_guid": "bb24e121-5604-405f-ac28-bdb4cbbc58f1", "organization_guid": "3e16592a-12bd-4f0c-a4e8-3afff1f35c7e" } }, { "metadata": { "guid": "c46bde6f-f427-4e14-85d9-bec232624037", "url": "/v2/events/c46bde6f-f427-4e14-85d9-bec232624037", "created_at": "2015-11-30T23:38:37Z", "updated_at": null }, "entity": { "type": "name-641", "actor": "guid-5bc19e33-74ef-4694-b442-3e1fce8fe04b", "actor_type": "name-642", "actor_name": "name-643", "actee": "guid-ac6af999-1b5b-4d6f-8f5c-69a6c7d54cc2", "actee_type": "name-644", "actee_name": "name-645", "timestamp": "2015-11-30T23:38:37Z", "metadata": { }, "space_guid": "84f16390-5c76-4604-8db7-e4487fb1265f", "organization_guid": "a3c171dc-3cfd-4ece-b5ac-48b6933de3ce" } }, { "metadata": { "guid": "9b57aa0b-453a-4210-a613-56fc8c0467a3", "url": "/v2/events/9b57aa0b-453a-4210-a613-56fc8c0467a3", "created_at": "2015-11-30T23:38:37Z", "updated_at": null }, "entity": { "type": "name-649", "actor": "guid-57c6a730-976c-4cb3-8e5d-da9d84f52999", "actor_type": "name-650", "actor_name": "name-651", "actee": "guid-c13c4bee-be6d-4afc-99d0-08c3cb67c321", "actee_type": "name-652", "actee_name": "name-653", "timestamp": "2015-11-30T23:38:37Z", "metadata": { }, "space_guid": "a7669916-240a-42ac-aa03-a6ebc256ada1", "organization_guid": "ba5feb44-897a-4496-982b-e5733a6f27c3" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2385 X-Content-Type-Options: nosniff