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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NiIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjA1MDY2NTl9.OnWiVgrJpa0-K44vAi-2kzInGBS7SRPAJSqIjItpKvo Host: example.org Cookie:
curl "https://api.[your-domain.com]/v2/events" -X GET \ -H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NiIsImVtYWlsIjoiZW1haWwtMjU1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjA1MDY2NTl9.OnWiVgrJpa0-K44vAi-2kzInGBS7SRPAJSqIjItpKvo" \ -H "Host: example.org" \ -H "Cookie: "
200 OK
{ "total_results": 3, "total_pages": 1, "prev_url": null, "next_url": null, "resources": [ { "metadata": { "guid": "3e7ec34b-eda8-4d6f-bd87-75637c8ef6f8", "url": "/v2/events/3e7ec34b-eda8-4d6f-bd87-75637c8ef6f8", "created_at": "2016-04-06T00:17:38Z", "updated_at": null }, "entity": { "type": "name-2175", "actor": "guid-3b094887-f0c9-476e-82bc-dc9584d23fd5", "actor_type": "name-2176", "actor_name": "name-2177", "actee": "guid-7d58d464-5190-485e-8289-5eff7798b52c", "actee_type": "name-2178", "actee_name": "name-2179", "timestamp": "2016-04-06T00:17:39Z", "metadata": { }, "space_guid": "15670075-f295-4bfc-ad63-126dc068f01f", "organization_guid": "73acac02-5d17-4d17-85a7-1584b23461ea" } }, { "metadata": { "guid": "ff49505b-c080-4061-92e0-7e5fffb3fcbe", "url": "/v2/events/ff49505b-c080-4061-92e0-7e5fffb3fcbe", "created_at": "2016-04-06T00:17:38Z", "updated_at": null }, "entity": { "type": "name-2183", "actor": "guid-d3adf1ee-859e-48ba-a6d6-033012e23870", "actor_type": "name-2184", "actor_name": "name-2185", "actee": "guid-8764afe6-cab7-4bd4-a5a1-a9f498cdcaf2", "actee_type": "name-2186", "actee_name": "name-2187", "timestamp": "2016-04-06T00:17:39Z", "metadata": { }, "space_guid": "8901ccd2-aca0-404b-85b2-11fb39f00a5b", "organization_guid": "187d8d26-f304-4da5-ac5b-0781852d1772" } }, { "metadata": { "guid": "dcf0d18c-f1fb-4121-8393-d692a253147e", "url": "/v2/events/dcf0d18c-f1fb-4121-8393-d692a253147e", "created_at": "2016-04-06T00:17:38Z", "updated_at": null }, "entity": { "type": "name-2191", "actor": "guid-9cd4daa2-3855-47fa-90aa-2bb77eeb1658", "actor_type": "name-2192", "actor_name": "name-2193", "actee": "guid-88e4c7cb-d7e9-43ef-8fbe-7568c90cef6e", "actee_type": "name-2194", "actee_name": "name-2195", "timestamp": "2016-04-06T00:17:39Z", "metadata": { }, "space_guid": "0b80c3ac-cb9c-4cc3-bf92-1c3e2d27db55", "organization_guid": "7080c303-6467-477e-b9d4-c4aa09fd685e" } } ] }
Content-Type: application/json;charset=utf-8 X-VCAP-Request-ID: Content-Length: 2400 X-Content-Type-Options: nosniff