Docs
Management API
System logs

Store Logs V3 API

This API can be used to retrieve and filter for specific store logs.

Get System Logs

GET /store/systemlogs

Request

Get system logs

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • limit in query with default of 50 - integer

    Query parameter that lets you return the number of results displayed per page.

  • page in query with default of 1 - integer

    Query parameter that lets you specify the starting page in which results are returned.

  • type in query - string

    Query parameter that lets you filter the results by log type.

    Allowed: general | payment | shipping | tax | notification | emailintegration | ordersettings | design

  • type:not in query - string

    Query parameter that lets you exclude a log type from the results.

  • module in query - string

    Query parameter that lets you filter the results by module.

    Allowed: export+only | email+message | theme+download | order+status | optimized+checkout

  • module:not in query - string

    Query parameter that lets you exclude a log module from the results.

  • severity in query - integer

    Query parameter that lets you filter results by severity level, as an integer. The following values are possible: Success = 1, Notice = 2, Warning = 3, Error = 4

    Allowed: 1 | 2 | 3 | 4

  • severity:min in query - integer

    Query parameter that lets you filter by minimum severity, as an integer.

  • severity:max in query - integer

    Query parameter that lets you filter by maximum severity, as an integer.

  • id:in in query - array

    A comma-separated list of log IDs by which to filter. For example, ?id:in=3,4,6.

    Type: array[integer]

  • date_created:min in query - string

    Query parameter that lets you filter by the minimum date created in Unix time, for example, ?date_created:min=1657688400. Returns logs created after this date.

  • date_created:max in query - string

    Query parameter that lets you filter by the maximum date created in Unix time, for example, ?date_created:min=1658379600. Returns logs created before this date.

example

Response

The request completed successfully.

Body

object | application/json
  • data
    array[object]

  • meta
    object

    BigCommerce meta payload for collection-type responses.

example

Did you find what you were looking for?