How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SigNoz logs API

The logs API from SigNoz — 2 operation(s) for logs.

SigNoz logs API is one of 29 APIs that SigNoz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Logs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, pricing, and a getting-started guide.

This API exposes 3 operations across 2 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{host}:{port}{base_path}.

3 operations 2 paths 52 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{host}:{port}
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

SigNoz logs API declares 2 security schemes for authenticating requests. An API key is passed in the header as SigNoz-Api-Key (api_key). It accepts HTTP bearer tokens (Tokenizer) (tokenizer).

  • api_key — API Keys
  • tokenizer — Tokens generated by the tokenizer

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

logs 3
POST
/api/v1/export_raw_data
Export raw data
HandleExportRawDataPOST 1 param body → 200400401403500
GET
/api/v1/logs/promote_paths
Promote and index paths
ListPromotedAndIndexedPaths → 200400401403500
POST
/api/v1/logs/promote_paths
Promote and index paths
HandlePromoteAndIndexPaths body → 201400401403500

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation (18 properties), Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation (18 properties), Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation (18 properties), Querybuildertypesv5QueryBuilderTraceOperator (16 properties). Each schema is shown below with its type and property counts.

TelemetrytypesFieldContext
string
PromotetypesWrappedIndex
object
3 properties
RenderErrorResponse
object
2 properties 2 required
Querybuildertypesv5OrderDirection
string
Querybuildertypesv5SecondaryAggregation
object
7 properties
Querybuildertypesv5Having
object
1 property
Querybuildertypesv5CompositeQuery
object
Composite query containing one or more query envelopes. Each query envelope specifies its type and corresponding spec.
1 property
MetrictypesComparisonSpaceAggregationParam
object
2 properties 2 required
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation
object
18 properties
Querybuildertypesv5Filter
object
1 property
Querybuildertypesv5FunctionName
string
Querybuildertypesv5MetricAggregation
object
6 properties
PromotetypesPromotePath
object
3 properties
Querybuildertypesv5QueryEnvelopeFormula
object
2 properties
Querybuildertypesv5LogAggregation
object
2 properties
ErrorsResponseerroradditional
object
1 property
Querybuildertypesv5ClickHouseQuery
object
4 properties
MetrictypesTimeAggregation
string
Querybuildertypesv5OrderBy
object
2 properties
Querybuildertypesv5QueryEnvelopePromQL
object
2 properties
Querybuildertypesv5TraceAggregation
object
2 properties
TelemetrytypesSource
string
Querybuildertypesv5GroupByKey
object
6 properties 1 required
TelemetrytypesSignal
string
MetrictypesSpaceAggregation
string
Querybuildertypesv5VariableItem
object
2 properties
Querybuildertypesv5Function
object
2 properties
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation
object
18 properties
Querybuildertypesv5QueryEnvelopeClickHouseSQL
object
2 properties
Querybuildertypesv5PromQuery
object
6 properties
Querybuildertypesv5RequestType
string
ErrorsJSON
object
4 properties 2 required
TelemetrytypesFieldDataType
string
Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation
object
18 properties
Querybuildertypesv5QueryBuilderTraceOperator
object
16 properties
Querybuildertypesv5Step
Step interval. Accepts a Go duration string (e.g., "60s", "1m", "1h") or a number representing seconds (e.g., 60).
Querybuildertypesv5ReduceTo
string
Querybuildertypesv5QueryBuilderFormula
object
8 properties
Querybuildertypesv5QueryEnvelope
object
2 properties
Querybuildertypesv5VariableType
string
Querybuildertypesv5QueryEnvelopeBuilderMetric
object
2 properties
Querybuildertypesv5QueryEnvelopeTraceOperator
object
2 properties
Querybuildertypesv5QueryEnvelopeBuilderTrace
object
2 properties
Querybuildertypesv5QueryType
string
Querybuildertypesv5FunctionArg
object
2 properties
Querybuildertypesv5OrderByKey
object
6 properties 1 required
Querybuildertypesv5LimitBy
object
2 properties
Querybuildertypesv5QueryRangeRequest
object
Request body for the v5 query range endpoint. Supports builder queries (traces, logs, metrics), formulas, joins, trace operators, PromQL, and ClickHouse SQL qu…
8 properties
MetrictypesTemporality
string
Querybuildertypesv5QueryEnvelopeBuilderLog
object
2 properties
TelemetrytypesTelemetryFieldKey
object
6 properties 1 required
Querybuildertypesv5FormatOptions
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-logs-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
SigNoz authdomains API
SigNoz authz API
SigNoz channels API
SigNoz cloudintegration API
SigNoz dashboard API
SigNoz downtimeschedules API
SigNoz features API
SigNoz fields API
SigNoz gateway API
SigNoz global API
SigNoz health API
Where this information came from

This is an independent, third-party profile of SigNoz logs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.