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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MSIsImVtYWlsIjoiZW1haWwtMTg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MDN9.4RALrPqdfL1ijMKRYxnxYtnMfvK9_PTvsDw4BH7CgOw Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MSIsImVtYWlsIjoiZW1haWwtMTg2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mzg2NDE4MDN9.4RALrPqdfL1ijMKRYxnxYtnMfvK9_PTvsDw4BH7CgOw" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "2cc565c7-18e7-4fff-8fb0-52525f09ee6b", "url": "/v2/events/2cc565c7-18e7-4fff-8fb0-52525f09ee6b", "created_at": "2015-07-27T22:43:23Z", "updated_at": null }, "entity": { "type": "name-1034", "actor": "guid-ddc7f725-c67f-4e68-8118-1ae1687f9fff", "actor_type": "name-1035", "actor_name": "name-1036", "actee": "guid-16ac41e9-c30c-45e1-b51c-226fb37e4197", "actee_type": "name-1037", "actee_name": "name-1038", "timestamp": "2015-07-27T22:43:23Z", "metadata": { }, "space_guid": "1a769af6-8ddb-4508-a35a-cc61c51fdcdf", "organization_guid": "49723c2a-a11e-43f8-971a-b34e9134ce00" } }, { "metadata": { "guid": "a82493b7-bd16-421b-aef0-d0b5c40869e8", "url": "/v2/events/a82493b7-bd16-421b-aef0-d0b5c40869e8", "created_at": "2015-07-27T22:43:23Z", "updated_at": null }, "entity": { "type": "name-1042", "actor": "guid-e68c8d10-dc83-4466-8735-9c4201166af9", "actor_type": "name-1043", "actor_name": "name-1044", "actee": "guid-d3ecb6be-c8a0-4e3b-9838-b78c58a88b65", "actee_type": "name-1045", "actee_name": "name-1046", "timestamp": "2015-07-27T22:43:23Z", "metadata": { }, "space_guid": "dbe6bbdc-0d9c-495c-abbb-0b5eb93c8494", "organization_guid": "52c7fb45-e31b-4271-9f16-8c94df30d8c7" } }, { "metadata": { "guid": "4a0e6a34-2807-44cd-a5cc-b61890662ade", "url": "/v2/events/4a0e6a34-2807-44cd-a5cc-b61890662ade", "created_at": "2015-07-27T22:43:23Z", "updated_at": null }, "entity": { "type": "name-1050", "actor": "guid-69e5e7e7-7723-4af8-a7cb-255d9a90c8db", "actor_type": "name-1051", "actor_name": "name-1052", "actee": "guid-cc1f17ce-85ab-4cc2-988b-9fca0f3a1d03", "actee_type": "name-1053", "actee_name": "name-1054", "timestamp": "2015-07-27T22:43:23Z", "metadata": { }, "space_guid": "38a2f075-fe19-4edc-8787-5571f2af7051", "organization_guid": "9160433e-860d-4251-bd6d-140187a2c5db" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 686e78d8-3479-4927-8307-9ba07704cc37 Content-Length: 2400 X-Content-Type-Options: nosniff