Surfsight API changelog

C4 May 2024

New features and enhancements

New user without access to media

SUR-7176

A new user access level has been created to allow users to view information without access to media. This user level, Editor without media access, can be assigned in the Partner Portal.

New parameter for ADAS calibration status

SUR-6338

In the GET/device-health API call, the new parameter adasCalibrationCompleted returns the status of ADAS calibration for devices in an organization. Response 1 is for calibrated devices, and null is for non-calibrated devices.

Retrieve auxiliary camera connectivity status in health report

SUR-7223

The API call GET/device-health now returns auxiliary camera connectivity status information in a new object, auxiliaryCameras.

{
    "data": [
        {
            "imei": "Aragorn's car",
            "status": 1,
            "name": "357660101000198",
            "organizationId": 17,
            "partnerId": 1,
            "lastConnectedAt": "2024-04-16T11:12:25.422Z",
            "lastRecordingUpdatedAt": "2024-04-16T10:56:41.000Z",
            "lastRecordingHealth": true,
            "subscriptionId": null,
            "calibrationCompleted": true,
            "auxNum": null,
            "dataUsageReceivedAt": "2024-04-16T10:56:49.000Z",
            "lastSwitchedToRecordingUnhealthyAt": "2023-09-03T17:36:11.000Z",
            "auxiliaryCameras": [
                {
                    "id": 51,
                    "lastConnectedAt": "2024-04-16T10:58:05.000Z"
                },
                {
                    "id": 52,
                    "lastConnectedAt": "2024-04-16T09:42:51.000Z"
                }
            ],
            "sdCardFreeSpace": "12510240KB",
            "sdCardTotalSpace": "124821728KB",
            "adasCalibrationCompleted": false
        }
    ],
    "metadata": {
        "count": 1
    },
    "requestId": "28b13b4d-2423-4f4c-83f0-282eae3e9995"
}

Updates to API reference documentation to clarify webhook configurations

SUR-7074

Changes were made to the API reference documentation for the PUT/organizations/{orgId}/webhooks and POST/organizations/{orgId}/webhooks API calls, to clarify webhook configurations for specific webhook updates. For more information, see: Replace webhooks subscription devices and Add device to webhook subscription.

Partners can review all actions performed on their devices in the audit log

SUR-7151

Partners can retrieve information about all changes to their devices that are made through an API call or the Surfsight Portal. Until today partners only retrieved actions done with their own token, going forward partners can see actions by all users.

The API call GET/audit-logs has been updated to filter and return information for the following new parameters:

• entity - ID of the entity that was changed
• entityType - type of entity that was changed, whether a device, an organization, a partner, or a user
• entityPartnerID - the partner the entity is associated with
• entityOrganizationID - the organization the entity is associated with

Device configuration changes made in the Partner Portal are added to the audit log

SUR-7156

All device configuration changes performed in the Partner Portal are recorded to the audit log. These changes as well as the user who was logged in to the Partner Portal at the time of the changes are returned with the API call GET/audit-logs.

Audit log records user information for changes

SUR-7318

Partners can retrieve information about the user that performed changes recorded in the audit log. The API call GET/audit-logs now returns the userId for any action. Since the same userId can be assigned to a partner or user, a new parameter, userType, allows partners to filter the results based on the desired user type, whether partner or user.

Fixed items

Documentation updates

Known issues

C3 March 31, 2024

New features and enhancements

New API endpoint to retrieve WiFi password

SUR-7078

A new randomized Wifi password is automatically generated when a hotspot is enabled for the first time on a device. A new API call, POST /devices/wifi-password has been created to retrieve this password.

This increases security when auxiliary cameras are connected to the AI-12 dashcam. Only partners are able to use this call to retrieve the new password. Available only in devices with firmware version 3.12.202 or above.

Changes to the device billing status are recorded in the audit log

SUR-7126

Changes to the device billings status initiated in the Partner Portal are recorded in the audit log.

Device and event configuration changes to be added to the audit log

SUR-6991

Device and event configuration changes made through the Surfsight Portal are now available in the audit log, under the same user information used to log into the Surfsight Portal.

Group column added to the health report CSV attachment

SUR-6953

In the Devices Health area, when a health report is downloaded, there is a column listing the group a device is a associated with.

Event name added to the subject line of event and alert notification emails

SUR-6456

In event and alert notification emails, the type of event is now listed in the subject line of the email.

Fixed items

Documentation updates

C2 March 2024

New features and enhancements

New API endpoints to set and retrieve device billing status

SUR-5993

:::Info Note

Changing the billing status may result in additional fees. For more information see an upcoming article about billing in the Developer Portal, or contact your partner success manager.

:::

Users with partner level permission can set devices' billing status with the API calls PUT /devices/{imei}/billing-status/{billingStatus}for individual devices and PUT /devices/billing-status/{billingStatus} for devices in bulk.

To retrieve billing status information for individual devices or devices in an organization use the new API calls GET /devices/{imei}/billing-status or GET /organizations/{orgId}/devices/billing-status, respectively.

Partners can subscribe to the new system message webhook, deviceBillingStatus, for notification of billing status changes for each device.

Changes to billing statuses do not affect device data or a device's organization association.

Automated billing for auxiliary cameras and related updates by API call or webhook

SUR-6661

If a factory reset is performed from a device, the data profile configuration will be restored from the saved cloud configuration. Data usage itself will be reset and not sent again from the cloud.

New API endpoint to request all event file links in an array

SUR-6970

The new GET/devices/{imei}/event-file-links API call returns an array of media file links. Optional parameters include filetype to filter by video or snapshot, and cameraId. If cameraId is left blank all files are returned by default.

