From 47be040ecfd8c7196501d384d080aa42c13f54c4 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 5 Sep 2024 21:07:29 +0300 Subject: [PATCH 1/3] Issue-170 --- docs/store-operations/settings/logs.mdx | 95 ------------------------- 1 file changed, 95 deletions(-) diff --git a/docs/store-operations/settings/logs.mdx b/docs/store-operations/settings/logs.mdx index b2ffdc7f4..80c37be44 100644 --- a/docs/store-operations/settings/logs.mdx +++ b/docs/store-operations/settings/logs.mdx @@ -65,101 +65,6 @@ Accept: application/json } } ``` - - - - -### Filter by date created - -Filter logs by using the `date_created` value in the query parameter. The date created must be in [Unix Timestamp](https://www.unixtimestamp.com/) format. - -The following example retrieves entries by the date created: - - - -```http filename="Example request: Filter by date created" showLineNumbers copy -GET https://api.bigcommerce.com/stores/{{STORE_HASH}}/v3/store/systemlogs?date_created:min=1657688400&date_created:max=1658379600 -X-Auth-Token: {{ACCESS_TOKEN}} -Content-Type: application/json -Accept: application/json -``` - - - - -```json filename="Example response: Filter by date created" showLineNumbers copy -{ - "data": [ - { - "id": 63, - "type": "payment", - "module": "Test Payment Gateway", - "severity": "success", - "summary": "Test payment for order #121 processed successfully", - "message": "", - "date_created": "2023-01-05T22:31:54+00:00" - }, - { - "id": 64, - "type": "notification", - "module": "Email Message", - "severity": "success", - "summary": "Notification sent successfully", - "message": "Sent email notification to:
jane.doe@example.com", - "date_created": "2023-01-05T22:31:54+00:00" - }, - { - "id": 65, - "type": "notification", - "module": "Optimized Checkout", - "severity": "success", - "summary": "Order has been successfully finalized via Optimized checkout.", - "message": "Order has been successfully finalized via Optimized checkout.", - "date_created": "2023-01-05T22:31:54+00:00" - }, - { - "id": 66, - "type": "payment", - "module": "Test Payment Gateway", - "severity": "success", - "summary": "Test payment for order #122 processed successfully", - "message": "", - "date_created": "2023-01-05T22:46:15+00:00" - }, - { - "id": 68, - "type": "notification", - "module": "Optimized Checkout", - "severity": "success", - "summary": "Order has been successfully finalized via Optimized checkout.", - "message": "Order has been successfully finalized via Optimized checkout.", - "date_created": "2023-01-05T22:46:16+00:00" - }, - { - "id": 71, - "type": "shipping", - "module": "Home Delivery (flatrate)", - "severity": "success", - "summary": "Successfully retrieved shipping quote", - "message": "{\"quoteId\":\"\",\"timestamp\":\"1673022877\",\"cacheInfo\":\"cached for 3600s\",\"customerGroup\":{\"id\":2,\"name\":\"Retail\"},\"customerEmail\":\"\",\"customerId\":0,\"destination\":{\"streetAddress1\":\"123 Test Lane\",\"streetAddress2\":\"\",\"city\":\"Test\",\"postcode\":\"78040\",\"stateName\":\"Texas\",\"stateIso2\":\"TX\",\"countryIso2\":\"US\",\"addressType\":\"residential\",\"customAddressFields\":[]},\"items\":[{\"name\":\"Test Product (Test-001)\",\"id\":\"127\",\"quantity\":1,\"price\":15,\"discounted_price\":15,\"shipping_price\":0,\"weight\":0.5,\"width\":0,\"height\":0,\"length\":0,\"attributes\":[],\"omittedReason\":\"\"}],\"groupedResults\":{\"flatrate\":{\"rates\":[{\"handling\":0,\"price\":10,\"description\":\"Home Delivery\",\"additionalDescription\":\"\"}],\"carrierType\":\"flatrate\"}},\"settings\":[]}", - "date_created": "2023-01-06T16:34:37+00:00" - }, - ], - "meta": { - "pagination": { - "total": 6, - "count": 6, - "per_page": 50, - "current_page": 1, - "total_pages": 1, - "links": { - "current": "?date_created%3Amin=1671244778&date_created%3Amax=1684287578&page=1&limit=50" - } - } - } -} -``` - From 22b431c85eefdcf0b4783eedf68da9c4cdfc4b22 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 5 Sep 2024 21:20:50 +0300 Subject: [PATCH 2/3] removed duplicate resource links --- docs/store-operations/settings/logs.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/store-operations/settings/logs.mdx b/docs/store-operations/settings/logs.mdx index 80c37be44..38c0ddad7 100644 --- a/docs/store-operations/settings/logs.mdx +++ b/docs/store-operations/settings/logs.mdx @@ -298,8 +298,7 @@ Accept: application/json ## Resources -- [Store Logs API Reference](/docs/rest-management/store-logs#get-system-logs) - [Store Logs Support Article](https://support.bigcommerce.com/s/article/Using-Store-Logs) ### Endpoint reference -- [Get system logs](/docs/rest-management/store-logs#get-system-logs) +- [Store Logs API Reference](/docs/rest-management/store-logs#get-system-logs) From 367fad8dbc582dae5128ac3abde756f960ac4549 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 5 Sep 2024 21:23:08 +0300 Subject: [PATCH 3/3] removed date_created query parameters --- reference/store_logs.v3.yml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/reference/store_logs.v3.yml b/reference/store_logs.v3.yml index 5d5483808..739c0048f 100644 --- a/reference/store_logs.v3.yml +++ b/reference/store_logs.v3.yml @@ -114,16 +114,6 @@ paths: in: query name: 'id:in' description: 'A comma-separated list of log IDs by which to filter. For example, `?id:in=3,4,6`.' - - schema: - type: string - in: query - name: 'date_created:min' - description: 'Query parameter that lets you filter by the minimum date created in [Unix time](https://www.unixtimestamp.com/), for example, `?date_created:min=1657688400`. Returns logs created after this date.' - - schema: - type: string - in: query - name: 'date_created:max' - description: 'Query parameter that lets you filter by the maximum date created in [Unix time](https://www.unixtimestamp.com/), for example, `?date_created:min=1658379600`. Returns logs created before this date.' parameters: [] components: schemas: