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.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMyIsImVtYWlsIjoiZW1haWwtMjU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTB9.OFCsTcZSOnYWwNfctKpDt50-urL-vVVy9fL4ksQ0rOs Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMyIsImVtYWlsIjoiZW1haWwtMjU0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDcxMTY4NTB9.OFCsTcZSOnYWwNfctKpDt50-urL-vVVy9fL4ksQ0rOs" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "9a21820d-aaa8-472c-b1aa-1bd6aad25e8f", "url": "/v2/events/9a21820d-aaa8-472c-b1aa-1bd6aad25e8f", "created_at": "2015-11-03T00:54:10Z", "updated_at": null }, "entity": { "type": "name-1266", "actor": "guid-cea9cc90-7851-402e-8b12-e80967b359e8", "actor_type": "name-1267", "actor_name": "name-1268", "actee": "guid-5751186b-90b2-4be0-a2db-6834a80fb63b", "actee_type": "name-1269", "actee_name": "name-1270", "timestamp": "2015-11-03T00:54:10Z", "metadata": { }, "space_guid": "f9baf96b-c4a7-4b47-9267-ab2414374aec", "organization_guid": "79940f34-2836-4cb0-9f91-e2af46d74c8a" } }, { "metadata": { "guid": "c932c384-0e94-4116-a7c3-57735de81df6", "url": "/v2/events/c932c384-0e94-4116-a7c3-57735de81df6", "created_at": "2015-11-03T00:54:10Z", "updated_at": null }, "entity": { "type": "name-1274", "actor": "guid-6451deb5-547f-4c3c-ac14-8c53928c3927", "actor_type": "name-1275", "actor_name": "name-1276", "actee": "guid-2cd0127a-477d-496a-95bd-0b00bebaae0f", "actee_type": "name-1277", "actee_name": "name-1278", "timestamp": "2015-11-03T00:54:10Z", "metadata": { }, "space_guid": "7d072aa1-a2d4-418f-acf5-69ebb3c48793", "organization_guid": "dd89c691-5563-4ac6-8ff6-9b1627689ca3" } }, { "metadata": { "guid": "93c9bd88-d619-499a-954f-c5065fd88fb5", "url": "/v2/events/93c9bd88-d619-499a-954f-c5065fd88fb5", "created_at": "2015-11-03T00:54:10Z", "updated_at": null }, "entity": { "type": "name-1282", "actor": "guid-8b543760-0d87-4b89-bb86-bdd0b00ae477", "actor_type": "name-1283", "actor_name": "name-1284", "actee": "guid-af685bae-9979-478e-9b30-3aef6cbd0b68", "actee_type": "name-1285", "actee_name": "name-1286", "timestamp": "2015-11-03T00:54:10Z", "metadata": { }, "space_guid": "88fe6026-71d6-42ad-804d-16002c412915", "organization_guid": "ef62a74d-9ffa-44bf-a5fd-607a8ec0176d" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 2e821189-c03b-4f6e-ad72-e4a73946d6bb Content-Length: 2400 X-Content-Type-Options: nosniff