{
    "data": {
        "urls": [
            {
                "cameraId": 1,
                "url": "http://s3bucket.aws.com/abcdefg"
            },
            {
                "cameraId": 2,
                "error": "Requested file was either not found or uploaded yet"
            },
            {
                "cameraId": 52,
                "error": "Camera does not exist"
            }
        ]
    }
}

Deprecated endpoint DELETE /organization/{orgId} to be removed

SUR-6418

The API call DELETE /organization/{orgId} is being removed. The API call DELETE /organizations/{orgId} was previously added to the Developer Portal to replace it. Adding the s at the end of the organization keeps the call consistent with other Organizations API calls.

The DELETE /organization/{orgId} will be removed with the deployment on March 3, 2024. Users should use the DELETE /organizations/{orgId} API call to avoid problems with their integration.

This change may impact your use of the API service.

Documentation updated to reflect password requirements

SUR-6927

Password-related endpoint descriptions were updated to reflect validated password requirements which necessitate at least eight characters per password, including one upper-case letter, one lower-case letter, and one number. Possible characters include letters, numbers, and special characters. Updated endpoints are listed in the Documentation updates, below.

Audit log additions to help track configuration changes

The following bulk actions have been added to the audit log to keep track of details regarding each action. Single updates are already logged. For more information, see Audit logs.

• Bulk updates
• Factory reset
• Device name change
• Assign or remove a device from a sub-partner
• Updated SD card recording retention time

Fixed items

Documentation updates

C1 February 2024

New features and enhancements

Auxiliary camera information added to the GET /devices/{imei}/telemetry response

SUR-5931

Telemetry information has been added to the GET devices/{imei}/telemetry API response in the new auxCameras parameter. Information is retrieved for all connected auxiliary cameras. The following is an example of the telemetry response:

{
  "data": {
    "firmwareVersion": "3.9.53",
    "deviceModel": "AI-12",
    "lastSeenOnline": "2020-01-01T14:48:00.000Z",
    "simNetworkType": "4G",
    "simOperator": "Cellcom IL",
    "simState": "ready",
    "simNumber": "12345678",
    "calibrationCompleted": true,
    "sdCardInserted": true,
    "sdCardCapacityBytes": 127817449472,
    "sdCardFreeBytes": 46724284416,
    "adasCalibrationReady": true,
    "adasCalibrationCompleted": true,
    "wifiEnabled": true,
    "wifiConnected": true,
    "wifiSignalLevel": "-50",
    "auxCameras": [{"camera_id":52,"model":"C6F0SeZ3N0PcL2","fw_version":"V11.1.22.6.3-20200313","ip_address":"http://192.168.43.165","state":"connected","sd_status":"Ready","sd_free_space":"1866176 KB","sd_total_space":"62352448 KB"},{"camera_id":51,"model":"C6F0SeZ3N0PcL2","fw_version":"V11.1.22.6.3-20200313","ip_address":"http://192.168.43.69","state":"connected","sd_status":"Ready","sd_free_space":"3030112 KB","sd_total_space":"62352448 KB"}]
  }
}

New metadata parameters added to the GET /device-config API call response

SUR-6215

The parameters source, status, and time attributes have been added as metadata to the response of the GET /device-config API call.

• The source parameter states whether the data was retrieved from the device, or if the data was taken from the cloud. If the device is offline, data is retrieved from the last configuration in cloud.
• The status parameter states whether the device is online, offline, or in standby mode.
• The time parameter states when the data was retrieved. If the device is online, the time listed is when the data is retrieved from the device. If the device is offline, the time listed is the last configuration in the cloud.

 },
  "metadata":{
    source:"cloud/device",
    status:"online/offline/standby",
    time: "2022-02-16T07:14:00.000Z // ISO format, in UTC
  }
}

Parameter added to the GET /organizations/{orgId}/webhooks API call to filter by IMEI number

SUR-6557

When requesting organization webhooks with the GET /organizations/{orgId}/webhooks API, partners can use the new optional parameter, imei, to filter by device IMEI number and retrieve only the webhooks for that device. If this parameter is not included in the API call, the response will include all devices, as usual.

New parameters added to the GET /device-health API call response

SUR-6765

The objects calibrationCompleted and auxNum are now returned in the response to theGET /device-health API call.

• calibrationCompleted describes the acceleration calibration state with responses true for calibrated, and null, for not calibrated.
• auxNum lists the number of connected auxiliary cameras. If no number is available the response is null.

Increased number of user contacts

SUR-5305

Partners can now create up to 100 users using thePOST /partners/{partnerId}/contacts API call.

Update to the description in the PUT /devices/{imei}/device-config API call

SUR-6799

The description for the recordingEncryption parameter in the PUT /devices/{imei}/device-config call has been updated to clarify the requirements for the recording encryption key.

Updated descriptions about media files for events created at the same time

SUR-6832

The following information was updated in introductory descriptions in several API calls:

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.

For a list of the updated API descriptions see the Documentation updates below.

New endpoint DELETE /organizations/{orgId} added to replace DELETE /organization/{orgId}

SUR-6885

The API call DELETE /organizations/{orgId} was added to the Developer Portal because the API call DELETE /organization/{orgId}, is being deprecated. The addition of the s at the end of organization keeps the call consistent with other Organizations API calls.

The DELETE /organization/{orgId} will be removed with the deployment on March 4, 2024. Users should use the DELETE /organizations/{orgId} API call to avoid problems with their integration.

Fixed items

Documentation updates

E23-24 January 2024

New features and enhancements

New option to request all media files, or multiple files, for an event with a single API call

SUR-6323

When retrieving media files from either the GET/devices/{imei}/event-file-link or GET/devices/{imei}/cameras/{cameraId}/snapshot API calls, users can now request all the media files, or multiple media files, associated with an event with one API call. Making a request with the parameter cameraId=0 requests files from all cameras, including both in-cabin-facing and road-facing lenses. The cameraIds parameter can be used to specify files from multiple lenses when the parameter cameraId==0.

