Download web events as a file

post

https://api.eu-west-1.aws.dash0.com/api/web-events/download

Returns the web events matching the given query as a downloadable file in the
requested format (txt, ndjson, yaml or csv).

A single export is capped at 5000 web events. A limit above that cap is rejected
rather than silently clamped: the response is a client error naming the cap. When the
query matches more than 5000 events, the export carries the first 5000 in result-set
order; there is no CLI equivalent for web events, so a larger export has to be taken
as several narrower queries.

The events are the same ones POST /api/web-events returns for the same query.
Web-event retrieval does not sample, so no sampling has to be disabled for the file to
be the query's whole result set.

The response is streamed as pages are retrieved and therefore carries no
Content-Length. Because the response headers are committed before the first event
is written, a failure partway through cannot be reported as a status code — it
terminates the transfer instead. Clients MUST confirm the body was received completely
before treating the download as a successful export.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request for the WebEventsDownload API. Accepts the same query as GetWebEvents
(serviceName, eventNames, filter, timeRange, dataset, ordering) and
returns the matching web events serialized as a downloadable file rather than as a
JSON page.

The response is streamed, so the export is not paginated: a single request returns up
to limit events, capped at 5000. Unlike the log and span exports there is no
adaptive sampling to disable — web-event retrieval does not sample — so an exported
file is the query's whole result set up to the cap.

There is no Dash0 CLI command for web events, so the cap is the only limit; a query
matching more than 5000 events has to be narrowed to be exported in full.

serviceName

string

eventNames

array of strings

eventNames

filter

array of objects

filter

timeRange

object

required

A range of time between two time references.

dataset

string

^[a-zA-Z0-9_-]{3,26}$

Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

ordering

array of objects

The ordering criteria for the exported web events. Events are written to the file
in this order.
Supported ordering key: otel.log.time (event timestamp, defaults to descending),
optionally followed by dash0.web.event.id ascending, which is the tiebreak
web-event retrieval appends to keep its cursor stable.

ordering

format

string

enum

required

The serialization format of the exported file.

txt: One rendered line per web event, carrying a fixed field set of timestamp,
service, event name, title, duration and trace ID. Ignores columns.
ndjson: One OTLP JSON payload per line, each carrying a single web event inside
the same resourceLogs envelope GetWebEvents returns — web events are stored as
OTLP log records — so each line is independently parseable by any OTLP JSON
consumer.
yaml: The same per-event OTLP payloads as ndjson, as a multi-document YAML
stream with documents separated by ---.
csv: A header row plus one row per web event, flattened to the requested columns.

Allowed:

limit

int64

1 to 5000

Defaults to 5000

The maximum number of web events to export. Defaults to, and is capped at, 5000.
A larger value is rejected rather than silently clamped.

columns

array of strings

Attribute keys to emit as columns, in order, for the csv format — resource,
scope, or event attributes (e.g. service.name, event.name,
dash0.web.event.duration). Ignored by the other formats, which have a fixed
field set.

columns

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/octet-stream

application/json

200The exported web events. The body's actual content type matches the requested format (text/plain for txt, application/x-ndjson for ndjson, application/yaml for yaml, text/csv for csv).

400The request is invalid, for example a limit above the 5000-record cap, an unsupported ordering, or a time range exceeding the maximum permitted query range. No partial file is produced.

403Forbidden - the requested dataset is not accessible

defaultIn case any error happens.