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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODh9.YiS0GL3cnhQsiKP3F50dAHp2orr0bIJm3aXlqSUMtTk Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODh9.YiS0GL3cnhQsiKP3F50dAHp2orr0bIJm3aXlqSUMtTk" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "42c9c90e-dd57-45d7-a361-7d7848fd382a", "url": "/v2/events/42c9c90e-dd57-45d7-a361-7d7848fd382a", "created_at": "2015-05-21T01:03:08Z", "updated_at": null }, "entity": { "type": "name-766", "actor": "guid-4d82460e-207f-4b15-a476-b517587ba7a7", "actor_type": "name-767", "actor_name": "name-768", "actee": "guid-34565336-82b0-4a3e-837d-523106ceaf8f", "actee_type": "name-769", "actee_name": "name-770", "timestamp": "2015-05-21T01:03:08Z", "metadata": { }, "space_guid": "aba075ce-eafb-4748-a6c3-9c117d7a897f", "organization_guid": "5a9953de-18ef-4cce-8f6a-b9af7bd7ea33" } }, { "metadata": { "guid": "7df03b33-cb01-464d-baa9-bcd78df73663", "url": "/v2/events/7df03b33-cb01-464d-baa9-bcd78df73663", "created_at": "2015-05-21T01:03:08Z", "updated_at": null }, "entity": { "type": "name-774", "actor": "guid-0a91f8b3-df8e-4dfa-9ded-91b5b3ea4544", "actor_type": "name-775", "actor_name": "name-776", "actee": "guid-be07dd03-b255-4596-a7c1-cdce32ab642c", "actee_type": "name-777", "actee_name": "name-778", "timestamp": "2015-05-21T01:03:08Z", "metadata": { }, "space_guid": "7d242f2c-fb74-4ed5-a9b3-47e647a9170c", "organization_guid": "2a01d043-89db-4725-a087-1c3b8f132f43" } }, { "metadata": { "guid": "5a1d0f22-fc21-4e6f-9569-bcf0dd38ef29", "url": "/v2/events/5a1d0f22-fc21-4e6f-9569-bcf0dd38ef29", "created_at": "2015-05-21T01:03:08Z", "updated_at": null }, "entity": { "type": "name-782", "actor": "guid-c8a5766c-252c-476a-81a1-39ecb711ee86", "actor_type": "name-783", "actor_name": "name-784", "actee": "guid-cc9d8841-dec2-495a-aa42-c893c8fc65ed", "actee_type": "name-785", "actee_name": "name-786", "timestamp": "2015-05-21T01:03:08Z", "metadata": { }, "space_guid": "5661af7e-db0a-493d-a4b8-d5f4324b11fd", "organization_guid": "8e4fd175-098a-4737-974b-ef5df7bf1ff5" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 32ff127d-7189-4f39-8b23-c3328d0570fd Content-Length: 2385 X-Content-Type-Options: nosniff