Partners can choose to receive additional webhook notifications for alarm status

Partners can opt-in to receive additional webhook notifications for alarm status when they enable the subscribeForAlarmUpdates parameter in the following calls: POST/organizations/{orgId}/webhook-settings, POST/organizations/{orgId}/webhooks, and PUT/organizations/{orgId}/webhooks.

By default partners are opted out. When opted out, partners receive webhook notifications for alarm creation only. By opting in, partners receive additional alarm webhook notifications when alarms are closed as well.

New webhook notification for closed alarm status

SUR-6714

If partners have opted in to receive additional webhook notifications about alarm status, they receive additional information in the payload including that an alarm was closed.

When enabled, the GET/organizations/{orgId}/webhooks call returns the following additional information in the payload:

{
    "type": "alarms",
    "data": {
        "id": 26588,
        "imei": "357660102684628",
        "name": "357660102684628",
        "organizationId": 100021718,
        "organizationName": "Org&",
        "details": "",
        "alarmDefinitionCode": "133",
        "createdAt": "2023-12-24T11:03:03.000Z",
        "alarmDefinitionId": 1,
        "alarmDefinition": {
            "id": 1,
            "severity": 30,
            "hierarchy": 20,
            "code": "133",
            "name": "SD Card is not mounted, the camera is not recording video",
            "recommendation": "Reboot Camera, if the SD card is still not recognized, try formatting the SD card or replacing it",
            "createdAt": "2020-06-08T11:16:47.000Z"
        },
        "alarmStatus": 0,
        "userId": 1142,
        "userEmail": "joe@surfsight.com"
    }
}

• alarmStatus=0 for created alarms and 1 for a closed alarm.
• userId=0 for actions performed by the system, such as an opened alarm, or when an alarm is automatically closed. Auser_id is provided when an alarm is closed manually by a user.
• userEmail is a string that contains the user email address, or is empty if the action was performed by the system.

New parameters to receive device counts for devices pending activation and locked

SUR-5772

When retrieving information from the GET/partners/operational-statistics call, partners can now retrieve device counts for the parameters pendingActivation and locked, in addition to activated and deactivated currently available. The count for deactivated devices is a combination of the devices that are pending activation and locked.

Webhook ID included in the response to POST/organizations/{orgId}/webhooks call

SUR-6556

When adding a device to a webhook subscription, webhookId is now included in the response to the POST/organizations/{orgId}/webhooks call.

{
    "webhookId": 217,
    "requestId": "df5fg-45fgfdsg-45fg-45454"
}

Fixed items

Documentation updates

E21-22 December 2023

New features and enhancements

Lytx Conceal Service blurs images in media files

The Lytx Conceal Service blurs license plates, as well as faces of drivers, passengers, and passersby on event media files that are stored in the cloud. It is available through the API service only.

This cloud service is available through the optional parameter, conceal=true, in the API call GET/devices/{imei}/event-file-link. The feature can be applied to media that has been generated from all lenses, including the road- and in-cab facing lenses of the dash cam and auxiliary cameras.

As part of the initial release, the Lytx Conceal Service is available only for video clips and snapshots captured as triggered events. Lytx Conceal Service is available for reseller partners connected to the EU cloud.

The blurredMediaAvailability parameter has been added to responses to GET/devices/{imei}/events, GET/devices/{imei}/events/{eventId}, and POST/organizations/{orgId}/events API calls to determine if blurred media is available. Responses true and false indicate that the media is available or not available, respectively.

Furthermore, the new parameter, blurredMediaAvailable, has been added to the events webhook structure to notify partners when media is available for a new event. Responses true and false indicate that the media is available or not available, respectively.

Simulated Alarms capability

SUR-6652

New POST /devices/{imei}/alarm-simulator API call allows users to create simulated alarms. Users may perform all operations on this alarm, as if it was a regular system generated alarm. Metadata in the request can be used to explain what is being tested, and is automatically included as a comment.

Alarm details are available through the GET/alarms, and GET/alarms/{alarmId} API calls.

Clear error message when using invalid code for adminPin or driverPin

SUR-5917

When sending a PUT /device-config API call using 4121 as adminPin or driverPin, a new error message clearly states that this code is not valid in these cases, and to choose another code.

Apply organization profile to settings following firmware version update

SUR-6074

When a firmware version is updated in a device, a new workflow automatically applies the organization settings that are relevant to the new firmware version. This maintains device and event settings as configured prior to the firmware change and adds the supported organization settings for the new version. Updates are recorded in the audit log.

Opt out of the 'mediaAvailable' webhook

SUR-6559

Partners can choose to opt out of the mediaAvailable webhook notification. Opting out removes the mediaAvailable parameter from the Eventwebhook notification, and produces only one webhook per event.

Fixed items

Documentation updates

E19-20 November 2023

New features and enhancements

Validation of dataType in event configurations

SUR-6292

The following events only allow text for data type, the dataType parameter none. Until now trying to configure the event to snapshot or video was ignored and did not return an error. From now on, the wrong dataType will result in an error code 400 and message.

This applies to the following events for the PUT /devices/event-config, PUT /devices/{imei}/event-config, and POST /organizations/{orgId}/event-settings API calls:

• accOff
• accOn
• geoFence
• speedLimit

These changes may impact your use of the API service.

Fixed items

Documentation updates

E17-18 October 15, 2023

New features and enhancements

Retrieve mediaFileAvailability parameter in API calls requesting event information

SUR-6419

The mediaFileAvailability parameter has been added to responses to GET/devices/{imei}/events, GET/devices/{imei}/events/{eventId}, and POST/organizations/{orgId}/events API calls to determine if media is available. Responses True and False indicate that the media is available or not available, respectively.

Create a virtual event without media

