Merchant API: retrieve audit logs

About this article

This article explains how to use the GET /v2/auditlogs endpoint in the Merchant API to retrieve a paginated list of audit log entries for your ChannelEngine account, including what each request parameter and response field means.

Table of contents

About this article

Introduction

Overview

Requirements

Available API endpoints

Endpoint: retrieve audit logs

• Query parameters
• Response structure
• Envelope fields
• Audit log entry fields
• Pagination
• Example requests

Common issues

Next steps

Introduction

ChannelEngine's audit logs record changes made in your account (tenant) – who made it and when. This makes it straightforward to follow up with the right team member when you need to understand why an action was taken, and gives you a clear starting point for reviewing activity when something did not go as planned.

The GET /v2/auditlogs endpoint exposes this data via the Merchant API, so you can pull it into your own security monitoring tools, compliance reports, or data pipelines.

Overview

Refer to the flowchart below to visualize how audit log data flows between your system and ChannelEngine, whenever a user makes a change on ChannelEngine.

Requirements

Before making requests to this endpoint, confirm that you have the following in place:

• Access to the Audit Logs API – contact your integration coordinator, customer success manager, or ChannelEngine Support if you are unsure whether your account has access.
• A valid Merchant API key with sufficient permissions. Find or generate a key at Settings, Merchant API Keys.
• Your ChannelEngine tenant name – the subdomain of your account URL. If your platform URL is my-shop.channelengine.net, your tenant name is my-shop.

Available API endpoints

The audit log resource exposes a single endpoint for retrieving account activity.

• Retrieve audit logs: GET /v2/auditlogs
  Use this endpoint to retrieve a paginated list of audit log entries for your account. Filter by date range, entity type, action, or channel. Results are ordered newest first.

Endpoint: retrieve audit logs

Use this endpoint to retrieve all audit logs available for your tenant.

GET https://{your-tenant}.channelengine.net/api/v2/auditlogs 

Authenticate by passing your Merchant API key in the request header:

apikey: YOUR_API_KEY

Query parameters

All parameters are optional. When no filters are applied, the endpoint returns all audit log entries for your account, ordered newest first.

Response structure

A successful request returns a JSON object containing the matching audit log entries and metadata about the result set. E.g.:

{
  "Content": [
    {
      "ChannelId": null,
      "Type": "LISTING_FILTER",
      "Action": "UPDATE",
      "UserName": "Jane Smith",
      "UserEmail": "jane@example.com",
      "Date": "2026-07-01T12:18:40.730Z"
    }
  ],
  "Count": 1,
  "TotalCount": 1,
  "ItemsPerPage": 50,
  "StatusCode": 200,
  "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "LogId": "log-112233",
  "Success": true,
  "Message": null,
  "ExceptionType": null,
  "ValidationErrors": null
}

Envelope fields

Audit log entry fields (within Content)

Pagination

When a query returns more entries than fit on a single page, use the page parameter to step through the results.

1. Make your first request. Call the endpoint without a page parameter – it defaults to page 1. The response includes TotalCount and ItemsPerPage.
2. Calculate the number of pages. Divide TotalCount by ItemsPerPage and round up to get the total page count.
3. Retrieve the remaining pages. Repeat the request with page=2, page=3, and so on until all entries have been collected.

Example requests

Manual product changes in the last 7 days

GET /api/v2/auditlogs
  ?FromCreateDate=2026-06-24T00:00:00Z
  &ToCreateDate=2026-07-01T23:59:59Z
  &Types=PRODUCT

All deletions across your account

GET /api/v2/auditlogs
  ?Actions=DELETE
  &Actions=HARD_DELETE

Webhook changes for a specific channel

GET /api/v2/auditlogs
  ?Types=WEBHOOK
  &ChannelIds=12345

Retrieve the second page of results

GET /api/v2/auditlogs
  ?FromCreateDate=2026-01-01T00:00:00Z
  &page=2

Common issues

Next steps

• Set up a scheduled job to pull audit logs at regular intervals for compliance or security monitoring.
• Use the Types and Actions filters to scope your integration to only the events you require.
• Include RequestId and LogId from any response when contacting ChannelEngine Support about a specific API call.
• Check out the full Merchant API reference for other available endpoints.