Logs API

Overview

The SigNoz Logs API is a robust interface which enables developers to manage and analyze log data efficiently. This API facilitates various operations:

• Searching Logs: Allows users to search through log data based on specific criteria. For example, finding all logs where the error code is 500.

• Paginating Logs: Helps in navigating through large sets of log data in a manageable way. For instance, retrieving logs in batches of 100 for easy viewing.

• Aggregating Logs: Enables summarizing log data to extract meaningful insights, such as aggregating logs to count the number of errors per day.

API Endpoint

Endpoint for Logs API:

POST https://{URL}/api/v5/query_range

Replace {URL} with your instance URL, e.g., example.signoz.io.

Prerequisites

API key: To access this API, you need an API key. Go to Settings → Service Accounts in SigNoz, create a service account, and generate an API key from its Keys tab. See Service Accounts for step-by-step instructions.

API keys can only be created/managed by users with the Admin role. If you don't have the Admin role, contact your organization's admin to create an API key for you.

Authentication

Using the API key: Add the API key to your request header as follows:

SIGNOZ-API-KEY:{YOUR_API_KEY}

Operations

• Search Logs — filter logs by attributes, body content, severity, or trace ID with pagination support.
• Aggregate Logs — compute counts, averages, and group-by operations over filtered log data.
• Logs URL for Explorer — generate a direct URL to the Logs Explorer with predefined filters and time range.
• Payload Model — request and response schema reference.