SUR-6289

A new mediaType option, none has been added to the POST/devices/{imei}/virtual-event API call. Sending none in this parameter, creates the virtual event with no media.

Fixed items

E15-16 October 1, 2023

New features and enhancements

Configure video and snapshot media for standbyEnter and standbyExit events.

SUR-6282

Video and snapshot data types can be configured for Entering standby and Exiting Standby events through the PUT/devices/{imei}/event-config, PUT/devices/event-config, and POST/organizations/{orgId}/event-settings API calls. The three options for dataType are none for text only notifications, video to record a video event, and snapshot to receive a snapshot of the event with timestamp. When a video event is selected, the recording for the standbyEnter event is recorded for ten seconds before the event, and the recording for the standbyExit event is recorded for ten seconds after the event.

New webhook type to receive system notifications.

The new webhook type, systemMessagesWebhook, has been added to the POST /organizations/{orgId}/webhook-settings call. This enables partners to be notified of two new messages:

SUR-5953

The message type dataProfileLimit sends a notification when a configurable data profile limit has been reached. The dataProfileLimit can be configured to send notification when the data usage is between 10% to 100% of the data profile limit. The default is 90%.

Supported data profile limits include: Total bandwidth, Live video minutes per month, Video events per day, Video events per month, and Recording video minutes per month.

If the configured limit is reached, a message is sent to the webhook URL to warn that the configured limit for that data profile has been reached.

SUR-6453

The message type deviceStatus sends a notification with each status change for a device. Updates are sent when a device status changes to offline, online, or standby modes.

The new webhook type is also available in the calls GET /organizations/{orgId}/webhooks, PUT /organizations/{orgId}/webhooks, and POST /organizations/{orgId}/webhooks.

Webhook message when media file is ready

SUR-6322

The new parameter, mediaAvailable, has been added to the events webhook structure to notify partners when media is available for a new event. Responses True and False indicate that the media is available or not available, respectively. If multiple files are involved, such as recordings from both road-facing and in-cabin lenses, or auxiliary cameras, a new message will be sent for each media file when it becomes available.

{
    "type": "event",
    "data": {
        "id": 7306791,
        "serialNumber": "357660101039543",
        "eventType": "cell_phone_use",
        "time": 1634797394,
        "lat": 32.1763837,
        "lon": 34.92067202,
        "alt": 54.01348876953125,
        "speed": 32.580000686645505,
        "other": "",
        "files": [
            {
                "cameraId": 1,
                "file": 1634797394,
                "fileType": "video", 
                "mediaAvailable":true
            },
            {
                "cameraId": 2,
                "file": 1634797394,
                "fileType": "video",
                "mediaAvailable":false
            }
        ]
    }
}

Posted speed data is available by webhook

SUR-6065

Three parameters, postedSpeed, postedSpeedHgv, and postedSpeedTrailer are now sent in the payload of the GPS webhook.

{
  "id": 284785715,
  "serialNumber": "357660101039543",
  "time": 1634716401,
  "lat": 32.16427726,
  "lon": 34.9046395,
  "alt": 64.57598876953125,
  "speed": 1.7200000286102295,
  "postedSpeed": 100,
  "postedSpeedHgv": 100,
  "postedSpeedTrailer": 100,
  "accuracy": 1.2160000801086426
}

More accurate error message for POST/devices/{imei}/virtual-event API call when a device is offline

SUR-6325

When sending POST/devices/{imei}/virtual-event API call, and the time requested is out of retention period, the error message returned states "The time parameter is out of range according to the retention period configured for the device organization.", even when the device is offline, rather than only stating the device is offline.

Fixed items

Documentation updates

E13-14 August 2023

New features and enhancements

New endpoint to delete organizations from a partner account

SUR-4314

The new API call, DELETE /organization/{orgId}, allows partners to delete organizations they are not using from within their accounts. Only empty organization are able to be deleted.

Documentation updates

E11-12 July 2023

New features and enhancements

Added validation to POST /virtual-event API call.

SUR-6198

Due to a new more stringent validation process, when using the POST / virtual-event API call, the service will verify that the requested event date is within the organization retention period. If the date is not within this time period, an error will be returned. The error code will be 400 and the error message will be: The time parameter is out of range according to the retention period configured for the device organization.

Set device data profile with new API endpoints

SUR-4658

New endpoints have been added to set device data profiles. Users can configure settings for a single device, in bulk and at the organization level. Only a partner token will be able to set the profile.

• PUT /devices/{imei}/data-profile/{dataProfileId} to set the device data profile.
• PUT /devices/data-profile/{dataProfileId} to set data profile for devices in bulk.
• PUT /organizations/{orgId}/devices/data-profile/{dataProfileId} to sets the data profile for the organization's devices.
• The parameter dataProfileID is available for retrieving information.

Add rejection reason to POST /organizations/{orgId}/bulk-devices responses

SUR-6105

When attempting to add a device through the POST /organizations/{orgId}/bulk-devices API call, if a device is rejected there are new responses to indicate the reason for the rejection. The following error messages have been added to the responses to POST /organizations/{orgId}/bulk-devices:

• 1000 - Group not found;
• 1001 - Device already assigned;
• 1002 - IMEI not found;
• 1003 - Device locked;
• 1004 - Failure in ai-14 authorization.

Added organization actions to Audit log

SUR-5785

The following actions are added to the audit log to keep track of details regarding each action. For more information, see Audit logs.

• Add organization
• Update organization
• Update organization settings
• Update default device settings
• Update default event settings
• Update device webhook settings

Fixed items

Documentation updates

E9-10 June 2023

New features and enhancements

User IDs are added to all API calls in the audit log API

SUR-5307

Now a user ID will be associated with each API call in the audit log API.

The Recording streaming reusable component has new and enhanced functionality

SUR-5801

