Source: https://docs.luxid.lu/en/api/get-events/
API version: 1.9
OpenAPI specification: https://docs.luxid.lu/luxid-partner-api.yaml
Search for events
GET/events/search
Search for user events that occured between the provided 'from' and 'to' timestamps. Format must be ISO-8601: '2018-08-17T07:00:00'. Viewed events depend on the caller of this endpoint.
Request
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
from | query | string (date-time) | Yes | The 'from' timestamp (included). |
to | query | string (date-time) | Yes | The 'to' timestamp (excluded). |
page | query | integer (int32) | No | Page number to retrieve, zero-based. Default to 0 if not provided. |
pageSize | query | integer (int32) | No | Max number of events to retrieve at once, must be > 0. Default to 10 if not provided. |
Responses
- 200
- 400
- 403
- 404
Success
Functional error
Forbidden
Not found
Response schemas
200 - Success
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
page | number (integer) | Yes | The number of this page (> 0). |
pageSize | number (integer) | Yes | The max number of items per page (> 0). |
total | number (integer) | Yes | The total number of items, on all pages (>= 0). |
items | array of object | No | |
items[].id | string | Yes | Unique id of this event. |
items[].timestamp | string (date-time) | Yes | Timestamp at which this event was generated. |
items[].type | string | Yes | Type of the event. The type defines the content of the payload. |
items[].version | string | No | Version of the event. The content of the payload may vary from a version to another. |
items[].sphere | string | No | The sphere in which the event occurred, if applicable. |
items[].subscriber | string | No | The subscriber concerned by the event, if applicable. |
items[].application | string | No | The application concerned by the event, if applicable. |
items[].subscription | string | No | The subscription concerned by the event, if applicable. |
items[].payload | object | No | The payload specific to this event type, if applicable. |
400 - Functional error
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
message | string | No | |
type | string | No |
403 - Forbidden
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
message | string | No | |
type | string | No |
404 - Not found
Content type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
message | string | No | |
type | string | No |