{"openapi":"3.1.0","info":{"title":"Admin Management: System Logs","version":"1.0.0"},"paths":{"/stores/{store_hash}/v3/store/systemlogs":{"get":{"operationId":"getStoreSystemLogs","summary":"List System Logs","description":"Get system logs ","tags":["systemLogs"],"parameters":[{"name":"store_hash","in":"path","description":"Permanent ID of the BigCommerce store.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Query parameter that lets you return the number of results displayed per page.","required":false,"schema":{"type":"integer","default":50}},{"name":"page","in":"query","description":"Query parameter that lets you specify the starting page in which results are returned.","required":false,"schema":{"type":"integer","default":1}},{"name":"type","in":"query","description":"Query parameter that lets you filter the results by log type.","required":false,"schema":{"$ref":"#/components/schemas/StoreSystemlogsGetParametersType"}},{"name":"type:not","in":"query","description":"Query parameter that lets you exclude a log type from the results.","required":false,"schema":{"type":"string"}},{"name":"module","in":"query","description":"Query parameter that lets you filter the results by module.","required":false,"schema":{"$ref":"#/components/schemas/StoreSystemlogsGetParametersModule"}},{"name":"module:not","in":"query","description":"Query parameter that lets you exclude a log module from the results.","required":false,"schema":{"type":"string"}},{"name":"severity","in":"query","description":"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","required":false,"schema":{"$ref":"#/components/schemas/StoreSystemlogsGetParametersSeverity"}},{"name":"severity:min","in":"query","description":"Query parameter that lets you filter by minimum severity, as an integer.","required":false,"schema":{"type":"integer"}},{"name":"severity:max","in":"query","description":"Query parameter that lets you filter by maximum severity, as an integer.","required":false,"schema":{"type":"integer"}},{"name":"id:in","in":"query","description":"A comma-separated list of log IDs by which to filter. For example, `?id:in=3,4,6`.","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"sort","in":"query","description":"The log key by which to sort results. If left blank, results will be reported in order of creation. This parameter is case-sensitive.","required":false,"schema":{"$ref":"#/components/schemas/StoreSystemlogsGetParametersSort"}},{"name":"direction","in":"query","description":"The direction in which to sort results. Defaults to ascending (`asc`). This parameter is case-sensitive.","required":false,"schema":{"$ref":"#/components/schemas/StoreSystemlogsGetParametersDirection"}},{"name":"X-Auth-Token","in":"header","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Store logs | read-only | store_logs_read_only |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/System Logs_getStoreSystemLogs_Response_200"}}}}}}}},"servers":[{"url":"https://api.bigcommerce.com","description":"https://api.bigcommerce.com"}],"components":{"schemas":{"StoreSystemlogsGetParametersType":{"type":"string","enum":["general","payment","shipping","tax","notification","emailintegration","ordersettings","design"],"title":"StoreSystemlogsGetParametersType"},"StoreSystemlogsGetParametersModule":{"type":"string","enum":["export+only","email+message","theme+download","order+status","optimized+checkout"],"title":"StoreSystemlogsGetParametersModule"},"StoreSystemlogsGetParametersSeverity":{"type":"string","enum":["1","2","3","4"],"title":"StoreSystemlogsGetParametersSeverity"},"StoreSystemlogsGetParametersSort":{"type":"string","enum":["date_created","type"],"title":"StoreSystemlogsGetParametersSort"},"StoreSystemlogsGetParametersDirection":{"type":"string","enum":["asc","desc"],"title":"StoreSystemlogsGetParametersDirection"},"SystemLog":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string"},"module":{"type":"string"},"severity":{"type":"string"},"summary":{"type":"string"},"message":{"type":"string"},"date_created":{"type":"string","format":"date-time"}},"title":"SystemLog"},"IndexMetaPaginationLinks":{"type":"object","properties":{"previous":{"type":"string"},"current":{"type":"string"},"next":{"type":"string"}},"title":"IndexMetaPaginationLinks"},"IndexMetaPagination":{"type":"object","properties":{"total":{"type":"integer"},"count":{"type":"integer"},"per_page":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer"},"links":{"$ref":"#/components/schemas/IndexMetaPaginationLinks"}},"title":"IndexMetaPagination"},"IndexMeta":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/IndexMetaPagination"}},"description":"BigCommerce meta payload for collection-type responses.","title":"IndexMeta"},"System Logs_getStoreSystemLogs_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SystemLog"}},"meta":{"$ref":"#/components/schemas/IndexMeta"}},"title":"System Logs_getStoreSystemLogs_Response_200"}},"securitySchemes":{"X-Auth-Token":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"### OAuth scopes\n\n| UI Name | Permission | Parameter |\n|:--------|:-----------|:----------|\n|  Store logs | read-only | store_logs_read_only |\n\n### Authentication header\n\n| Header | Argument | Description |\n|:-------|:---------|:------------|\n| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). |\n\n### Further reading\n\nFor example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests).\n\nFor more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).\n\nFor a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes)."}}}}