We have added new functionality to the recording streaming reusable component, making it more intuitive and easy to operate. Enhancements include:

• New input allowing users to select a specific time on the timeline, similar to moving the cursor across the timeline. This is configurable using the new time-selection parameter.
• Trips can be displayed on the timeline. This is configurable using the new trips parameter.

• Events can now be displayed on the timeline. This is configurable using the new events parameter. Event visualizations include:

  • events displayed on the timeline according to the time they occurred;
  • events displayed with an icon configurable for color, icon, and name, using the new event-config-src parameter;
  • when hovering over the icon, it expands to show the name and timestamp;
  • clicking on the event opens the event media reusable component, if enabled using should-open-event parameter;
  • if there are multiple events and not enough room to display them all, the event will show an icon with a number of events. Clicking this icon opens a dropdown with all the event names and links.

For more information, see Recording timeline component.

Fixed items

Documentation updates

E7-8 May 2023

New features and enhancements

New sdCardFormatted event

SUR-6087

In devices with firmware 3.11.25 or above, each time the SD card is formatted, through the device, or the GET /devices/{imei}/format-storage API call, the sdCardFormatted event is triggered and the SD card receives a new UUID, a unique identifier.

In the GET /devices/{imei}/events/{eventId}, GET /devices/{imei}/events, and POST /organizations/{orgId}/events API calls, as well as webhook, the response will include the new event, manufacturer information, and the UUID assigned to the most recent format.

Fixed items

Documentation updates

E5-6 April 30, 2023

New features and enhancements

Add new calls for bulk and organization data usage

SUR-5568

The new POST /devices/bulk-data-usage call returns an array with the data usage for a list of selected IMEIs for up to 100 devices per call.

The new GET /organizations/{orgId}/devices-data-usage call returns an array with the data usage for all the devices in an organization. Default pagination is 100 devices per page with a maximum of 200 devices per page.

These calls do not return Twilio data. For Twilio data, use the GET /devices/{imei}/data-usage call to retrieve data usage for each device.

Recording timeline reusable component

SUR-5681

Using our new recording timeline reusable component, you can now quickly and easily integrate our frontend features inside your application, while keeping your code reliable and consistent across different places and use cases. The recording timeline component shows available recordings in a timeline, enabling selecting, playing, and downloading recordings from a device that is online, or in standby mode. Our reusable component includes in-depth step-by-step guides. For more information, see About reusable components.

The components are reusable, meaning they can be implemented in multiple places inside the platform, eliminating the need to develop and maintain them all. They are configurable based on a list of variables, and their abilities can be extended by adding extra code.

The reusable components are designed to:

• make the integration process easier and faster
• reduce the amount of development resources necessary for integration

Developers can integrate by linking to the cloud, or alternatively embedding the component package within the partner's environment.

New webhook URL parameter for alarms

SUR-5810

A new webhook alarm URL parameter, alarmsWebhookUrl, has been added to the POST /organizations/{orgId}/webhook-settings call. This parameter enables partners to receive device related alarms and react accordingly. This parameter is also available in the calls GET /organizations/{orgId}/webhooks, PUT /organizations/{orgId}/webhooks, and POST /organizations/{orgId}/webhooks.

New event parameters have been added to the Organization settings options

SUR-5874

The events laneWeaving and qrCode have been added to the POST /organizations/{orgId}/event-settings call for all devices in an organization.

Increased range for tailgating parameters

SUR-5909

The maximum time for the headwayAlertDayThreshold and headwayAlertNightThreshold parameters have been increased to 15,000 milliseconds. These parameters can be found in the API calls PUT /devices/{imei}/event-config, PUT /devices/event-config, and POST /organizations/{orgId}/event-settings.

Fixed items

Documentation updates

E3-4 April 2023

New features and enhancements

Add liveVideoTimeoutSeconds parameter

SUR-5749

The new liveVideoTimeoutSeconds parameter enables users to set the amount of time a live video plays before ending automatically. Users can choose a time frame of 30 seconds or more.

Fixed items

{
 "data": {
  "receivedAt": "2022-11-17T14:36:04.968Z",
  "mobileTx": 60449320,
  "mobileRx": 118809561,
  "liveStreamingUsage": 0,
  "usageEventsTodayDay": 0,
  "usageEventsTodayMonth": 0,
  "liveStreamUsageMilli": 0,
  "recordStreamUsageMilli": 0,
  "recordStreamingUsage": 0,
  "recordingsUploadUsage": 0,
  "eventsUsage": 0,
  "billingDayOfMonth": 1,
  "mobileProvider": {
    "carrier":"twilio",
    "uniqueName": "Lytx Fleet",
    "dataLimit": 2000,
    "dataUsage":{
      "dataTotal": 100,
      "dataUpload": 90,
      "dataDownload": 10,
      "period":{
        "startTime": "2022-11-01T00:00:00Z",
        "endTime": "2022-11-17T14:36:04.968Z"
        }
      }
    }
  }
}

Documentation updates

E1-2 February 2023

New features and enhancements

New event for device activation

SUR-5752

An event, deviceActivation, is now triggered when a device is activated. This event is available in any calls where events are retrieved and via webhook.

Fixed items

Documentation updates

E24-25 January 2023

Fixed items

E22-23 November 2022

No changes in this release.

E20-21 October 2022

New features and enhancements

Event media reusable component

SUR-5197

Using our new event media reusable component, you can now quickly and easily integrate our frontend features inside your application while keeping your code reliable and consistent across different places and use cases. The event media component enables playing video or showing snapshots of an event from a specific device. Our reusable component includes in-depth step-by-step guides.

The components are reusable, meaning they can be implemented in multiple places inside the platform, eliminating the need to develop and maintain both. They are configurable based on a list of variables, and their abilities can be extended by adding extra code. Additionally, if the component appears in several places inside an application, a developer can copy the component to additional places in the project, configuring different functionality and appearance for each place separately.

