94 lines
1.2 KiB
ReStructuredText
94 lines
1.2 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
======
|
|
Events
|
|
======
|
|
|
|
Lists all events and shows details for an event.
|
|
|
|
|
|
Show event details
|
|
==================
|
|
|
|
.. rest_method:: GET /v2/events/{message_id}
|
|
|
|
Shows details for an event.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- message_id: message_id_path
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- events: events
|
|
- raw: event_raw
|
|
- generated: event_generated
|
|
- event_type: event_type
|
|
- message_id: message_id
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/event-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
List events
|
|
===========
|
|
|
|
.. rest_method:: GET /v2/events
|
|
|
|
Lists all events.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- q: q
|
|
- limit: limit
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- events: events
|
|
- raw: event_raw
|
|
- generated: generated
|
|
- event_type: event_type
|
|
- message_id: message_id
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/events-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|