Sign Customiser

Navigation

Dark mode

Integrations

list_activity_logs

read

List activity logs

Copy page

Find failed requests across the Store, for example why orders or products stopped reaching a selling platform, before reading one integration with list_integration_activity_logs.

Overview

Lists the requests Sign Customiser sent and received for the connected Store, newest first, as the merchant admin Activity page shows them: each request direction, the line the admin shows, its HTTP status and duration, what caused it (an integration, a webhook or an API key, named by kind, name and the last four characters of a key) and the storefront page the shopper was on. Filters narrow it by customiser, by status (failed or success) and by causer kind. No credential, request body or header is returned. It requires the integrations:read scope and has no side effects.

Permission

Requires theintegrations:readpermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A merchant has connected this store and approved the integrations:read scope.

Arguments

limitinteger

How many requests to return per page, between 1 and 100. Defaults to 20.

cursorstring

The opaque next_cursor value from the previous page, sent back with identical filters.

filterobject

Optional filters. An unknown filter is rejected, never ignored.

filter.customiser_idinteger

Only requests of this customiser.

filter.statusstring

failed for requests that failed, success for the rest (closed).

One of: failed, success

filter.causerstring

Only requests caused by this kind of causer (expected to grow).

One of: api_key, integration, webhook

Result

Up to `limit` logged requests, newest first, plus the cursor for the next page.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
activity_logsarray of objectalways present

The page of logged requests, newest first.

activity_logs[].idintegeralways present
activity_logs[].eventstring or null

The request direction: request:outgoing or request:incoming, or the older outgoing-request and incoming-request names on old rows. Expected to grow.

activity_logs[].descriptionstringalways present

The line the merchant admin shows for the request.

activity_logs[].status_codeinteger or null

The HTTP status of the request, or null.

activity_logs[].duration_msinteger or null

How long the request took, or null.

activity_logs[].causerobject or null

What sent or caused the request, or null.

activity_logs[].causer.kindstringalways present

One of: api_key, integration, webhook

activity_logs[].causer.namestring or null
activity_logs[].causer.last_fourstring or null

The last four characters of an API key; null for every other kind.

activity_logs[].storefront_pageobject or null

The storefront page the shopper was on when the request started, or null.

activity_logs[].storefront_page.urlstring or null
activity_logs[].storefront_page.originstring or null
activity_logs[].storefront_page.sourcestringalways present

One of: window, parent, referrer, unavailable

activity_logs[].storefront_page.availabilitystringalways present

One of: available, unavailable

activity_logs[].storefront_page.captured_atstring or null
activity_logs[].created_atstringalways present
paginationobjectalways present
pagination.has_morebooleanalways present
pagination.next_cursorstring or null

Error cases

insufficient_scope

The connection was approved without integrations:read.

invalid_cursor

The cursor was altered or reused for a different collection, Store or filters; restart with no cursor.

invalid_parameter

A filter value is not allowed: customiser_id is not an integer from 1 to 2147483647, status is not failed or success, or causer is not api_key, integration or webhook. limit is not an integer from 1 to 100.

unknown_filter

Remove the filter named in parameter. This tool forwards unknown filter names so the API can refuse them explicitly.

Failed requests of one customiser

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_activity_logs",
    "arguments": {
      "limit": 1,
      "filter": {
        "customiser_id": 42,
        "status": "failed"
      }
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "activity_logs": [
        {
          "id": 88123,
          "event": "request:outgoing",
          "description": "Create product on Shopify",
          "status_code": 502,
          "duration_ms": 1840,
          "causer": {
            "kind": "integration",
            "name": "Main store",
            "last_four": null
          },
          "storefront_page": null,
          "created_at": "2026-11-14T09:30:00Z"
        }
      ],
      "pagination": {
        "has_more": true,
        "next_cursor": "eyJ2IjoxfQ"
      }
    }
  }
}

A filter the Store-wide list does not take (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_activity_logs",
    "arguments": {
      "filter": {
        "integration_id": 31
      }
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "unknown_filter",
        "title": "Unknown filter",
        "detail": "The request includes filters this endpoint does not support: integration_id. Supported filters: customiser_id, status, causer.",
        "parameter": "filter[integration_id]",
        "recovery": "Remove the filter named in parameter. The list tool description names the filters the operation accepts."
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.