The reusable components are designed to:

• make the integration process easier and faster
• reduce the amount of development resources necessary for integration

Developers can integrate by linking to the cloud, or alternatively embedding the component package within the reseller partner's environment.

Fixed items

Documentation updates

E18-19 October 2022

New features and enhancements

Tailgating

SUR-5526

The headwayAlertTime parameter is the amount of time during which a vehicle continuously drives too closely to the vehicle in front of it. We increased the maximum value from 5,000 to 60,000 milliseconds.

Fixed items

Documentation updates

E16-17 September 2022

New features and enhancements

Increased limit for purge days

SUR-5327

Purge limit has been increased from 120 to a maximum of 366 days. The enhancement requires a commercial agreement. Please contact your account manager for more information.

Users with administrator permissions can now access device metadata

SUR-5115

Once a device is added to an organization, users with administrator permissions can now access device metadata via GET /devices/imei/ API call.

E14-15 August 2022

New features and enhancements

Live Video reusable components

Using our new Live Video reusable componnent, you can now quickly and easily integrateour frontend features inside your application while keeping your code reliable andconsistent across different places and use cases. Our reusable component includes in-depth step-by-step guides.

The components are reusable, meaning they can be implemented in multiple places insidethe platformeliminating the need to develop and maintain both., they are configurablebased on a list of variables, and their abilities can be extended by adding extra code.Additionally, if the component appears in several places inside an application, a developercan copy the component to additional places in the project, configuringdifferentfunctionality and appearance for each place separately.

The reusable components are designed to:

• make the integration process easier and faster
• reduce the amount of development resources necessary for integration

Developers can integrate by linking to the cloud, or alternatively embedding thecomponent package within the reseller partner�s environment.

Enable Organization settings profile

SUR-4275 and SUR-5263

API calls now include the new isOrganizationProfileEnabled parameter forenabling and disabling the Organization settings profile. When turned on, all new devices are automatically configured with this profile when added; when turned off, devices that are newly added to the organization do not get the configuration from this profile.

To toggle the profile on and off, use the new boolean parameter for the patchOrganization API call. In addition, the getOrganization call response now includes the current value for the parameter. The parameter default is enabled.

Fixed items

Documentation updates

E12-13 July 2022

New features and enhancements

Enter and exit standby events

SUR-4711

Two new events, Entering standby and Exiting standby, are now available as text notifications, without video or a snapshot attached. GPS information is included in these events.

These events are triggered when a dashcam that is connected to constant power enters or wakes up from standby mode.

Users can configure this setting for single devices, in bulk and from the Organization level using the 'devices/{imei}/events' API endpoint.

Fixed items

Documentation updates

E11 June 2022

New features and enhancements

Speed profile

Trips now include speed profiles as part of their metadata. Speed profiles can be retrieved as part of the API /devices/{imei}/gps call, which now includes the following new parameters:

• postedSpeed - when available, the general speed limit for most vehicles that is posted at the specific geographical point, in meters per second.
• postedSpeedTrailer - when available, the speed limit for trailers that is posted at the specific geographical point, in meters per second.
• postedSpeedhvg - when available, the speed limit for heavy goods vehicles that is posted at the specific geographical point, in meters per second. , displaying a line graph of:
• vehicle driving speed

Throughout the course of every active trip, the dashcam uploads the GPS location to the cloud every five (5) seconds. When posted speed limit is available for the recorded GPS point, the vehicle driving speed and the posted speed limit are also stored with the trip at that GPS point, in addition to the latitude, longitude and other trip-related data.

Managers can leverage this data to review a driver's driving behavior, analyze trends, and enforce organizational policies.

Documentation updates

E10 May 2022

New features and enhancements

Retrieve drivers via organization

As part of the newly released driver service, the 'GET /drivers/org={org}' call enables reseller partners and organization administrators to easily retrieve a specific driver using the organization ID. Users with multi-partner tokens can also use this to find drivers in different organizations.

New parameter in data usage API call

The 'GET /v2/devices/imei/data-usage' call now returns a billingDayOfMonth parameter. This makes it easier for reseller partners and fleet managers to keep track of monthly data billing cycles.

Fixed items

The following table lists the items that we fixed for this release:

Document change log

The following table lists the documents that were updated and or added to the Developer Portal:

E9 May 2022

New features and enhancements

Driver service endpoint

The Surfsight driver service is a set of new features (and enhancements to previous soft launches) that allow fleets with multiple drivers who often share the same vehicles, to associate trip data and events to the relevant driver. Integration with the Driver API endpoint enables:

Driver calls can be accessed via https://api-prod.surfsight.net/v2/drivers. With this endpoint, organization administrators can:

• Create new drivers in an existing organization
• Assign a driver to a dashcam prior to a trip, and retroactively (for a selected time period)
• Un-assign a driver from a dashcam
• Request the driver metadata in response to existing calls to retrieve trips or events
• Retrieve the driving history of a specific dashcam, driver, or vehicle from a specified time range
• Edit drivers for a specified organization
• Delete drivers for a specified organization

E8 May 2022

Features

Partners managing all devices

In an organization with devices from multiple reseller partners, reseller partners can now make calls that include any of those devices.

This makes it easier for multiple reseller partners who work on devices for a single organization to assist fleet managers in managing that entire organization.

Shared access to an existing organization

The exclusivePartnerOnly parameter is now included in the PATCH /organizations/{orgId} call. This enables reseller partners to enable or disable shared access to an existing organization, making it easier to update organizations as the needs of a fleet manager evolve.

When disabling shared access, reseller partners must first remove all devices from the reseller partner that will no longer be part of that organization.

Fixes

E7 April 2022

Features

Factory reset call

