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]

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/store/systemlogs' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

The request completed successfully.

Body

object | application/json
  • data
    array[object]

  • meta
    object

    BigCommerce meta payload for collection-type responses.

example

{
"data": [
{
"id": 0,
"type": "string",
"module": "string",
"severity": "string",
"summary": "string",
"message": "string",
"date_created": "2019-08-24T14:15:22Z"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {
"previous": "?page=1&limit=50",
"current": "?page=1&limit=50",
"next": "?page=1&limit=50"
}
}
}
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?