Store Logs V3 API
This API can be used to retrieve and filter for specific store logs.
Get System Logs
GET /stores/{store_hash}/v3/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 values: 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 values: 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 values: 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 - string
Query parameter that lets you filter by a list of log IDs, as a CSV. For example ?id:in=3,4,6
- 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
dataarray[object]
metaobject
BigCommerce meta payload for collection-type responses.