The new POST /devices/{imei}/factory-reset call enables partners and organization administrators to reset a device to its factory settings. If the device is offline, it is reset when it comes back online.

Organization profiles

Organization administrators and supervisors can now create organization profiles for organizations with devices from multiple partners with the following calls:

• POST /organizations/{orgId}/device-settings
• POST /organizations/{orgId}/event-settings
• POST /devices/{orgId}/webhook-settings

New standby events

Two new events, standbyEnter and standbyExit, are now available as text notifications, without video or a snapshot attached.

These events are triggered when a device that is connected to constant power enters or wakes up from standby mode.

New external users call

The new POST /organizations/orgId/external-users call enables organization administrators to add and remove admin users from a different organization. These admin users can then make API calls for your organization and add external integrations.

Fixes

E6 April 2022

Features

Additional parameter returned in virtual event call

The eventId parameter is now returned in the POST /devices/{imei}/virtual-event call. Use this parameter to:

• update the event severity
• add comments
• delete the event

More alarm actions

You can now change the status of an alarm from read to unread and closed to open in the POST /alarms/{alarmId}/actions.

Improved terminology

The terminology for the active status of a dashcam has been improved. Previously it was Activated, and is now Active.

Fixes

E5 March 2022

Features

Default webhook settings for an organization

A new POST /organizations/{orgId}/webhook-settings call assigns webhook destination URLs. This call sets the destination URL for the event and GPS webhooks for an entire organization.

For the event webhook, set the destination URL with webhookEventsAddress, and for the GPS webhook, with webhookGpsAddress.

You can assign up to three destination URLs for each type of webhook.

Additional filter and sort parameters when retrieving events

New optional query parameters have been added to the GET /devices/{imei}/events call. These parameters include:

• filtering by eventType - return specific event types
• filtering by speed - return events that occurred at or above a specific speed
• sorting by eventType - sort results by the event type
• sorting by fileType - sort results by the file type (video, snapshot, text)
• sorting by order - sort results from the most recent to least recent (descending) or least recent to most recent (ascending)

E4 March 2022

Features

Default event settings for an organization

A new POST /organizations/{orgId}/event-settings call enables you to configure the default event settings for an entire organization. The newly configured settings then apply to both new devices added to the organization, and to previously existing devices in the organization.

The following roles can make this call:

• partners
• sub-partners
• administrators
• supervisors

List groups to which users are associated

A new groups parameter is now returned in the GET /organizations/{orgId}/users call. This parameter lists any groups the user is part of, including the id and name of each one.

Increase in number of geofences

The number of geofences you can set with the PUT /devices/{imei}/geofences call is now 99. Previously, only 19 geofences could be set.

Fixes

E3 February 2022

Features

Default settings for an organization

The new PUT /organizations/orgId/defaultSettings call enables partners and organization admins to set default settings for an organization's devices. These settings apply to all current devices and any devices added to the organization in the future.

Unsubscribe from email notifications

Users can now unsubscribe from email notifications with the DELETE /{imei}/notification-recipients/{email} call. They can unsubscribe from all notifications, or only from those for a particular event.

E2 February 2022

Features

Organization profile - device settings

The new PUT /organizations/orgId/defaultSettings call enables partners and organization admins to set default settings for an organization's devices. These settings apply to all current devices and any devices added to the organization in the future.

Mixed fleets solution

The POST /organization call has a new parameter, exlusivePartnerOnly. When a partner enables fleet managers to add dashcams from other (multiple) partners to a new organization.

New Possible fatigue event

A new event, Possible fatigue, can now be set in the PUT /devices/{imei}/event-config and PUT /devices/event-config calls.

Possible fatigue events are triggered when a distracted driving event occurs and the driver has already been driving for more than the configured number of daily driving hours.

Users can configure the drivingDuration parameter to indicate the amount of driving time in one day before the first Possible fatigue event is triggered. By default, drivingDuration is set to eight hours. Valid values are between four and twenty hours.

New parameters for time and distance

The GET /me call now returns two additional parameters:

• measurement - the measurement units used in the Surfsight Portal. The units can be either US/imperial or metric.
• timeFormat - the time format used in the Surfsight Portal. The format can be either 24 hours or AM/PM.

E1 January 2022

Features

Webhooks improved delivery

If a webhook is not delivered due to your server being down, Surfsight now tries sending it again up to six times. The final attempt takes place about 24 hours after the original failed delivery.

E25 & E26 January 2022

Features

Updated retrieve snapshot call

Users can now make the GET /devices/{imei}/cameras/{cameraId}/snapshot call with a timestamp in the query string to retrieve a snapshot from an earlier time.

Additionally, metadata is now returned with the call. This metadata includes:

• timestamp
• latitude
• longitude
• speed

New call to retrieve events by organization

A new POST /organizations/{orgId}/events call enables partners to retrieve a list of events by organization. This expands the available search capability, which previously only allowed retrieving events by individual device.

New call to add recipients for email notifications in bulk

A new POST /devices/events/{eventType}/notification-recipients call enables admins and supervisors to add recipients for email notifications of an event in bulk.

Pagination

The GET devices/{imei}/events and GET /organizations/{orgId}/devices calls now have optional parameters to assist with pagination. Pagination helps to divide a large amount of data and present it in a more understandable manner. The parameters include:

• limit - the maximum number of results to retrieve
• offset - the number of results to omit

The pagination parameters are returned in the response as metadata. In addition to the limit and offset, the count (the total number of results) is returned as well.

New role parameter

There is now a role parameter returned in the GET /me call. The roles are:

• Administrator
• Supervisor
• User
• Restricted

For more information on the different roles, go here.

E24 December 2021

Features

New parameter to set recording retention time

