Trace API

Overview

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

• Searching Traces: Allows users to search for traces based on specific filters. For example, searching for traces based on the error code.

• Aggregating Traces: Allows users to aggregate traces based on specific filters. For example, aggregating traces based on the error code.

API Endpoint

Endpoint for Trace API:

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

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

Prerequisites

API Keys: 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}