Events API
The Event entities are used to create events for the front end.
The events are their own entity type called FlowzEvent
, they have only one bundle called generic_event
The events entities are quite basic and only have a few fields, you can see this on the REST API
REST Endpoints
/flowz_event/{flowz_event}: GET, PATCH, DELETE
/entity/flowz_event: POST
Custom endpoints
/api/flowz-event/bundles
/api/flowz-events/{bundle}/{publicationDomain}
/api/events-list/{publicationDomain}
Bundles
This is self-explanatory, they have only one bundle called generic_event
but the endpoint returns the list of Bundles for the entity type eg:
https://indy-api-dev.brightsites.co.uk/api/flowz-event/bundles
CMS List API
The search endpoint accepts the following arguments:
Query Parameter | Description |
---|---|
q | The search query |
status | Whether the event is live or not |
limit | The number of items to retrieve |
offset | Where to start, for paging |
start | Timestamp of the start of a date range |
end | Timestamp of the end of a date range |
eg:
https://indy-api-dev.brightsites.co.uk/api/flowz-events/generic_event/independent.co.uk?q=event
WEB API
The search endpoint accepts the following arguments:
Query Parameter | Description |
---|---|
q | The search query |
id | The ID of a specific Event Entity |
status | Whether the event is live or not |
limit | The number of items to retrieve |
offset | Where to start, for paging |
start | Timestamp of the start of a date range |
end | Timestamp of the end of a date range |
eg:
https://indy-api-dev.brightsites.co.uk/api/events-list/independent.co.uk?id=3