Retrieve organization audit logs

Retrieve the audit logs of an organization.

Request
Security:
query Parameters
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

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

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

Example: offset=1
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
userId
string (User ID as string)

Filter by the ID of the user.

Example: userId=32
partnerId
string

Filter by the ID of the partner. Obtain this from GET /partner-contact.

Example: partnerId=62
orgId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the organization. Obtain this from GET /organizations.

Example: orgId=17
imei
string

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

Example: imei=12345678
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/audit-logs
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/audit-logs?limit=1&offset=1&start=2020-01-01T14%3A48%3A00.000Z&end=2020-01-01T14%3A48%3A00.000Z&userId=32&partnerId=62&orgId=17&imei=12345678' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}