Skip to main content
Skip to Content
DocsManagement APISystem 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

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]
  • sort in query - string
    The log key by which to sort results. If left blank, results will be reported in order of creation. This parameter is case-sensitive.

    Allowed: date_created | type

  • direction in query - string
    The direction in which to sort results. Defaults to ascending (asc). This parameter is case-sensitive.

    Allowed: asc | desc

example

Response

The request completed successfully.

Body

object | application/json
  • data
    array[object]

  • meta
    object

    BigCommerce meta payload for collection-type responses.

example

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?