Codestin Search App

This section is the quickest way to understand how data reaches Parseable and which HTTP endpoint fits your integration.

Most teams do not need every route listed here. In practice, you usually start with one ingestion path, send data into a dataset, and then use the query and dataset APIs only when you need direct control from your own tooling.

Getting Started

Before you begin, make sure you have:

A running instance of Parseable
The base URL of your Parseable server
Required authentication credentials (if authentication is enabled)

Most integrations fall into one of these paths:

Use /api/v1/ingest when your application already has JSON events and you want to route them with headers.
Use /v1/logs, /v1/traces, or /v1/metrics when your collector or SDK is already sending native OTLP data.
Use /v1/prometheus/write when Prometheus or another compatible system is forwarding metrics through Remote Write.
Use /api/v1/query and /api/v1/logstream/{stream_name} when you need SQL queries or direct dataset management from your own code.

If you are deciding where to start, the simplest rule is this:

JSON events from an app or script: /api/v1/ingest
OpenTelemetry logs: /v1/logs
OpenTelemetry traces: /v1/traces
OpenTelemetry metrics: /v1/metrics
Prometheus Remote Write metrics: /v1/prometheus/write

Ingestion APIs

Ingest JSON events with headers

Send JSON events and route them with the X-P-Stream header.

Ingest OTLP logs

Send OpenTelemetry logs to Parseable using the native /v1/logs endpoint.

Ingest OTLP traces

Send OpenTelemetry traces to Parseable using the native /v1/traces endpoint.

Ingest OTLP metrics

Send OpenTelemetry metrics to Parseable using the native /v1/metrics endpoint.

Prometheus Remote Write

Send snappy-compressed Prometheus Remote Write payloads to /v1/prometheus/write.

Query and Dataset APIs

Query a dataset with SQL

Run SQL queries across datasets. The dataset is selected inside the FROM clause.

Send JSON events to a dataset

Send JSON events directly to an existing dataset by path.

Create a dataset

Create a dataset before writing events directly to /api/v1/logstream/{stream_name}.

Delete a dataset

Delete a dataset and its associated data.

Authentication

These endpoints require authentication. This reference uses API keys so new integrations can start with the recommended machine-to-machine flow.

X-API-Key: <api-key>

You can find the setup flow in the API Keys guide.

For ingestion endpoints, the other header to pay attention to is usually X-P-Stream. That header tells Parseable which dataset should receive the payload. OTLP routes also use X-P-Log-Source to identify whether the payload is logs, traces, or metrics.

Need Help?

If you have any questions or run into issues, please refer to our GitHub repository or join our community.

API Reference