API Overviews

Search API

Our full-text search API is based on Apache Lucene and provides advanced search facilities. If you’re getting up and running with Datastreamer for the first time you probably want to be using our Search API. This API allows you to search for arbitrary text strings, search with complex boolean logic, use filters, and other advanced features. The results are then returned as ordinary JSON documents.

Aggregation APIs

Using Aggregations, you can power dashboards, run high-level analysis, and view significant patterns in your searches. There are two Aggregation APIs.

Term Aggregation

Term Aggregate endpoint enables the user to query for aggregation of your results, based on the provided parameters. This retrieves the significant counts for the desired field of the results against the query. Mostly used to generate dashboards, reports, and graphs.

Date Histogram Aggregation

Date Histogram Aggregate endpoint enables user to query the aggregated result based on a timeframe. Mostly used to generate dashboards, reports, and graphs.

Monitored Search API

Monitored Search is perfect for creating monitoring features and products. This API allows you to set searches for arbitrary text strings, search with complex boolean logic, use filters, and other advanced features. Results, as they appear, are then returned as ordinary JSON documents to your specified endpoint.

Count API

Count API allows you to see the total count of the results matching any Search API request.

Extraction API

Extraction API allows you to perform extractions of large amounts of data into temporary storage. Perfect for large-scale ingestion.

Operations API

The Operations API allows you to enrich any documents with Operations available under "Integrated Operations".

Document, Schema, and Contracts APIs

Used in the connection of your own sources into the Datastreamer platform. You can specify your incoming documents (document), how you want them handled (contract), and the format for the documents to take (schema).