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.eyJ1c2VyX2lkIjoidWFhLWlkLTQiLCJlbWFpbCI6ImVtYWlsLTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDI2MDYzMn0.tsKZXU9kTUVcYjuL21P9OLMzLxMAnAdiTuu7cR_uB1A Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQiLCJlbWFpbCI6ImVtYWlsLTRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDI2MDYzMn0.tsKZXU9kTUVcYjuL21P9OLMzLxMAnAdiTuu7cR_uB1A" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "88785551-6d94-49a0-8590-5e01d40d3996", "url": "/v2/events/88785551-6d94-49a0-8590-5e01d40d3996", "created_at": "2015-09-30T23:30:32Z", "updated_at": null }, "entity": { "type": "name-37", "actor": "guid-f9c54830-00df-4355-8c5b-8e2aa17d5e52", "actor_type": "name-38", "actor_name": "name-39", "actee": "guid-c7f49550-fc76-4893-babc-9fcc00bbf2b4", "actee_type": "name-40", "actee_name": "name-41", "timestamp": "2015-09-30T23:30:32Z", "metadata": { }, "space_guid": "07ff8c8c-da45-4144-a5cd-ec86595c5632", "organization_guid": "ab6ca71f-18bd-4820-a6b2-5886cfc7d7f7" } }, { "metadata": { "guid": "7e5f26d6-742a-4a7b-a89f-a1d4a2c1cc5a", "url": "/v2/events/7e5f26d6-742a-4a7b-a89f-a1d4a2c1cc5a", "created_at": "2015-09-30T23:30:32Z", "updated_at": null }, "entity": { "type": "name-45", "actor": "guid-9a541e7b-3f98-495b-9628-e434ba3fd2d5", "actor_type": "name-46", "actor_name": "name-47", "actee": "guid-63ee25fd-4fd4-4e39-b6ed-11f115965175", "actee_type": "name-48", "actee_name": "name-49", "timestamp": "2015-09-30T23:30:32Z", "metadata": { }, "space_guid": "db0bee13-cc81-4121-ae03-381de0448921", "organization_guid": "7e0eb984-89b8-418b-941c-277a4b87cd21" } }, { "metadata": { "guid": "ed2b6a01-546e-4cd9-b5ca-daf03f2279dd", "url": "/v2/events/ed2b6a01-546e-4cd9-b5ca-daf03f2279dd", "created_at": "2015-09-30T23:30:32Z", "updated_at": null }, "entity": { "type": "name-53", "actor": "guid-2e7f3a51-9ff3-4ac3-9b26-c3b0d6c1666c", "actor_type": "name-54", "actor_name": "name-55", "actee": "guid-90e4c29e-0dd8-40fd-9d19-24ba0234ecf6", "actee_type": "name-56", "actee_name": "name-57", "timestamp": "2015-09-30T23:30:32Z", "metadata": { }, "space_guid": "ba1667bb-5e2c-4e81-803c-7712636a7586", "organization_guid": "68c916ff-1e93-46f6-a6f5-578ee87e3e6c" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: 4ccafba7-c029-406d-9dea-cf031d562b06 Content-Length: 2370 X-Content-Type-Options: nosniff