BigCommerce Docs

curl -G https://api.bigcommerce.com/stores/store_hash/v3/infrastructure/logs/project_uuid \
     -H "X-Auth-Token: <apiKey>" \
     --data-urlencode end=2024-06-15T11:00:00Z \
     --data-urlencode start=2024-06-15T10:00:00Z

{
  "data": [
    {
      "id": "log-1",
      "timestamp": "2024-06-15T10:30:00Z",
      "level": "info",
      "messages": [
        "Request processed successfully"
      ],
      "is_exception": false,
      "exception_name": "",
      "request": {
        "method": "GET",
        "url": "/products",
        "status_code": 200
      }
    }
  ],
  "meta": {
    "cursor_pagination": {
      "count": 1,
      "per_page": 50,
      "start_cursor": "abc123",
      "end_cursor": "def456",
      "links": {}
    }
  }
}

Returns historical worker logs for a project within a time window. Supports filtering by HTTP method, status code, URL, and minimum severity level, plus cursor-based pagination.

The start and end query parameters are both required, and the window between them cannot exceed 7 days.

Note: To stream logs in real time instead, use the Tail Worker Logs endpoint.

Returns historical worker logs for a project within a time window. Supports filtering by HTTP method, status code, URL, and minimum severity level, plus cursor-based pagination. The `start` and `end` query parameters are both required, and the window between them cannot exceed 7 days. > **Note**: To stream logs in real time instead, use the [Tail Worker Logs](#tail-worker-logs) endpoint.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Infrastructure Deployments	read-only	`store_infrastructure_deployments_read_only`
Infrastructure Deployments	create preview	`store_infrastructure_deployments_create_preview`
Infrastructure Deployments	manage	`store_infrastructure_deployments_manage`
Infrastructure Projects	read-only	`store_infrastructure_projects_read_only`
Infrastructure Projects	manage	`store_infrastructure_projects_manage`
Infrastructure Logs	read-only	`store_infrastructure_logs_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Infrastructure Deployments | read-only | `store_infrastructure_deployments_read_only` | | Infrastructure Deployments | create preview | `store_infrastructure_deployments_create_preview` | | Infrastructure Deployments | manage | `store_infrastructure_deployments_manage` | | Infrastructure Projects | read-only | `store_infrastructure_projects_read_only` | | Infrastructure Projects | manage | `store_infrastructure_projects_manage` | | Infrastructure Logs | read-only | `store_infrastructure_logs_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `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). | ### Further reading For 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). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

project_uuidstringRequiredformat: "uuid"

The UUID of the project to query logs for.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

startstringRequired

The start of the time window to query. Accepts an RFC 3339 timestamp or a Unix epoch in seconds. Must be before end.

endstringRequired

The end of the time window to query. Accepts an RFC 3339 timestamp or a Unix epoch in seconds. The window between start and end cannot exceed 7 days.

methodstringOptional

Filter logs by HTTP method, for example GET.

status_codeintegerOptional

Filter logs by HTTP response status code. Must be between 100 and 599.

url:likestringOptional

Filter logs by a partial match on the request URL.

level:minenumOptional

Filter logs to only those at or above the given severity level.

Allowed values:

limitintegerOptionalDefaults to 50

The number of results to return per page. Defaults to 50.

afterstringOptional

Cursor for forward pagination. Returns results after this cursor.

beforestringOptional

Cursor for backward pagination. Returns results before this cursor.

Response

The request completed successfully.

datalist of objects

metaobject

Meta information including cursor-based pagination.

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

OAuth scopes

UI Name	Permission	Parameter
Infrastructure Deployments	read-only	`store_infrastructure_deployments_read_only`
Infrastructure Deployments	create preview	`store_infrastructure_deployments_create_preview`
Infrastructure Deployments	manage	`store_infrastructure_deployments_manage`
Infrastructure Projects	read-only	`store_infrastructure_projects_read_only`
Infrastructure Projects	manage	`store_infrastructure_projects_manage`
Infrastructure Logs	read-only	`store_infrastructure_logs_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.