Download web events as a file

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.

post/api/web-events/download

Request

Base URL: https://api.eu-west-1.aws.dash0.com
URL: https://api.eu-west-1.aws.dash0.com/api/web-events/download
Auth: none declared

Request body

serviceNamestring

eventNamesstring[]

datasetstring

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

format'txt' | 'ndjson' | 'yaml' | 'csv' 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.

limitinteger

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

columnsstring[]

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.

Example request

{
  "filter": [
    {
      "key": "service.name",
      "operator": "is",
      "value": "foo"
    }
  ],
  "timeRange": {
    "from": "now-30m",
    "to": "now"
  }
}

Response

The 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).

Changes

No recorded changes to this operation across all 1 revision of this API.