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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MSIsImVtYWlsIjoiZW1haWwtMzM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMjV9.fbirW_JpqvOGhgJLeo3dKkVBmG778uZXqRTv8X1-WeA Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3MSIsImVtYWlsIjoiZW1haWwtMzM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDUzNjIzMjV9.fbirW_JpqvOGhgJLeo3dKkVBmG778uZXqRTv8X1-WeA" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "1eee1d69-788c-4a63-a616-e14be20575c8", "url": "/v2/events/1eee1d69-788c-4a63-a616-e14be20575c8", "created_at": "2015-10-13T17:32:05Z", "updated_at": null }, "entity": { "type": "name-2479", "actor": "guid-4aa01f38-7ece-49d5-bb4f-6ad5d96c3a2c", "actor_type": "name-2480", "actor_name": "name-2481", "actee": "guid-60c48754-f00c-49cd-84b4-6d31ee082031", "actee_type": "name-2482", "actee_name": "name-2483", "timestamp": "2015-10-13T17:32:05Z", "metadata": { }, "space_guid": "a9502333-6ea1-4770-80e1-b4fed99a77b3", "organization_guid": "c7268fa0-4710-4c60-9728-5601a93387e5" } }, { "metadata": { "guid": "5b5fc9ec-a6ac-4f47-ada7-a6c149c96c7d", "url": "/v2/events/5b5fc9ec-a6ac-4f47-ada7-a6c149c96c7d", "created_at": "2015-10-13T17:32:05Z", "updated_at": null }, "entity": { "type": "name-2487", "actor": "guid-7a7ce1ee-2a2d-4668-9b07-861e76b5df14", "actor_type": "name-2488", "actor_name": "name-2489", "actee": "guid-c8c0e88c-09d7-417a-a67e-48c867f66a6d", "actee_type": "name-2490", "actee_name": "name-2491", "timestamp": "2015-10-13T17:32:05Z", "metadata": { }, "space_guid": "91fda115-27bc-4768-afde-bc206804b37e", "organization_guid": "e550527c-26c9-4102-b4bd-33ee25041d07" } }, { "metadata": { "guid": "e1d1a4a6-9cc3-400a-8656-544baf83f952", "url": "/v2/events/e1d1a4a6-9cc3-400a-8656-544baf83f952", "created_at": "2015-10-13T17:32:05Z", "updated_at": null }, "entity": { "type": "name-2495", "actor": "guid-6d27e17e-c96f-44e8-808d-c02244a93506", "actor_type": "name-2496", "actor_name": "name-2497", "actee": "guid-e200eaec-a8f3-445e-9008-52a846f6281f", "actee_type": "name-2498", "actee_name": "name-2499", "timestamp": "2015-10-13T17:32:05Z", "metadata": { }, "space_guid": "2532e162-8ff4-42f7-8984-ee1e18d21d35", "organization_guid": "9b2973a3-21be-4e3b-ad03-f4206d351019" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: cc459753-b3b2-4dfd-8a2f-8a9f1c91abce Content-Length: 2400 X-Content-Type-Options: nosniff