The PATCH /organizations/{orgId} call now includes the deviceRetentionMinutes parameter. This parameter enables admins and supervisors to set and update the recording retention times for all the devices of an organization. The recording retention time is the amount of time that recordings are kept on the SD card.

Fixes

E23 November 2021

Features

New endpoint to retreive safety score

The new GET /devices/{IMEI}/score call enables users to receive the safety score of any device. The safety score calculates how many events have occurred in a certain time range while taking into account the total distance traveled during that time.

Speed data in virtual events

When creating a virtual event, the speed from the most recent GPS location is included. If there is no GPS data, the speed is shown as null.

Filter trips by minimum distance

Users can now set a minimum trip length parameter, minimumDistance, to filter their trips in the GET /devices/{imei}/trips call. Trips shorter than the value set in this parameter no longer appear in the list of trips retreived.

E22 November 2021

Features

New endpoint to delete groups

The new DELETE /organizations/{orgId}/groups call enables administrators and supervisors to delete groups by their groupID.

New endpoints to manage users

Three new API calls have been created to help manage users:

• The GET /organizationUsers/{organizationId} call enables administrators, supervisors, and users to retrieve a list of the users associated with a specific organization.
• The POST /userPermissions/{id}/{organizationId} call enables administrators to edit the role and group access permissions of a specific user.
• The DELETE /users/{id} call enables administrators to delete a specific user.

New endpoint to update regional settings of users

The new PUT /users/{userId}/update-settings call enables administrators and supervisors to update the regional settings of a user. These settings include the measurement units and time format the user views in the Surfsight Cloud.

New endpoint to update group names

The new PUT /organizations/{orgId}/groups call enables administrators and supervisors to update the names of groups associated with a specific organization.

New endpoint to retreive list of recipients of event notifications

The new GET /devices/{imei}/notification-recipients call enables administrators, supervisors, and users to retrieve a list of the email recipients for event notifications.

E21 October 2021

Features

New access to webhook API requests

Both partners and partner contacts can now perform webhook API requests.

New virtual event flow

There is a new flow for virtual events. When a virtual event is received, the timestamp for the requested files takes into account the new durationSeconds parameter.

Fixes

E20 October 2021

Features

New group parameter

When creating a user with the POST /organizations/{orgId}/users request, you can now specify which groups the user will have access to by using the optional groupIds parameter. If groups are not specified, the user will have access to all groups.

Fixes

E19 October 2021

Features

New endpoint to receive white label details

The new GET /white-label-information/{whiteLabelDomainAddress} request enables reseller partners to receive white label portal details. These details include:

• the images used in the portal
• the logo and favicon used in the portal
• the name and domain address of the portal
• the privacy policy and EULA of the portal
• the sender address for emails sent from the portal to users
• the color theme of the portal
• Latitide and longitude included in virtual event

When creating a virtual event, the latitude and longitude from the most recent GPS location are included. If there is no GPS data, the latitude and longitude are equal to -1.

C18 September 2021

Features

Alarms added to the device health endpoint

Device alarms are now returned in the GET /device-health call. This makes alarms more visible, enabling you to take action quicker.

Fixes

C17 August 2021

Features

Recording health update

When a device is removed from an organization, the Recording Health status of that device reverts to 'not tested'.

C16 August 2021

Fixes

C15 August 2021

Fixes

C14 July 2021

Features

New metadata endpoint

Reseller partners can now receive a device's metadata with the GET /devices/{imei} call. This enables reseller partners to view a device's details, such as the organization and group it belongs to and its IMEI number.

New operational statistics endpoint

Reseller partners can now receive the operational statistics of their devices and organizations with the GET /partners/operational-statistics call. This enables reseller partners to view statistics about their devices and organizations, such as the number of activated devices and the number of alarms associated with their organizations in the past few weeks or months.

Updated devices endpoint

The GET /organizations/{orgId}/devices call now returns the vehicle type in addition to its other parameters. The vehicle type affects the sensitivity at which events are triggered.

Updated organization endpoint

The name parameter in the PATCH /organizations/{orgId} call is no longer required. You can update other organization parameters without entering or updating the organization name.

Fixes

C13 June 2021

Features

New data usage endpoint

You can now receive the data usage of a device with the GET /devices/{imei}/data-usage request. The following is included in the response:

• mobileTx - The total data transmitted from the device, in bytes
• mobileRx - The total data received by the device, in bytes
• liveStreamingUsage - The amount of data used from live video streaming, in bytes
• eventsUsage - The amount of data used from uploading video events, in bytes
• liveStreamUsageMilli - The amount of time spent watching live video streaming, in milliseconds
• recordStreamUsageMilli - The amount of time spent watching recordings, in milliseconds
• recordStreamingUsage - The amount of data used from streaming recordings, in bytes
• recordingsUploadUsage - The amount of data used from uploading recordings, in bytes
• usageEventsTodayDay - The number of video events that have occurred today
• usageEventsTodayMonth - The number of video events that have occurred this month

New wake up endpoint

You can now wake up a device with the POST /devices/{imei}/wakeup request. Devices can only be woken up when in standby mode.

Fixes

C12 June 2021

Features

New snapshot endpoint

You can now receive a snapshot from a specific camera with the GET /devices/{imei}/cameras/{cameraId}/snapshot request.

New auxiliary camera endpoint

You can update an auxiliary camera name with the PATCH /devices/{imei}/cameras request.

Updated organization endpoint

When a reseller partner makes the GET /organizations/{orgId} request it now returns the organization's SSO secret in addition to its other parameters. If the organization does not yet have an SSO secret, one is created during the request.

C11 June 2021

Features

New GPS endpoint

The GET /devices/{imei}/gps call now returns the altitude in addition to other GPS parameters.

Fixes

Adding devices in bulk

Adding devices in bulk through the API has been fixed. Organization admins can now add devices in bulk through the API v1 and v2.