Audit Log

WIP: A summary needs to be written for Audit Log

POST/v3/audit_log/search

Search entities

Search for Entries

Body parameters

Consumes

The following content type is required: application/json

  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderBy
    Type
    one of: any, any
    Description
    the order instructions for the result
  • Name
    params
    Type
    object
    Description
    additonal request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    one of: any, any
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    array Required
    Description
    an array of items
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request
application/json

POST
/v3/audit_log/search
curl https://api.shopmonkey.cloud/v3/audit_log/search \
  -H "Authorization: Bearer ${SM_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data '{}'

Example Response
application/json

{
  "data": [
    {
      "__deleted": 1,
      "__lastRefreshedAt": "__lastRefreshedAt",
      "__timestamp": "__timestamp",
      "action": null,
      "associatedEntityId": null,
      "associatedEntityType": null,
      "audience": null,
      "companyId": "companyId",
      "createdDate": "createdDate",
      "customerFirstName": null,
      "customerId": null,
      "customerLastName": null,
      "entityId": null,
      "entityMeta": null,
      "entityType": null,
      "geoAddress": null,
      "id": null,
      "inspectionName": null,
      "ipAddress": null,
      "laborName": null,
      "latitude": null,
      "locationId": null,
      "locationName": null,
      "longitude": null,
      "newValue": null,
      "orderCoalescedName": null,
      "orderName": null,
      "orderNumber": null,
      "partName": null,
      "platform": null,
      "previousValue": null,
      "purchaseOrderNumber": null,
      "serviceName": null,
      "tireName": null,
      "userFirstName": null,
      "userId": null,
      "userLastName": null,
      "vehicleColor": null,
      "vehicleId": null,
      "vehicleMake": null,
      "vehicleModel": null,
      "vehicleType": null,
      "vehicleVin": null,
      "vehicleYear": null
    }
  ],
  "success": true
}
GET/v3/audit_log/filter

Audit Log Filter Lists

Get list of available filters for audit logs

Produces

The response content type: application/json

200 Response

  • Name
    data
    Type
    object Required
    Description
  • Name
    success
    Type
    boolean Required
    Description

Properties for data object

  • Name
    actions
    Type
    array Required
    Description
  • Name
    entityTypes
    Type
    array Required
    Description

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/audit_log/filter
curl https://api.shopmonkey.cloud/v3/audit_log/filter \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "data": {
    "actions": [
      "actions"
    ],
    "entityTypes": [
      "entityTypes"
    ]
  },
  "success": true
}