Polling Data
Regularly poll Complero to receive new data.
- Events explained:
- create - Contact is seen by Complero for the first time and is created
- sync - Contact already exists and got updated with new data (originiating from the Company)
- update - Contact already exists and got updated by the Contact himself via Complero
- confirm - Contact confirmed his data as still valid
Only new events
Complero is tracking the state and each call only returns new events, since the last call made to the API.
Use latest events endpoint in order to get events that have not yet been loaded before. Please note that this endpoint will not return events that were downloaded by any of the API methods available.
Filtering
If more control is required it is possible to filter latest events by type. At the moment, filtering by types "update" and "confirm" are supported.
By default, results of types "update" and "confirm" are returned.
Get all events
It is possible to get all events, including already downloaded, using get events endpoint.
Filtering
If more control is required it is possible to filter all events by type and/or time range.
At the moment, filtering by types "update" and "confirm" are supported.
To filter events by time you can use from
and to
query parameters in a ISO 8601 UTC format.
Pagination
Get all events API endpoint supports cursor based pagination.
By default, it returns only 1000 events per page and next page can be requested by passing cursor
query parameter
with value from response header Next-Cursor
.
For convenience, response also has header Next-Link
which contains full link what can be used
for requesting next page.
Headers Next-Cursor
and Next-Link
will be present in the headers as long as next page exists.