Retrieve list of events

Retrieve a list of a device's events in a given time range. The retention period for events is thirty days.
If multiple events are generated with the same timestamp, to the second, and the same media type, the media file from the last request is used for all of them. To have different media files for each virtual event, use timestamps that differ by at least a second.
The maximum period between start and end must be less(or equal) than 31 days.

Request
Security:
bearerAuth
path Parameters
imei
required
string (IMEI)

The IMEI of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: 357660101000198
query Parameters
start
required
string <date-time> (Start date and time)

Filter by a start date and time, in ISO 8601 format.

Example: start=2020-01-01T14:48:00.000Z
end
required
string <date-time> (End date and time)

Filter by an end date and time, in ISO 8601 format.

Example: end=2020-01-01T14:48:00.000Z
status
string (eventStatus)

Filter by the event status

Enum: "new" "resolved"
limit
string^([1-9]|[0-9][0-9]|1[0-9][0-9]|200)$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=199
offset
string^[0-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/devices/{imei}/events
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/devices/:imei/events?start=2020-01-01T14%3A48%3A00.000Z&end=2020-01-01T14%3A48%3A00.000Z&status=new&limit=199&offset=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}